phpPoA2
[ class tree: phpPoA2 ] [ index: phpPoA2 ] [ all elements ]

Class: Hook

Source Location: /lib/Hook.php

Class Overview


Hook class that allows to run a function or a method specified by their name.


Variables

Methods



Class Details

[line 30]
Hook class that allows to run a function or a method specified by their name.



[ Top ]


Class Variables

$_callable_name =

[line 33]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_hook =

[line 32]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_name =

[line 34]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor __construct [line 42]

boolean __construct( hook $hook)

Build a new hook.



Tags:

return:  true if everything is ok.
throws:  PoAException if something goes wrong.
access:  public


Parameters:

hook   $hook   The name of a function or an array specifying a class and its method.

[ Top ]

method getName [line 120]

string getName( )

Get the name of the hook.



Tags:

return:  The name.
access:  public


[ Top ]

method run [line 103]

boolean run( args &$args)

Run the hook with the specified params.



Tags:

return:  The return value of the function. Please, bear in mind that the function must return true if hooks proccessing should stop, false in any other case.
access:  public


Parameters:

args   &$args   An array with all the params the function receives.

[ Top ]


Documentation generated on Mon, 20 Feb 2012 12:07:02 +0100 by phpDocumentor 1.4.3