tangra logo
   
[ class tree: tangra_lib ] [ index: tangra_lib ] [ all elements ]
 

Class: Redirect_Composer

Source Location: /web_site/redirect_composer.class.php

Class Redirect_Composer

Class Overview
Class Overview | Descendants | Inherited Properties, Constants, and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail

Redirect_Composer's purpose is to compose address for redirection

Located in /web_site/redirect_composer.class.php [line 28] 

Tangra_Class
   |
   --Redirect_Composer
Author(s):
API Tags:
See:  Redirect_Composer_Local

Properties

Methods
[ Top ]
Descendants
Class Overview | Descendants | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
Child Class Description
Redirect_Composer_Local Redirect_Composer_Local is intended to be used for internal redirect within site

[ Top ]
Inherited Properties, Constants, and Methods
Class Overview | Descendants | Inherited Properties, Constants, and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
Inherited Properties Inherited Methods Inherited Constants

Inherited From Tangra_Class

Tangra_Class::get_class_name()
Alias of get_class(). Exist because of historical reasons.
Tangra_Class::__set()
Overides PHP built-in method and just throws exception if called. Purpose - to "forbid" autosetting of nonexisting class properties.

[ Top ]
Property Summary
Class Overview | Descendants | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
array   $param_pairs   Parameters that will be added to target address
string   $target   Target address

[ Top ]
Method Summary
Class Overview | Descendants | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
Redirect_Composer   __construct()   Constructor
void   add_param_pair()   Add new parameter pair
string   get_location()   Returns composed location that can be used directly by header()
array   get_params()   Returns all paramteres
string   get_target()   Returns target
string   get_target_address()   Returns composed target address with parameters
boolean   param_exists()   Checks if there is param pair with param name $key
void   remove_param()   Removes param pair
void   set_target()   Sets $target

[ Top ]
Properties
Class Overview | Descendants | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
array   $param_pairs [line 43]

Parameters that will be added to target address

API Tags:
Internal:  
Access:  private


[ Top ]
string   $target [line 35]

Target address

API Tags:
Internal:  
Access:  private


[ Top ]
Methods
Class Overview | Descendants | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
Constructor __construct  [line 53]

  Redirect_Composer __construct( string $target, [array $param_pairs = array()]  )

Constructor

Parameters:
string   $target:  Target address
array   $param_pairs:  Parameters that will be added to target address ($key => $value pairs)

Information Tags:
Throws:  Tangra_Exception
Redefined in descendants as:

[ Top ]
add_param_pair  [line 115]

  void add_param_pair( string $key, string $value  )

Add new parameter pair

Parameters:
string   $key:  Parameter name
string   $value:  Parameter value

API Tags:
Access:  public

Information Tags:
Throws:  TE_Key_Already_Exists

[ Top ]
get_location  [line 68]

  string get_location( )

Returns composed location that can be used directly by header()


API Tags:
Access:  public


[ Top ]
get_params  [line 152]

  array get_params( )

Returns all paramteres


API Tags:
Access:  protected


[ Top ]
get_target  [line 92]

  string get_target( )

Returns target


API Tags:
Access:  public


[ Top ]
get_target_address  [line 102]

  string get_target_address( )

Returns composed target address with parameters


API Tags:
Access:  public

Redefined in descendants as:

[ Top ]
param_exists  [line 142]

  boolean param_exists( string $key  )

Checks if there is param pair with param name $key

Parameters:
string   $key: 

API Tags:
Access:  public


[ Top ]
remove_param  [line 129]

  void remove_param( string $key  )

Removes param pair

Parameters:
string   $key:  Name of the param pair

API Tags:
Access:  public


[ Top ]
set_target  [line 82]

  void set_target( Web_Context $target  )

Sets $target

Parameters:
Web_Context   $target: 

API Tags:
Internal:  
Access:  private


[ Top ]