eZPublish  3.8
eZTemplateDesignResource Class Reference
+ Inheritance diagram for eZTemplateDesignResource:
+ Collaboration diagram for eZTemplateDesignResource:

Public Member Functions

 clearKeys ()
 
 createOverrideCache ()
 
 eZTemplateDesignResource ($name="design", $onlyStandard=false)
 
 fileMatchingRules ($element, $path, $onlyStandard=false)
 
 handleResource (&$tpl, &$resourceData, $method, &$extraParameters)
 
instance ()
 
keys ()
 
 removeKey ($key)
 
 setDesignSetting ($designSetting, $type= 'standard')
 
 setKeys ($keys)
 
 setOverrideAccess ($siteAccess)
 
standardInstance ()
 
 templateNodeTransformation ($functionName, &$node, &$tpl, &$resourceData, $parameters, $namespaceValue)
 
- Public Member Functions inherited from eZTemplateFileResource
 cachedTemplateTree ($keyData, $uri, $res, $templatePath, &$extraParameters, $timestamp)
 
 cacheKey ($keyData, $res, $templatePath, &$extraParameters)
 
 canCompileTemplate (&$tpl, &$resourceData, &$extraParameters)
 
 compileTemplate (&$tpl, $keyData, $uri, $res, $templatePath, &$extraParameters, &$resourceData)
 
 executeCompiledTemplate (&$tpl, &$textElements, $keyData, $uri, $resourceData, $templatePath, &$extraParameters, $timestamp, $rootNamespace, $currentNamespace)
 
 eZTemplateFileResource ($name="file", $servesStaticData=true)
 
 handleResource (&$tpl, &$resourceData, $method, &$extraParameters)
 
 hasCachedProcessTree ($keyData, $uri, $res, $templatePath, &$extraParameters, $timestamp)
 
 hasCompiledTemplate ($keyData, $uri, &$resourceData, $templatePath, &$extraParameters, $timestamp)
 
 resourceName ()
 
 servesStaticData ()
 
 setCachedTemplateTree ($keyData, $uri, $res, $templatePath, &$extraParameters, &$root)
 
 templateNodeTransformation ($functionName, &$node, &$tpl, &$resourceData, $parameters, $namespaceValue)
 

Static Public Member Functions

 addGlobalOverride ($name, $source, $match, $subdir, $matches)
 
 allDesignBases ()
 
 designSetting ($type= 'standard')
 
 designStartPath ()
 
 overrideArray ($siteAccess=false, $onlyStandard=null)
 
 overrideKeys ($siteAccess=false)
 
 serializeOverrides ($siteAccess=false, $matchKeys=array())
 
 setDesignStartPath ($path)
 
- Static Public Member Functions inherited from eZTemplateFileResource
 handleResourceData (&$tpl, &$handler, &$resourceData, $method, &$extraParameters)
 

Public Attributes

 $Keys
 
 $OnlyStandard
 
 $OverrideSiteAccess = false
 

Private Member Functions

 mergeKeys (&$originalKeys, $keys)
 

Member Function Documentation

eZTemplateDesignResource::addGlobalOverride (   $name,
  $source,
  $match,
  $subdir,
  $matches 
)
static
eZTemplateDesignResource::allDesignBases ( )
static
Returns
Gives all knows bases for avialable sitedesign folders.

Referenced by eZURLOperator\modify(), and eZURLOperator\urlTransformation().

eZTemplateDesignResource::clearKeys ( )

Removes all override keys.

See Also
setKeys
eZTemplateDesignResource::createOverrideCache ( )

Generates the cache for the template override matching.

Referenced by handleResource().

eZTemplateDesignResource::designSetting (   $type = 'standard')
static
Returns
the sitedesign for the design type $type, currently standard and site is allowed. If no sitedesign is set it will fetch it from site.ini.

Referenced by allDesignBases(), createOverrideCache(), fileMatchingRules(), eZTemplatesStatisticsReporter\generateStatistics(), eZURLOperator\modify(), overrideArray(), overrideKeys(), and eZURLOperator\urlTransformation().

eZTemplateDesignResource::designStartPath ( )
static
Returns
The start path of the design directory, by default it will return 'design' To change the directory use setDesignStartPath().

Referenced by allDesignBases(), fileMatchingRules(), eZContentObjectPackageHandler\installTemplates(), overrideArray(), and overrideKeys().

eZTemplateDesignResource::eZTemplateDesignResource (   $name = "design",
  $onlyStandard = false 
)

Initializes with a default resource name "design".

Referenced by instance(), and standardInstance().

eZTemplateDesignResource::fileMatchingRules (   $element,
  $path,
  $onlyStandard = false 
)
Returns
the rules used for matching design elements. $element defines the element type.

Referenced by eZURLOperator\modify(), and eZURLOperator\urlTransformation().

eZTemplateDesignResource::handleResource ( $tpl,
$resourceData,
  $method,
$extraParameters 
)

Loads the template file if it exists, also sets the modification timestamp. Returns true if the file exists.

& eZTemplateDesignResource::keys ( )
Returns
the match keys.
See Also
setKeys
eZTemplateDesignResource::mergeKeys ( $originalKeys,
  $keys 
)
private

Merges keys set in $keys with the array in $originalKeys.

Referenced by handleResource(), and setKeys().

eZTemplateDesignResource::overrideArray (   $siteAccess = false,
  $onlyStandard = null 
)
static
eZTemplateDesignResource::overrideKeys (   $siteAccess = false)
static
Returns
an array with keys that define the current override.

Referenced by createOverrideCache().

eZTemplateDesignResource::removeKey (   $key)

Removes the given key

eZTemplateDesignResource::serializeOverrides (   $siteAccess = false,
  $matchKeys = array() 
)
static
eZTemplateDesignResource::setDesignSetting (   $designSetting,
  $type = 'standard' 
)

Sets the sitedesign for the design type $type, currently standard and site is allowed. The design is set to $designSetting.

eZTemplateDesignResource::setDesignStartPath (   $path)
static

Changes the design start path which is used to find design files.

Parameters
$pathMust be a string defining the path or false to use default start path.
See Also
designStartPath();
eZTemplateDesignResource::setKeys (   $keys)

Sets the override keys to $keys, if some of the keys already exists they are overriden by the new keys.

See Also
clearKeys
eZTemplateDesignResource::setOverrideAccess (   $siteAccess)

Sets the siteaccess which are to be used for loading the override settings.

& eZTemplateDesignResource::standardInstance ( )
Returns
the unique instance of the standard resource.

Referenced by templateInit().

eZTemplateDesignResource::templateNodeTransformation (   $functionName,
$node,
$tpl,
$resourceData,
  $parameters,
  $namespaceValue 
)

Member Data Documentation

eZTemplateDesignResource::$Keys

Referenced by handleResource(), and keys().

eZTemplateDesignResource::$OnlyStandard

Referenced by overrideArray().

eZTemplateDesignResource::$OverrideSiteAccess = false

Referenced by handleResource().


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