Manual

SDK

 
   

API Reference
 

Sections

Todo

eZExtension Class Reference

The class eZExtension does. More...

List of all members.


Public Methods

 eZExtension ()

Static Public Methods

 baseDirectory ()
 activeExtensions ()
 activateExtensions ()
 findExtensionType ($parameters,&$out)

Detailed Description

The class eZExtension does.

Definition at line ezextension.php.

Constructor & Destructor Documentation

eZExtension::eZExtension (    ) 
 

Constructor

Definition at line ezextension.php.

Member Function Documentation

eZExtension::activateExtensions (    )  [static]
 

Will make sure that all extensions that has settings directories are added to the eZINI override list.

Definition at line ezextension.php.

References eZINI::instance().

eZExtension::activeExtensions (    )  [static]
 

Returns:
an array with extensions that has been activated

Definition at line ezextension.php.

References eZINI::instance().

Referenced by activeExtensions().

eZExtension::baseDirectory (    )  [static]
 

Returns:
the base directory for extensions

Definition at line ezextension.php.

References eZINI::instance().

Referenced by eZCollaborationItemHandler::handlerRepositories().

eZExtension::findExtensionType (  $    parameters,
&$    out
)  [static]
 

This is help function for searching for extension code. It will read ini variables defined in $parameters, search trough the specified directories for specific files and set the result in $out.

The $parameters parameter must contain the following entries.

  • ini-name - The name of the ini file which has the settings, must include the .ini suffix.
  • repository-group - The INI group which has the basic repository settings.
  • repository-variable - The INI variable which has the basic repository settings.
  • extension-group - The INI group which has the extension settings.
  • extension-variable - The INI variable which has the extension settings.
  • subdir - A subdir which will be appended to all repositories searched for, can be left out.
  • extension-subdir - A subdir which will be appended to all extension repositories searched for, can be left out.
  • suffix-name - A suffix which will be appended after the file searched for.
  • type-directory - Whether the type has a directory for it's file or not. Default is true.
  • type - The type to look for, it will try to find a file named repository/subdir/type/type-suffix or if type-directory is false repository/subdir/type-suffix. If type is not specified the type-group and typ-variable may be used for fetching the current type.
  • type-group - The INI group which has the type setting.
  • type-variable - The INI variable which has the type setting.
  • alias-group - The INI group which defines type aliases, see below.
  • alias-variable - The INI variable which defines type aliases.
Type aliases allows overriding a specific type to use another type handler, this is useful when extensions want to take control of some specific types.

On success the $out parameter will contain:

  • type - The current type used.
  • original-type - The original type, if aliasing was used it may differ from type.
  • found-file-dir - The directory where the type was found.
  • found-file-path - The full path to the type.
  • found-file-name - The filename of the type.
Returns:
true if the extension type was found.

Definition at line ezextension.php.

References eZINI::instance().

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

Exponential