zLoader Class Reference
[Zigmoyd's loader Utilities.]

Contains the methods to load module(s), View(s), plugin(s). More...

Inheritance diagram for zLoader:

[legend]

Collaboration diagram for zLoader:

[legend]

Public Member Functions
	zLoader ()
	__construct ()
	Defines the constants required and dumps the array of parsed class.ini.php file under settings also links $zLoader to zLoader class.
	ld ($path, $str, $indx)
	The main loader Method ran through module and plugin method that actually loads the method / Plugin $key === module / Plugin / .
	module ($str, $mode=MOD_EXPLICIT)
	Loads a Module.
	modules ()
	Loads multiple modules at a time.
	plugin ($str, $mode=PLUG_EXPLICIT)
	Loads Plugins.
	plugins ()
	Loads multiple Modules at a time.
	lib ($libName)
	Load a Lib of the Current Project.
	listModules ()
	List's all the aviliable/loadable modules.
	listPlugins ()
	List's all the aviliable/loadable plugins.
Data Fields
	$class
	$loaded_mods = array()

---

Detailed Description

Contains the methods to load module(s), View(s), plugin(s).

Get's Instantiated as $load Global Object. You can Use $load->module() or $load->plugin() etc.. and from your Controler you get a reference to $load Object as $this->load

Definition at line 33 of file preloader.php.

---

Constructor & Destructor Documentation

zLoader::__construct( ) 

Defines the constants required and dumps the array of parsed class.ini.php file under settings also links $zLoader to zLoader class.

Reimplemented from zCore.

Definition at line 45 of file preloader.php.

Referenced by zLoader().

Show Source

                        {
    parent::__construct();
    if(!defined('MOD_INTERNAL')){define("MOD_INTERNAL", "module-abstract");}
    if(!defined('MOD_EXPLICIT')){define("MOD_EXPLICIT", "module");}
    if(!defined('PLUG_INTERNAL')){define("PLUG_INTERNAL", "plugin-abstract");}
    if(!defined('PLUG_EXPLICIT')){define("PLUG_EXPLICIT", "plugin");}
    if(!defined('Z_CLS_LOAD_CNS')){define('Z_CLS_LOAD_CNS', 1);}
    if(!defined('Z_MODULE_FILE_NAME')){define('Z_MODULE_FILE_NAME', 'class.ini.php');}
    $this->class = parse_ini_file(ZIGSETTINGS.DRS.'class.ini.php', true);//Parse the class.ini.php File
  }

Top 

---

Member Function Documentation

zLoader::zLoader( ) 

Definition at line 37 of file preloader.php.

References __construct().

Show Source

                    {
    $this->__construct();
  }

Here is the call graph for this function:

Top 

zLoader::ld( unknown $path, string $str, string $indx )

The main loader Method ran through module and plugin method that actually loads the method / Plugin $key === module / Plugin / .

.... $str === name of the module / plugin / .....

Parameters:

	$key	string
	$str

Definition at line 64 of file preloader.php.

References perror().

Referenced by module(), and plugin().

Show Source

                                 {
    //global ${Z_LOADER_VAR_NAME};
    $trg = ZIGROOT.DRS.$path.DRS.@$this->class[$indx][$str];
    if(!@in_array($str, array_keys($this->class[$indx]))){
      perror("Sorry the ".$indx." `".$str."` is not Installed/listed/Found according to ".Z_MODULE_FILE_NAME);
    }else{
      if(file_exists($trg) && is_readable($trg)){
        if(!@isset($this->loaded_mods[$indx][$str])){
          $this->loaded_mods[$indx][$str] = $path;
          include_once($trg);
        }
      }else{
        is_file($trg) ? $sts = "Not readable [ Permission : ".fileperms($trg)." ]" : $sts = "Not Present";
        perror("<code>zigmoyd.loader</code><br />Sorry the ".$path." `".$str."` is Not accessible<br />&nbsp;&nbsp;as the file `".$trg."` is ".$sts);
      }
    }
  }

Here is the call graph for this function:

Top 

zLoader::module( string $str, int $mode = MOD_EXPLICIT )

Loads a Module.

Fires Error if the module doesn't exists. after successfull loading of a module you can use all the classes and functions in that module. e.g. $load->module('zFaccess'); will load zFaccess module returns true if successfully loaded else returns false.

Parameters:

	$str	Name of the Module to load
	$mode	Optional MOD_EXPLICIT By default. Use MOD_INTERNAL for loading Abstract modules

Returns:

bool

Definition at line 92 of file preloader.php.

References ld(), and perror().

Referenced by modules().

Show Source

                                             {
    if($mode == MOD_EXPLICIT){$key = MOD_KEY_NAME_EXPLICIT;}elseif($mode == MOD_INTERNAL){
      $key = MOD_KEY_NAME_INTERNAL;}else{perror("Unknown Mode `".$mode."` Specified");}
      $this->ld($key, $str, $mode);
  }

Here is the call graph for this function:

Top 

zLoader::modules( ) 

Loads multiple modules at a time.

Loads numbers of modules through module() accept infinite number of arguments (module name) can also can accept Numarically indexed array of module names to load

Parameters:

	$module_name	mixed name of the Module(s) To Load can be string or array
	.....	mixed name(s) of module name can be string or array

Definition at line 107 of file preloader.php.

References $val, and module().

Show Source

                    {
    $lst_args = func_get_args();
    foreach($lst_args as $key => $val){
      if(!is_array($val)){$this->module($val);}
      else{foreach($val as $k => $v){$this->module($v);}}
    }
  }

Here is the call graph for this function:

Top 

zLoader::plugin( string $str, int $mode = PLUG_EXPLICIT )

Loads Plugins.

Fires error if Plugin doesn't exists. after successful loading of a plugin you can use all the classes, functions in that plugin. $load->plugin('weather'); will load weather Plugin.

Parameters:

	$str	Name of the Plugin to Load
	$mode	optinal PLUG_EXPLICIT by default use PLUG_INTERNAL to load abstract Plugins

Returns:

bool

Definition at line 124 of file preloader.php.

References ld(), and perror().

Referenced by plugins().

Show Source

                                              {
    if($mode == PLUG_EXPLICIT){$key = PLUG_KEY_NAME_EXPLICIT;}elseif($mode == PLUG_INTERNAL){
      $key = PLUG_KEY_NAME_INTERNAL;}else{perror("Unknown Mode `".$mode."` Specified");}
      $this->ld($key, $str, $mode);
  }

Here is the call graph for this function:

Top 

zLoader::plugins( ) 

Loads multiple Modules at a time.

Loads numbers of plugins through plugin() accept infinite number of arguments (plugin name) can also can accept 0 indexed array of plugin names to load

Parameters:

	$plugin_name	mixed name of the plugin(s) To Load can be string or array
	.....	mixed name(s) of plugin name can be string or array

Definition at line 139 of file preloader.php.

References $val, and plugin().

Show Source

                    {
    $lst_args = func_get_args();
    foreach($lst_args as $var){
      $this->plugin($val);
    }
  }

Here is the call graph for this function:

Top 

zLoader::lib( string $libName ) 

Load a Lib of the Current Project.

Parameters:

$libName

Name of the lib to Load

Definition at line 150 of file preloader.php.

References perror().

Show Source

                        {
    if(!file_exists(ZIGROOT.DRS.Z_DIR_PROJECTS.DRS.Z_PROJECT_DIR.DRS.Z_DIR_LOCAL_LIB.DRS.$libName.'.lib.php')){
      perror("<code>zigmoyd.loader.lib</code><br />Failed to load Lib $libName as file $libName.lib.php doesn't exist");
      return false;
    }
    if(!is_readable(ZIGROOT.DRS.Z_DIR_PROJECTS.DRS.Z_PROJECT_DIR.DRS.Z_DIR_LOCAL_LIB.DRS.$libName.'.lib.php')){
      perror("<code>zigmoyd.loader.lib</code><br />Failed to load Lib $libName as file $libName.lib.php is not readable");
      return false;
    }
    include_once(ZIGROOT.DRS.Z_DIR_PROJECTS.DRS.Z_PROJECT_DIR.DRS.Z_DIR_LOCAL_LIB.DRS.$libName.'.lib.php');
    return true;
  }

Here is the call graph for this function:

Top 

zLoader::listModules( ) 

List's all the aviliable/loadable modules.

Returns:

array

Definition at line 167 of file preloader.php.

Show Source

                        {
    return array_keys($this->class['module']);
  }

Top 

zLoader::listPlugins( ) 

List's all the aviliable/loadable plugins.

Returns:

array

Definition at line 175 of file preloader.php.

Show Source

                        {
    return array_keys($this->class['plugin']);
  }

Top 

---

Field Documentation

zLoader::$class

Definition at line 34 of file preloader.php.

Top 

zLoader::$loaded_mods = array()

Definition at line 35 of file preloader.php.

Top 

---

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

• preloader.php