eZPublish  3.8
eZExtension Class Reference

The class eZExtension does. More...

Public Member Functions

 eZExtension ()
 

Static Public Member Functions

 activateExtensions ($extensionType=false)
 
 activeExtensions ($extensionType=false)
 
 baseDirectory ()
 
 expandedPathList ($extensionList, $subdirectory=false)
 
 extensionInfo ($extension)
 
 findExtensionType ($parameters, &$out)
 
 prependExtensionSiteAccesses ($accessName=false, $ini=false, $globalDir=true, $identifier=false, $order=true)
 
 prependSiteAccess ($extension, $accessName=false, $ini=false, $globalDir=true, $identifier=false)
 

Detailed Description

The class eZExtension does.

Member Function Documentation

eZExtension::activateExtensions (   $extensionType = false)
static

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

Referenced by eZScript\initialize().

eZExtension::activeExtensions (   $extensionType = false)
static
Returns
an array with extensions that has been activated.
Parameters
$extensionTypeDecides which extension to include in the list, the follow values are possible.
  • false - Means add both default and access extensions
  • 'default' - Add only default extensions
  • 'access' - Add only access extensions

Default extensions are those who are loaded before a siteaccess are determined while access extensions are loaded after siteaccess is set.

Referenced by activateExtensions(), eZModule\activeModuleRepositories(), eZContentUpload\findHandler(), eZSiteAccess\findPathToSiteAccess(), eZDB\instance(), eZPaymentGatewayType\loadAndRegisterExtensionGateways(), and prependExtensionSiteAccesses().

eZExtension::expandedPathList (   $extensionList,
  $subdirectory = false 
)
static

Generates a list with expanded paths and returns it. The paths are expanded to where the extensions are placed. Optionally a subdirectory of the extension may be set using $subdirectory.

Referenced by eZSimpleTagsOperator\initializeIncludes(), eZUserLoginHandler\instance(), eZUser\instance(), eZCodeMapper\loadTransformationFiles(), and templateInit().

eZExtension::extensionInfo (   $extension)
static

Read extension information. Returns extension information array specified in feature request 9371. ( http://issues.ez.no/9371 )

Parameters
extensionname
Returns
Extension information array. null if extension is not found, or does not contain extension information.
eZExtension::eZExtension ( )

Constructor

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 or you want multiple names (aliases) for one type.

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.

Referenced by eZImageAnalyzer\create(), eZImageManager\factoryFor(), eZXMLText\fetchHandler(), eZShopAccountHandler\instance(), eZBinaryFileHandler\instance(), eZPackageInstallationHandler\instance(), eZPackageCreationHandler\instance(), and eZBinaryFile\metaData().

eZExtension::prependExtensionSiteAccesses (   $accessName = false,
  $ini = false,
  $globalDir = true,
  $identifier = false,
  $order = true 
)
static

Prepend extension siteaccesses

Parameters
siteaccessname ( default false )

Referenced by changeAccess(), eZINI\findInputFiles(), eZTemplateDesignResource\overrideArray(), and eZTemplateDesignResource\overrideKeys().

eZExtension::prependSiteAccess (   $extension,
  $accessName = false,
  $ini = false,
  $globalDir = true,
  $identifier = false 
)
static

Prepend siteaccess for specified extension.

Parameters
$extensionname

Referenced by activateExtensions(), and prependExtensionSiteAccesses().


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