LifeType 1.2.4 : Vue détaillée de templatesets.class.php

(pas de description)

Poids:	210 lignes (7 kb)
Inclus ou requis:	0 fois
Référencé:	15 fois
Nécessite:	0 fichiers

Définit 1 class

TemplateSets:: (10 méthodes):
  TemplateSets()
  getBlogTemplateSets()
  getGlobalTemplateSets()
  getGlobalTemplates()
  getBlogTemplates()
  getAllTemplates()
  getTemplateSet()
  isTemplate()
  isBlogTemplate()
  getDefaultTemplateSet()

Classe: TemplateSets - X-Ref

\ingroup Template

Takes care of retrieving information about template sets. By using this class
we can know which template sets are globally available, or which blog-specific templates
a blog has.

The relation between this class, TemplateService and TemplateSetStorage is that TemplateService
takes care of generating the right object (CachedTemplate, PluginTemplate, Template) when
needed for rendering template pages. TemplateSets deals with the logical information (does it have an
screenshot? Is it a local template?) and TemplateStorage deals with adding
templates, removing them from disk, etc.

TemplateSets() X-Ref

Pas de description

getBlogTemplateSets( $blogId, $includeGlobal = true ) X-Ref

Returns all the template sets that are available for a given blog, including global
templates by default.

param: blogId The id of the blog
param: includeGlobal Whether global templates should be included, or else only
return: An array of TemplateSet objects

getGlobalTemplateSets() X-Ref

Returns all the global template sets that are available to all blogs

return: returns an array of TemplateSet objects with all the global templates

getGlobalTemplates() X-Ref

Returns an array that contains the name of all the 'global' templates
available.

return: Returns an array of strings with the name of the template sets

getBlogTemplates( $blogId ) X-Ref

Returns a list with all the custom templates available *only*
to this blog.

return: An array of string containing the identifiers of the template

getAllTemplates( $blogId ) X-Ref

Returns an array with all the global templates and the custom ones
from the given blog.

return: Array

getTemplateSet( $templateName, $blogId = 0 ) X-Ref

Returns a TemplateSet object with information about the template. If there are a local
template and a global template with the same template id, the global template will <b>ALWAYS</b>
have more priority!

param: templateName the name of the template
param: blogId 0 if the template is global or the blog id otherwise
return: a TemplateSet object, or 'null' if the template does not exist at all

isTemplate( $templateName ) X-Ref

Returns true if the template is a valid global template set, or false otherwise.

param: templateName The name of the template.

isBlogTemplate( $templateName, $blogId ) X-Ref

Returns true if the template is a valid blog template set, or false otherwise.

param: templateName The name of the template.
param: blogId The identifier of the blog we'd like to check

getDefaultTemplateSet() X-Ref

returns the default template set that has been configured in this site

return: A TemplateSet object

Code source de LifeType 1.2.4

/class/template/templatesets/ -> templatesets.class.php (sommaire)

Définit 1 class

Généré le : Mon Nov 26 21:04:15 2007	par Balluche grâce à PHPXref 0.7