[ Index ]

PHP Cross Reference of vtigercrm-6.1.0

title

Body

[close]

/libraries/Smarty/libs/sysplugins/ -> smarty_resource.php (summary)

Smarty Resource Plugin

Author: Rodney Rehm
File Size: 822 lines (27 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 2 classes

Smarty_Template_Source:: (5 methods):
  __construct()
  getCompiled()
  renderUncompiled()
  __set()
  __get()

Smarty_Template_Compiled:: (1 method):
  __construct()

Defines 1 function

  populateTimestamp()
  buildUniqueResourceName()
  populateCompiledFilepath()
  buildFilepath()
  fileExists()
  getBasename()
  load()
  parseResourceName()
  getUniqueTemplateName()
  source()
  config()

Class: Smarty_Template_Source  - X-Ref

Smarty Resource Data Object

Meta Data Container for Template Files

__construct(Smarty_Resource $handler, Smarty $smarty, $resource, $type, $name, $unique_resource)   X-Ref
create Source Object container

param: Smarty_Resource $handler          Resource Handler this source object communicates with
param: Smarty          $smarty           Smarty instance this source object belongs to
param: string          $resource         full template_resource
param: string          $type             type of resource
param: string          $name             resource name
param: string          $unique_resource  unqiue resource name

getCompiled(Smarty_Internal_Template $_template)   X-Ref
get a Compiled Object of this source

param: Smarty_Internal_Template $_template template objet
return: Smarty_Template_Compiled compiled object

renderUncompiled(Smarty_Internal_Template $_template)   X-Ref
render the uncompiled source

param: Smarty_Internal_Template $_template template object

__set($property_name, $value)   X-Ref
<<magic>> Generic Setter.

param: string $property_name valid: timestamp, exists, content, template
param: mixed  $value        new value (is not checked)

__get($property_name)   X-Ref
<<magic>> Generic getter.

param: string $property_name valid: timestamp, exists, content
return: mixed

Class: Smarty_Template_Compiled  - X-Ref

Smarty Resource Data Object

Meta Data Container for Template Files

__construct(Smarty_Template_Source $source)   X-Ref
create Compiled Object container

param: Smarty_Template_Source $source source object this compiled object belongs to

Functions
Functions that are not part of a class:

populateTimestamp(Smarty_Template_Source $source)   X-Ref
populate Source Object with timestamp and exists from Resource

param: Smarty_Template_Source $source source object

buildUniqueResourceName(Smarty $smarty, $resource_name)   X-Ref
modify resource_name according to resource handlers specifications

param: Smarty $smarty        Smarty instance
param: string $resource_name resource_name to make unique
return: string unique resource name

populateCompiledFilepath(Smarty_Template_Compiled $compiled, Smarty_Internal_Template $_template)   X-Ref
populate Compiled Object with compiled filepath

param: Smarty_Template_Compiled $compiled  compiled object
param: Smarty_Internal_Template $_template template object

buildFilepath(Smarty_Template_Source $source, Smarty_Internal_Template $_template=null)   X-Ref
build template filepath by traversing the template_dir array

param: Smarty_Template_Source   $source    source object
param: Smarty_Internal_Template $_template template object
return: string fully qualified filepath

fileExists(Smarty_Template_Source $source, $file)   X-Ref
test is file exists and save timestamp

param: Smarty_Template_Source   $source    source object
param: string $file file name
return: bool  true if file exists

getBasename(Smarty_Template_Source $source)   X-Ref
Determine basename for compiled filename

param: Smarty_Template_Source $source source object
return: string resource's basename

load(Smarty $smarty, $type)   X-Ref
Load Resource Handler

param: Smarty $smarty    smarty object
param: string $type      name of the resource
return: Smarty_Resource Resource Handler

parseResourceName($resource_name, $default_resource, &$name, &$type)   X-Ref
extract resource_type and resource_name from template_resource and config_resource

param: string  $resource_name    template_resource or config_resource to parse
param: string  $default_resource the default resource_type defined in $smarty
param: string &$name             the parsed resource name
param: string &$type             the parsed resource type
return: void

getUniqueTemplateName($smarty, $template_resource)   X-Ref
modify template_resource according to resource handlers specifications

param: string $smarty            Smarty instance
param: string $template_resource template_resource to extracate resource handler and name of
return: string unique resource name

source(Smarty_Internal_Template $_template=null, Smarty $smarty=null, $template_resource=null)   X-Ref
initialize Source Object for given resource

Either [$_template] or [$smarty, $template_resource] must be specified

param: Smarty_Internal_Template $_template         template object
param: Smarty                   $smarty            smarty object
param: string                   $template_resource resource identifier
return: Smarty_Template_Source Source Object

config(Smarty_Internal_Config $_config)   X-Ref
initialize Config Source Object for given resource

param: Smarty_Internal_Config $_config config object
return: Smarty_Config_Source Source Object



Generated: Fri Nov 28 20:08:37 2014 Cross-referenced by PHPXref 0.7.1