lib/ezutils/classes/ezextension.php

Show:

inherited

Classes
- \eZExtension

Table of Contents

File containing the eZExtension class.

Copyright: Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
License: eZ Business Use License Agreement Version 2.0
Package: lib
Version: 4.6.0

\eZExtension
jump to top

Package: lib

File containing the eZExtension class.

Copyright: Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
License: eZ Business Use License Agreement Version 2.0
Version: 4.6.0

Constants

string 
                CACHE_DIR
                = 'var/cache/'

Constant path to directory for extensions ordering cache

: string

Properties

array
                 $activeExtensionsCache= 'array()'

static

In memory cache for ordered extensions

Default valuearray()Details

Type: array

Methods

activateExtensions(
          string $extensionType
              =
              'default', \eZINI | null $siteINI
              =
              null
          )
        
        :
          void

static

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

Parameters

Name	Type	Description
$extensionType	string	See {@link eZExtension::activeExtensions()}, value of false is deprecated as of 4.4
$siteINI	\eZINI \| null	Optional parameter to be able to only do change on specific instance of site.ini

activeExtensions(
          false | string $extensionType
              =
              false, \eZINI | null $siteINI
              =
              null
          )
        
        :
          array

static

Return an array with activated extensions.

Parameters

Name	Type	Description
$extensionType	false \| string	Decides 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
$siteINI	\eZINI \| null	Optional parameter to be able to only do change on specific instance of site.ini

Returns

Type	Description
array

Details

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

baseDirectory(
          \eZINI | null $siteINI
              =
              null
          )
        
        :
          string

static

return the base directory for extensions

Parameters

Name	Type	Description
$siteINI	\eZINI \| null	Optional parameter to be able to only do change on specific instance of site.ini

Returns

Type	Description
string

clearActiveExtensionsMemoryCache(
          
          )
        
        :
          void

static

Clears the active extensions in-memory cache

eZExtension(
          
          )
        
        :
          void

expandedPathList(
           $extensionList,  $subdirectory
              =
              false
          )
        
        :
          void

static

Parameters

Name	Type	Description
$extensionList
$subdirectory

extensionInfo(
           $extension
          )
        
        :
          void

static

Parameters

Name	Type	Description
$extension

extensionOrdering(
          array $activeExtensions
          )
        
        :
          void

static

Returns the provided array reordered with loading order information taken into account.

Parameters

Name	Type	Description
$activeExtensions	array	Array of extensions.

Details

See: \activeExtensions

findExtensionType(
           $parameters,  $out
          )
        
        :
          void

static

Parameters

Name	Type	Description
$parameters
$out

getHandlerClass(
           $options
          )
        
        :
          null | false | object

static

Returns the correct handler defined in $iniFile configuration file A correct class name for the handler needs to be specified in the ini settings, and the class needs to be present for the autoload system.

Parameters

Name	Type	Description
$options

Returns

Type	Description
null \| false \| object	Returns a valid handler object, null if setting did not exists and false if no handler was found

Details

Static

isExtension(
           $path
          )
        
        :
          void

static

Parameters

Name	Type	Description
$path

nameFromPath(
           $path
          )
        
        :
          void

static

Parameters

Name	Type	Description
$path

prependExtensionSiteAccesses(
          string | false $accessName
              =
              false, \eZINI | false | null $ini
              =
              false, true $globalDir
              =
              true, string | false | null $identifier
              =
              null, bool $order
              =
              true
          )
        
        :
          void

static

Prepend extension siteaccesses

Parameters

Name	Type	Description
$accessName	string \| false	Optional access name, will use global if false
$ini	\eZINI \| false \| null
$globalDir	true
$identifier	string \| false \| null	See {@link eZExtension::prependSiteAccess()}
$order	bool	Prepend extensions in reverse order by setting this to false

prependSiteAccess(
          string $extension, string | false $accessName
              =
              false, \eZINI | false | null $ini
              =
              false, true $globalDir
              =
              true, string | false | null $identifier
              =
              null
          )
        
        :
          void

static

Prepend siteaccess for specified extension

Parameters

Name	Type	Description
$extension	string	Name of extension (folder name)
$accessName	string \| false	Optional access name, will use global if false
$ini	\eZINI \| false \| null
$globalDir	true
$identifier	string \| false \| null	By setting to string "siteaccess" only one location is supported (identifier makes eZINI overwrite earlier prepends with same key) null(default) means "ext-siteaccess:$extension" is used to only have one pr extension

lib/ezutils/classes/ezextension.php

\eZExtensionjump to top

Constants

Properties

Methods

\eZExtension
jump to top