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

Class: Web_Event_Simple

Source Location: /web_site/web_event_simple.class.php

Class Web_Event_Simple

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

Web_Event_Simple may contain single condition that have to be met in order event to be generated.

"Single condition" means that presence of one GET/POST/PI parameter is monitored.

Located in /web_site/web_event_simple.class.php [line 42] 

Tangra_Class
   |
   --Event
      |
      --Web_Event
         |
         --Web_Event_Simple

Properties

Methods
[ Top ]
Descendants
Class Overview | Descendants | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
Child Class Description
Web_Event_Simple_Int Web_Event_Simple that expect captured value to be integer otherwise throws exception

[ 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 Event

Event::$name

Inherited From Web_Event

Web_Event::get_capture()
Returns label of the capture
Web_Event::is_it_me()
Checks if event condition is met

Inherited From Event

Event::__construct()
Event::get_name()
Gets the event name
Event::set_name()
Sets the event name

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
string   $capture   label of the capture
integer   $type   Type of the event

[ Top ]
Method Summary
Class Overview | Descendants | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
Web_Event_Simple   __construct()   Constructor
string   get_capture()   Returns capture label
unknown   get_type()   Returns type of the event
string   is_it_me()   Checks if event condition is met
void   set_capture()   Sets capture label
void   set_type()   Sets event type

[ Top ]
Properties
Class Overview | Descendants | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
string   $capture [line 57]

label of the capture

API Tags:
Access:  private


[ Top ]
integer   $type [line 50]

Type of the event

Tangra_Parameter_Method::GET or Tangra_Parameter_Method::POST or Tangra_Parameter_Method::PI

 API Tags:
Access:  private


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

  Web_Event_Simple __construct( string $name, integer $type, string $capture  )

Constructor

Parameters:
string   $name:  Name of the event
integer   $type:  Type of the event. Tangra_Parameter_Method::GET or Tangra_Parameter_Method::POST or Tangra_Parameter_Method::PI
string   $capture:  Label of the capture

Redefinition of:
Event::__construct()

[ Top ]
get_capture  [line 118]

  string get_capture( )

Returns capture label


API Tags:
Access:  public

Redefinition of:
Web_Event::get_capture()
Returns label of the capture

[ Top ]
get_type  [line 128]

  unknown get_type( )

Returns type of the event


API Tags:
Access:  public


[ Top ]
is_it_me  [line 82]

  string is_it_me( Web_Context $context  )

Checks if event condition is met

Parameters:
Web_Context   $context: 

API Tags:
Return:  Value of the capture
Access:  public

Redefinition of:
Web_Event::is_it_me()
Checks if event condition is met
Redefined in descendants as:

[ Top ]
set_capture  [line 139]

  void set_capture( unknown_type $capture  )

Sets capture label

Parameters:
unknown_type   $capture: 

API Tags:
Internal:  
Access:  protected


[ Top ]
set_type  [line 160]

  void set_type( integer $type  )

Sets event type

Tangra_Parameter_Method::NONE or Tangra_Parameter_Method::GET or Tangra_Parameter_Method::POST or Tangra_Parameter_Method::PI

Tangra_Parameter_Method::NONE is used to declare that no parameters are expected

 Parameters:
integer   $type: 

API Tags:
Internal:  
Access:  protected


[ Top ]