makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-28 06:08:52 +00:00
Code Issues Projects Releases Packages Wiki Activity

ok... i seem to have overlooked the handy __CLASS__ constant. ;)

Browse source 
git-svn-id: file:///svn/phpbb/trunk@8106 89ea8834-ac86-4346-8a33-228a782c2dd0
This commit is contained in:
Meik Sievertsen 2007-09-23 14:14:49 +00:00
parent cd4aa46b93
commit 8d2bfa5c10
3 changed files with 20 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
phpBB/docs/hook_system.html
View file

@ -434,11 +434,11 @@ class my_hookable_object
{ {
global $phpbb_hook; global $phpbb_hook;
if ($phpbb_hook->call_hook(array(get_class($this), __FUNCTION__), $my_first_parameter, $my_second_parameter)) if ($phpbb_hook->call_hook(array(__CLASS__, __FUNCTION__), $my_first_parameter, $my_second_parameter))
{ {
if ($phpbb_hook->hook_return(array(get_class($this), __FUNCTION__))) if ($phpbb_hook->hook_return(array(__CLASS__, __FUNCTION__)))
{ {
return $phpbb_hook->hook_return_result(array(get_class($this), __FUNCTION__)); return $phpbb_hook->hook_return_result(array(__CLASS__, __FUNCTION__));
} }
} }
@ -447,7 +447,7 @@ class my_hookable_object
} }
</pre></div> </pre></div>
<p>The only difference about calling it is the way you define the first parameter. For a function it is only <code>__FUNCTION__</code>, for a method it is <code>array(get_class($this), __FUNCTION__)</code>. Since PHP 5.0.0 the get_class() function no longer requires the object to be given, you simply write: <code>array(get_class(), __FUNCTION__)</code>.</p> <p>The only difference about calling it is the way you define the first parameter. For a function it is only <code>__FUNCTION__</code>, for a method it is <code>array(__CLASS__, __FUNCTION__)</code>. In PHP4 __CLASS__ is always returning the class in lowercase.</p>
<p>Now, in phpBB there are some pre-defined hooks available, but how do you make your own hookable function available (and therefore allowing others to hook into it)? For this, there is the add_hook() method:</p> <p>Now, in phpBB there are some pre-defined hooks available, but how do you make your own hookable function available (and therefore allowing others to hook into it)? For this, there is the add_hook() method:</p>
@ -579,11 +579,11 @@ class my_hookable_object2 extends my_hookable_object
{ {
global $phpbb_hook; global $phpbb_hook;
if ($phpbb_hook-&gt;call_hook(array(get_class($this), __FUNCTION__), $my_first_parameter, $my_second_parameter)) if ($phpbb_hook-&gt;call_hook(array(__CLASS__, __FUNCTION__), $my_first_parameter, $my_second_parameter))
{ {
if ($phpbb_hook-&gt;hook_return(array(get_class($this), __FUNCTION__))) if ($phpbb_hook-&gt;hook_return(array(__CLASS__, __FUNCTION__)))
{ {
return $phpbb_hook-&gt;hook_return_result(array(get_class($this), __FUNCTION__)); return $phpbb_hook-&gt;hook_return_result(array(__CLASS__, __FUNCTION__));
} }
} }
} }
@ -636,11 +636,11 @@ class my_hookable_object2 extends my_hookable_object
{ {
global $phpbb_hook; global $phpbb_hook;
if ($phpbb_hook-&gt;call_hook(array(get_class($this), __FUNCTION__), $my_first_parameter, $my_second_parameter)) if ($phpbb_hook-&gt;call_hook(array(__CLASS__, __FUNCTION__), $my_first_parameter, $my_second_parameter))
{ {
if ($phpbb_hook-&gt;hook_return(array(get_class($this), __FUNCTION__))) if ($phpbb_hook-&gt;hook_return(array(__CLASS__, __FUNCTION__)))
{ {
return $phpbb_hook-&gt;hook_return_result(array(get_class($this), __FUNCTION__)); return $phpbb_hook-&gt;hook_return_result(array(__CLASS__, __FUNCTION__));
} }
} }
} }

14
phpBB/includes/hooks/index.php
View file

@ -59,7 +59,7 @@ class phpbb_hook
* Register function/method to be called within hook * Register function/method to be called within hook
* This function is normally called by the modification/application to attach/register the functions. * This function is normally called by the modification/application to attach/register the functions.
* *
* @param mixed $definition Declaring function (with __FUNCTION__) or class with array(get_class([$object]), __FUNCTION__) (PHP4 requires $object to be given) * @param mixed $definition Declaring function (with __FUNCTION__) or class with array(__CLASS__, __FUNCTION__)
* @param mixed $hook The replacement function/method to be called. Passing function name or array with object/class definition * @param mixed $hook The replacement function/method to be called. Passing function name or array with object/class definition
* @param string $mode Specify the priority/chain mode. 'normal' -> hook gets appended to the chain. 'standalone' -> only the specified hook gets called - later hooks are not able to overwrite this (E_NOTICE is triggered then). 'first' -> hook is called as the first one within the chain. 'last' -> hook is called as the last one within the chain. * @param string $mode Specify the priority/chain mode. 'normal' -> hook gets appended to the chain. 'standalone' -> only the specified hook gets called - later hooks are not able to overwrite this (E_NOTICE is triggered then). 'first' -> hook is called as the first one within the chain. 'last' -> hook is called as the last one within the chain.
*/ */
@ -101,7 +101,7 @@ class phpbb_hook
* Calling all functions/methods attached to a specified hook. * Calling all functions/methods attached to a specified hook.
* Called by the function allowing hooks... * Called by the function allowing hooks...
* *
* @param mixed $definition Declaring function (with __FUNCTION__) or class definition with array(). Must be call_user_func_array() compatible. * @param mixed $definition Declaring function (with __FUNCTION__) or class with array(__CLASS__, __FUNCTION__)
* @return bool False if no hook got executed, true otherwise * @return bool False if no hook got executed, true otherwise
*/ */
function call_hook($definition) function call_hook($definition)
@ -154,7 +154,7 @@ class phpbb_hook
/** /**
* Get result from previously called functions/methods for the same hook * Get result from previously called functions/methods for the same hook
* *
* @param mixed $definition Declaring function (with __FUNCTION__) or class with array(get_class([$object]), __FUNCTION__) (PHP4 requires $object to be given) * @param mixed $definition Declaring function (with __FUNCTION__) or class with array(__CLASS__, __FUNCTION__)
* @return mixed False if nothing returned if there is no result, else array('result' => ... ) * @return mixed False if nothing returned if there is no result, else array('result' => ... )
*/ */
function previous_hook_result($definition) function previous_hook_result($definition)
@ -173,7 +173,7 @@ class phpbb_hook
/** /**
* Check if the called functions/methods returned something. * Check if the called functions/methods returned something.
* *
* @param mixed $definition Declaring function (with __FUNCTION__) or class with array(get_class([$object]), __FUNCTION__) (PHP4 requires $object to be given) * @param mixed $definition Declaring function (with __FUNCTION__) or class with array(__CLASS__, __FUNCTION__)
* @return bool True if results are there, false if not * @return bool True if results are there, false if not
*/ */
function hook_return($definition) function hook_return($definition)
@ -192,7 +192,7 @@ class phpbb_hook
/** /**
* Give actual result from called functions/methods back. * Give actual result from called functions/methods back.
* *
* @param mixed $definition Declaring function (with __FUNCTION__) or class with array(get_class([$object]), __FUNCTION__) (PHP4 requires $object to be given) * @param mixed $definition Declaring function (with __FUNCTION__) or class with array(__CLASS__, __FUNCTION__)
* @return mixed The result * @return mixed The result
*/ */
function hook_return_result($definition) function hook_return_result($definition)
@ -213,7 +213,7 @@ class phpbb_hook
/** /**
* Add new function to the allowed hooks. * Add new function to the allowed hooks.
* *
* @param mixed $definition Declaring function (with __FUNCTION__) or class with array(get_class([$object]), __FUNCTION__) (PHP4 requires $object to be given) * @param mixed $definition Declaring function (with __FUNCTION__) or class with array(__CLASS__, __FUNCTION__)
*/ */
function add_hook($definition) function add_hook($definition)
{ {
@ -228,7 +228,7 @@ class phpbb_hook
/** /**
* Remove function from the allowed hooks. * Remove function from the allowed hooks.
* *
* @param mixed $definition Declaring function (with __FUNCTION__) or class with array(get_class([$object]), __FUNCTION__) (PHP4 requires $object to be given) * @param mixed $definition Declaring function (with __FUNCTION__) or class with array(__CLASS__, __FUNCTION__)
*/ */
function remove_hook($definition) function remove_hook($definition)
{ {

6
phpBB/includes/template.php
View file

@ -149,11 +149,11 @@ class template
{ {
global $user, $phpbb_hook; global $user, $phpbb_hook;
if ($phpbb_hook->call_hook(array(get_class($this), __FUNCTION__), $handle, $include_once)) if ($phpbb_hook->call_hook(array(__CLASS__, __FUNCTION__), $handle, $include_once))
{ {
if ($phpbb_hook->hook_return(array(get_class($this), __FUNCTION__))) if ($phpbb_hook->hook_return(array(__CLASS__, __FUNCTION__)))
{ {
return $phpbb_hook->hook_return_result(array(get_class($this), __FUNCTION__)); return $phpbb_hook->hook_return_result(array(__CLASS__, __FUNCTION__));
} }
} }