Class Zend

Description

Utility class for common functions.

Located in /Zend.php (line 34)


	
			
Variable Summary
 array $_registry
Method Summary
 Zend __construct ()
 string dump (mixed $var, [string $label = null], [mixed $echo = true])
 boolean isReadable (string $filename)
 boolean isRegistered (string $name)
 void loadClass (string $class, [string $dirs = null])
 void loadFile (string $filename, [mixed $dirs = null], [boolean $once = false], string|null $directory)
 void loadInterface (string $interface, [string $dirs = null])
 void register (string $name, object $obj)
 object The registry ([string $name = null])
Variables
array $_registry = array() (line 40)

Object registry provides storage for shared objects

  • access: private
  • static:
Methods
Constructor __construct (line 46)

Singleton Pattern

  • access: private
Zend __construct ()
dump (line 235)

Debug helper function. This is a wrapper for var_dump() that adds the <pre /> tags, cleans up newlines and indents, and runs htmlentities() before output.

  • access: public
  • static:
string dump (mixed $var, [string $label = null], [mixed $echo = true])
  • mixed $var: The variable to dump.
  • string $label: An optional label.
isReadable (line 215)

Returns TRUE if the $filename is readable, or FALSE otherwise. This function uses the PHP include_path, where PHP's is_readable() does not.

  • access: public
  • static:
boolean isReadable (string $filename)
  • string $filename
isRegistered (line 354)

Returns TRUE if the $name is a named object in the registry, or FALSE if $name was not found in the registry.

  • access: public
  • static:
boolean isRegistered (string $name)
  • string $name
loadClass (line 69)

Loads a class from a PHP file. The filename must be formatted as "$class.php".

If $dirs is a string or an array, it will search the directories in the order supplied, and attempt to load the first matching file.

If $dirs is null, it will split the class name at underscores to generate a path hierarchy (e.g., "Zend_Example_Class" will map to "Zend/Example/Class.php").

If the file was not found in the $dirs, or if no $dirs were specified, it will attempt to load it from PHP's include_path.

  • access: public
  • static:
  • throws: Zend_Exception
void loadClass (string $class, [string $dirs = null])
  • string $class
  • string $dirs
loadFile (line 160)

Loads a PHP file. This is a wrapper for PHP's include() function.

$filename must be the complete filename, including any extension such as ".php". Note that a security check is performed that does not permit extended characters in the filename. This method is intended for loading Zend Framework files.

If $dirs is a string or an array, it will search the directories in the order supplied, and attempt to load the first matching file.

If the file was not found in the $dirs, or if no $dirs were specified, it will attempt to load it from PHP's include_path.

If $once is TRUE, it will use include_once() instead of include().

  • access: public
  • static:
  • throws: Zend_Exception
void loadFile (string $filename, [mixed $dirs = null], [boolean $once = false], string|null $directory)
  • string $filename
  • string|null $directory
  • boolean $once
loadInterface (line 113)

Loads an interface from a PHP file. The filename must be formatted as "$interface.php".

If $dirs is a string or an array, it will search the directories in the order supplied, and attempt to load the first matching file.

If $dirs is null, it will split the interface name at underscores to generate a path hierarchy (e.g., "Zend_Example_Interface" will map to "Zend/Example/Interface.php").

If the file was not found in the $dirs, or if no $dirs were specified, it will attempt to load it from PHP's include_path.

  • access: public
  • static:
  • throws: Zend_Exception
void loadInterface (string $interface, [string $dirs = null])
  • string $interface
  • string $dirs
register (line 273)

Registers a shared object.

  • access: public
  • static:
  • throws: Zend_Exception
void register (string $name, object $obj)
  • string $name: The name for the object.
  • object $obj: The object to register.
registry (line 325)

Retrieves a registered shared object, where $name is the registered name of the object to retrieve.

If the $name argument is NULL, an array will be returned where the keys to the array are the names of the objects in the registry and the values are the class names of those objects.

  • return: registered object.
  • access: public
  • static:
  • throws: Zend_Exception
  • see: Zend::register()
object The registry ([string $name = null])
  • string $name: The name for the object.

Documentation generated on Tue, 18 Apr 2006 11:55:50 -0700 by phpDocumentor 1.3.0RC3