CI_Hooks Class Reference

List of all members.

Public Member Functions
	CI_Hooks ()
	Constructor.
	_initialize ()
	Initialize the Hooks Preferences.
	_call_hook ($which= '')
	Call Hook.
	_run_hook ($data)
	Run Hook.
Public Attributes
	$enabled = FALSE
	$hooks = array()
	$in_progress = FALSE

---

Detailed Description

Definition at line 30 of file Hooks.php.

---

Member Function Documentation

CI_Hooks::_call_hook

(

$

which = ''

)

Call Hook.

Calls a particular hook

private

Parameters:

string

the hook name

Returns:

mixed

Definition at line 91 of file Hooks.php.

References _run_hook().

        {
                if ( ! $this->enabled OR ! isset($this->hooks[$which]))
                {
                        return FALSE;
                }
        
                if (isset($this->hooks[$which][0]) AND is_array($this->hooks[$which][0]))
                {
                        foreach ($this->hooks[$which] as $val)
                        {
                                $this->_run_hook($val);
                        }
                }
                else
                {
                        $this->_run_hook($this->hooks[$which]);
                }
                
                return TRUE;
        }

Here is the call graph for this function:

CI_Hooks::_initialize

(

)

Initialize the Hooks Preferences.

private

Returns:

void

Definition at line 54 of file Hooks.php.

References $CFG, and load_class().

Referenced by CI_Hooks().

        {
                $CFG =& load_class('Config');
                
                // If hooks are not enabled in the config file
                // there is nothing else to do
                
                if ($CFG->item('enable_hooks') == FALSE)
                {
                        return;
                }
                
                // Grab the "hooks" definition file.
                // If there are no hooks, we're done.
                
                @include(APPPATH.'config/hooks'.EXT);
                
                if ( ! isset($hook) OR ! is_array($hook))
                {
                        return;
                }

                $this->hooks =& $hook;
                $this->enabled = TRUE;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_Hooks::_run_hook

(

$

data

)

Run Hook.

Runs a particular hook

private

Parameters:

array

the hook details

Returns:

bool

Definition at line 124 of file Hooks.php.

References $class.

Referenced by _call_hook().

        {
                if ( ! is_array($data))
                {
                        return FALSE;
                }
                
                // -----------------------------------
                // Safety - Prevents run-away loops
                // -----------------------------------
        
                // If the script being called happens to have the same
                // hook call within it a loop can happen
                
                if ($this->in_progress == TRUE)
                {
                        return;
                }

                // -----------------------------------
                // Set file path
                // -----------------------------------
                
                if ( ! isset($data['filepath']) OR ! isset($data['filename']))
                {
                        return FALSE;
                }
                
                $filepath = APPPATH.$data['filepath'].'/'.$data['filename'];
        
                if ( ! file_exists($filepath))
                {
                        return FALSE;
                }
                
                // -----------------------------------
                // Set class/function name
                // -----------------------------------
                
                $class          = FALSE;
                $function       = FALSE;
                $params         = '';
                
                if (isset($data['class']) AND $data['class'] != '')
                {
                        $class = $data['class'];
                }

                if (isset($data['function']))
                {
                        $function = $data['function'];
                }

                if (isset($data['params']))
                {
                        $params = $data['params'];
                }
                
                if ($class === FALSE AND $function === FALSE)
                {
                        return FALSE;
                }
                
                // -----------------------------------
                // Set the in_progress flag
                // -----------------------------------

                $this->in_progress = TRUE;
                
                // -----------------------------------
                // Call the requested class and/or function
                // -----------------------------------
                
                if ($class !== FALSE)
                {
                        if ( ! class_exists($class))
                        {
                                require($filepath);
                        }
                
                        $HOOK = new $class;
                        $HOOK->$function($params);
                }
                else
                {
                        if ( ! function_exists($function))
                        {
                                require($filepath);
                        }
                
                        $function($params);
                }
        
                $this->in_progress = FALSE;
                return TRUE;
        }

Here is the caller graph for this function:

CI_Hooks::CI_Hooks

(

)

Constructor.

Definition at line 40 of file Hooks.php.

References _initialize(), and log_message().

        {
                $this->_initialize();   
                log_message('debug', "Hooks Class Initialized");
        }

Here is the call graph for this function:

---

Member Data Documentation

CI_Hooks::$enabled = FALSE

Definition at line 32 of file Hooks.php.

CI_Hooks::$hooks = array()

Definition at line 33 of file Hooks.php.

CI_Hooks::$in_progress = FALSE

Definition at line 34 of file Hooks.php.

---

The documentation for this class was generated from the following file:

• Hooks.php