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

Class: Redirect_Composer_Local

Source Location: /web_site/redirect_composer_local.class.php

Class Redirect_Composer_Local

Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From Redirect_Composer

Redirect_Composer::$param_pairs
Redirect_Composer::$target

Inherited From Redirect_Composer

Redirect_Composer::__construct()
Constructor
Redirect_Composer::add_param_pair()
Add new parameter pair
Redirect_Composer::get_location()
Returns composed location that can be used directly by header()
Redirect_Composer::get_params()
Returns all paramteres
Redirect_Composer::get_target()
Returns target
Redirect_Composer::get_target_address()
Returns composed target address with parameters
Redirect_Composer::param_exists()
Checks if there is param pair with param name $key
Redirect_Composer::remove_param()
Removes param pair
Redirect_Composer::set_target()
Sets $target

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
integer   $port   Holds port that will be used for composing
string   $protocol   Holds protocol: http, https or ''
Web_Context   $_context   Holds Web_Context

[ Top ]
Method Summary
Redirect_Composer_Local   __construct()   Constructor
void   add_threads_manager_var()   Adds threads manager var to parameters
void   get_pi_string()  
void   get_port()   Returns port
void   get_protocol()   Returns $protocol
string   get_target_address()   Returns composed target address with parameters
Web_Context   get__context()   Returns reference to context
void   set_context()   Sets context
void   set_port()   Sets port to be used when composing
void   set_protocol()   Sets protocol.

[ Top ]
Properties
integer   $port [line 57]

Holds port that will be used for composing

API Tags:
Access:  private


[ Top ]
string   $protocol [line 50]

Holds protocol: http, https or ''

'' (empty) value means keep current

API Tags:
Access:  private


[ Top ]
Web_Context   $_context [line 41]

Holds Web_Context

API Tags:
Access:  private


[ Top ]
Methods
Constructor __construct  [line 66]

  Redirect_Composer_Local __construct( Web_Context $context, string $target, [array $param_pairs = array()], [ $protocol = ''], [ $port = 0]  )

Constructor

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

Information Tags:
Throws:  Tangra_Exception

Redefinition of:
Redirect_Composer::__construct()
Constructor

[ Top ]
add_threads_manager_var  [line 203]

  void add_threads_manager_var( Web_Context $context  )

Adds threads manager var to parameters

Parameters:
Web_Context   $context: 

API Tags:
Internal:  
Access:  private


[ Top ]
get_pi_string  [line 224]

  void get_pi_string( )


API Tags:
Access:  private


[ Top ]
get_port  [line 139]

  void get_port( )

Returns port


API Tags:
Access:  public


[ Top ]
get_protocol  [line 112]

  void get_protocol( )

Returns $protocol


API Tags:
Access:  public


[ Top ]
get_target_address  [line 150]

  string get_target_address( Web_Context $context  )

Returns composed target address with parameters

Parameters:
Web_Context   $context: 

API Tags:
Access:  public


Redefinition of:
Redirect_Composer::get_target_address()
Returns composed target address with parameters

[ Top ]
get__context  [line 90]

  Web_Context get__context( )

Returns reference to context


API Tags:
Access:  public


[ Top ]
set_context  [line 80]

  void set_context( Web_Context $context  )

Sets context

Parameters:
Web_Context   $context: 

API Tags:
Internal:  
Access:  private


[ Top ]
set_port  [line 126]

  void set_port( [integer $port = 0]  )

Sets port to be used when composing

Valid values: integer - sets port to specified value

  1. - "use current" (autodetected)
NULL - sets port to NULL which means don't set port when composing

Parameters:
integer   $port: 

API Tags:
Access:  public


[ Top ]
set_protocol  [line 100]

  void set_protocol( string $protocol  )

Sets protocol.

Parameters:
string   $protocol:  Valid values are http, https and '' (empty). Empty value means "use current" (autodetected)

API Tags:
Access:  public

Information Tags:
Throws:  Tangra_Expception

[ Top ]