kernel/common/eztemplatedesignresource.php

Show:

inherited

Classes
- \eZTemplateDesignResource

Table of Contents

File containing the eZTemplateDesignResource class.

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

\eZTemplateDesignResource
jump to top

Package: kernel

File containing the eZTemplateDesignResource class.

Parent(s): \eZTemplateFileResource
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

 
                DESIGN_BASE_CACHE_NAME
                = 'designbase_'

Properties


                 $Keys= ''

Details

Type: n/a


                 $Name= ''

inheritedInherited from: \eZTemplateFileResource::$$Name

Details

Type: n/a
Inherited_from: \eZTemplateFileResource::$$Name


                 $OverrideSiteAccess= 'false'

Default valuefalseDetails

Type: n/a


                 $ServesStaticData= ''

inheritedInherited from: \eZTemplateFileResource::$$ServesStaticData

Details

Type: n/a
Inherited_from: \eZTemplateFileResource::$$ServesStaticData


                 $TemplateCache= ''

inheritedInherited from: \eZTemplateFileResource::$$TemplateCache

Details

Type: n/a
Inherited_from: \eZTemplateFileResource::$$TemplateCache

\$overrideArrayCache
                 $overrideArrayCache= 'null'

static

Contains in memory cache of override array used by {@link eZTemplateDesignResource::overrideArray()}

null|array

Default valuenullDetails

Type: \$overrideArrayCache
Protected
Static

Methods

addGlobalOverride(
           $name,  $source,  $match,  $subdir,  $matches
          )
        
        :
          void

static

Parameters

Name	Type	Description
$name
$source
$match
$subdir
$matches

allDesignBases(
           $siteAccess
              =
              false
          )
        
        :
          void

static

Parameters

Name	Type	Description
$siteAccess

cacheKey(
           $keyData,  $res,  $templatePath,  $extraParameters
          )
        
        :
          void

inherited

Inherited from: \eZTemplateFileResource::cacheKey()

Parameters

Name	Type	Description
$keyData
$res
$templatePath
$extraParameters

cachedTemplateTree(
           $keyData,  $uri,  $res,  $templatePath,  $extraParameters,  $timestamp
          )
        
        :
          void

inherited

Inherited from: \eZTemplateFileResource::cachedTemplateTree()

Parameters

Name	Type	Description
$keyData
$uri
$res
$templatePath
$extraParameters
$timestamp

canCompileTemplate(
           $tpl,  $resourceData,  $extraParameters
          )
        
        :
          void

inherited

Inherited from: \eZTemplateFileResource::canCompileTemplate()

Parameters

Name	Type	Description
$tpl
$resourceData
$extraParameters

clearInMemoryCache(
          
          )
        
        :
          void

static

Clear in memory cache (design settings and override cache)

Details

Since: 4.4
Static

clearInMemoryOverrideArray(
          
          )
        
        :
          void

static

Clear in memory override array cache

Details

Since: 4.2
Static

clearKeys(
          
          )
        
        :
          void

compileTemplate(
           $tpl,  $keyData,  $uri,  $res,  $templatePath,  $extraParameters,  $resourceData
          )
        
        :
          void

inherited

Inherited from: \eZTemplateFileResource::compileTemplate()

Parameters

Name	Type	Description
$tpl
$keyData
$uri
$res
$templatePath
$extraParameters
$resourceData

createOverrideCache(
          
          )
        
        :
          void

designExtensions(
          
          )
        
        :
          void

static

designSetting(
           $type
              =
              'standard'
          )
        
        :
          void

static

Parameters

Name	Type	Description
$type

designStartPath(
          
          )
        
        :
          void

static

eZTemplateDesignResource(
           $name
              =
              "design"
          )
        
        :
          void

Parameters

Name	Type	Description
$name

eZTemplateFileResource(
           $name
              =
              "file",  $servesStaticData
              =
              true
          )
        
        :
          void

inherited

Inherited from: \eZTemplateFileResource::eZTemplateFileResource()

Parameters

Name	Type	Description
$name
$servesStaticData

executeCompiledTemplate(
           $tpl,  $textElements,  $keyData,  $uri,  $resourceData,  $templatePath,  $extraParameters,  $timestamp,  $rootNamespace,  $currentNamespace
          )
        
        :
          void

inherited

Inherited from: \eZTemplateFileResource::executeCompiledTemplate()

Parameters

Name	Type	Description
$tpl
$textElements
$keyData
$uri
$resourceData
$templatePath
$extraParameters
$timestamp
$rootNamespace
$currentNamespace

fileMatch(
           $bases,  $element,  $path,  $triedFiles
          )
        
        :
          void

static

Parameters

Name	Type	Description
$bases
$element
$path
$triedFiles

findDesignBase(
          \$ini $ini, \$siteAccess $siteAccess
              =
              false
          )
        
        :
          array

static

Find the location on design bases on the disk

Parameters

Name	Type	Description
$ini	\$ini	an eZINI object
$siteAccess	\$siteAccess	Wether to use siteaccesses or not

Returns

Type	Description
array	The list of design bases

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

Parameters

Name	Type	Description
$tpl
$resourceData
$method
$extraParameters

handleResourceData(
           $tpl,  $handler,  $resourceData,  $method,  $extraParameters
          )
        
        :
          void

inherited

Inherited from: \eZTemplateFileResource::handleResourceData()

Parameters

Name	Type	Description
$tpl
$handler
$resourceData
$method
$extraParameters

hasCachedProcessTree(
           $keyData,  $uri,  $res,  $templatePath,  $extraParameters,  $timestamp
          )
        
        :
          void

inherited

Inherited from: \eZTemplateFileResource::hasCachedProcessTree()

Parameters

Name	Type	Description
$keyData
$uri
$res
$templatePath
$extraParameters
$timestamp

hasCompiledTemplate(
           $keyData,  $uri,  $resourceData,  $templatePath,  $extraParameters,  $timestamp
          )
        
        :
          void

inherited

Inherited from: \eZTemplateFileResource::hasCompiledTemplate()

Parameters

Name	Type	Description
$keyData
$uri
$resourceData
$templatePath
$extraParameters
$timestamp

instance(
          
          )
        
        :
          \eZTemplateDesignResource

static

Returns a shared instance of the eZTemplateDesignResource class.

Returns

Type	Description
\eZTemplateDesignResource

mergeKeys(
           $originalKeys,  $keys
          )
        
        :
          void

Parameters

Name	Type	Description
$originalKeys
$keys

overrideArray(
           $siteAccess
              =
              false
          )
        
        :
          array

static

Get an array of all the current templates and overrides for them.

The current siteaccess is used if none is specified.

Parameters

Name	Type	Description
$siteAccess

Returns

Type	Description
array

Details

Static

overrideKeys(
           $siteAccess
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$siteAccess

removeKey(
           $key
          )
        
        :
          void

Parameters

Name	Type	Description
$key

resourceName(
          
          )
        
        :
          void

inherited

Inherited from: \eZTemplateFileResource::resourceName()

savesMemoryCache(
          \$designBaseList $designBaseList, \$siteAccess $siteAccess
              =
              false
          )
        
        :
          void

static

Stores design base list in memory for the current request

Parameters

Name	Type	Description
$designBaseList	\$designBaseList	An array with the design bases
$siteAccess	\$siteAccess	Whether to use siteaccess or not

serializeOverrides(
           $siteAccess
              =
              false,  $matchKeys
              =
              array()
          )
        
        :
          void

static

Parameters

Name	Type	Description
$siteAccess
$matchKeys

servesStaticData(
          
          )
        
        :
          void

inherited

Inherited from: \eZTemplateFileResource::servesStaticData()

setCachedTemplateTree(
           $keyData,  $uri,  $res,  $templatePath,  $extraParameters,  $root
          )
        
        :
          void

inherited

Inherited from: \eZTemplateFileResource::setCachedTemplateTree()

Parameters

Name	Type	Description
$keyData
$uri
$res
$templatePath
$extraParameters
$root

setDesignSetting(
           $designSetting,  $type
              =
              'standard'
          )
        
        :
          void

Parameters

Name	Type	Description
$designSetting
$type

setDesignStartPath(
           $path
          )
        
        :
          void

static

Parameters

Name	Type	Description
$path

setKeys(
           $keys
          )
        
        :
          void

Parameters

Name	Type	Description
$keys

setOverrideAccess(
           $siteAccess
          )
        
        :
          void

Parameters

Name	Type	Description
$siteAccess

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

Parameters

Name	Type	Description
$functionName
$node
$tpl
$resourceData
$parameters
$namespaceValue

kernel/common/eztemplatedesignresource.php

\eZTemplateDesignResourcejump to top

Constants

Properties

Methods

\eZTemplateDesignResource
jump to top