[ Index ]
 

Code source de LifeType 1.2.4

Accédez au Source d'autres logiciels libres

Classes | Fonctions | Variables | Constantes | Tables

title

Body

[fermer]

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

(pas de description)

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

Définit 1 class

TemplateSetStorage:: (20 méthodes):
  TemplateSetStorage()
  getTemplateFolder()
  getBaseTemplateFolder()
  getBlogBaseTemplateFolder()
  _removeFolder()
  _removeTemplateFromArray()
  removeGlobalTemplate()
  removeBlogTemplate()
  removeTemplate()
  addTemplate()
  addGlobalTemplate()
  addLocalTemplate()
  createBlogTemplateFolder()
  templateExists()
  getAdminTemplateFolder()
  getPluginTemplateFolder()
  isScreenshotAvailable()
  getScreenshotUrl()
  getNoScreenshotUrl()
  getMiscTemplateFolder()


Classe: TemplateSetStorage  - X-Ref

\ingroup Template

deals with template sets files in disk. The relation between this class,
TemplateService and TemplateSets 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.

Class and API users should not need to use this class directly.
TemplateSetStorage()   X-Ref
Constructor


getTemplateFolder( $templateName, $blogId = 0 )   X-Ref
Returns the path to where the given template should be. If blogId == 0,
then the template will be considered global or else it will be considered
as a custom template for the given blog.

return: Returns a string with the path to the folder.

getBaseTemplateFolder()   X-Ref
returns the base folder where templates are stored (templates/) by default

return: The folder where templates are stored, according to our configuration

getBlogBaseTemplateFolder( $blogId )   X-Ref
returns the path where the given blog is storing its local templates

param: blogId the id of the blog
return: The template in disk where templates are being stored

_removeFolder( $folderName )   X-Ref
Recursively removes a folder from disk.

return: True if successful or false otherwise.

_removeTemplateFromArray( $array, $key )   X-Ref


removeGlobalTemplate( $templateName )   X-Ref
Removes a global template

param: templateName The name of the template that we'd like to remove

removeBlogTemplate( $templateName, $blogId )   X-Ref
Removes a blog specific template.

param: templateName The name of the blog-specific template that we'd like to remove
param: blogId The id of the blog whose blog we'd like to remove
return: true if sucessful or false otherwise

removeTemplate( $templateName, $blogId = 0 )   X-Ref
Removes a template from the templates folder. If blogId == 0, then we will
look for it as a global template, or else we will look for the template
in the folder of the blog.

param: templateName
param: blogId
return: Returns true if removed successfully or false otherwise.

addTemplate( $templateName, $blogId = 0 )   X-Ref
Adds a new template. If the template already exists, it is not
added again.

param: templateName The name of the template we'd like to add
param: blogId The identifier of the blog to which we'd like to add
return: Returns true if ok or false otherwise.

addGlobalTemplate( $templateName )   X-Ref
Adds a global template to the site.

param: templateName Name of the template we'd like to add
return: Returns true if successful or false otherwise.

addLocalTemplate( $templateName, $blogId )   X-Ref
Adds a local template to the given blog.

param: templateName Name that the template will use
param: blogId the identifier of the blog to which we're going to install
return: True if successful or false otherwise.

createBlogTemplateFolder( $blogId )   X-Ref
Creates the blog-specific folder where templates are stored.
If the folder is not there, it will be created. If it is already there,
then nothing will happen.

param: blogId The identifier of the blog.

templateExists( $fileName, $templateSet )   X-Ref
returns true if the given template file exists in the given template set, or false
if not.

param: fileName The name of the file, without the .template extension
param: templateSet name of the template set.
return: Returns true if file exists and is readable, or false otherwise.

getAdminTemplateFolder()   X-Ref
returns the path where the admin templates are stored

return: a path

getPluginTemplateFolder( $pluginId )   X-Ref
returns the folder where the templates used by a plugin
are stored

return: At path

isScreenshotAvailable( $templateName, $blogId = 0 )   X-Ref
returns true if the template set has a screenshot available in disk

param: templateName The name of the template
param: blogId If the template is blog specific, then the blog id and if it is global, then

getScreenshotUrl( $templateName, $blogId = 0)   X-Ref
returns the path to the blog screenshot

param: templateName
param: blogId
return: The http path to the screenshot file or empty if not available

getNoScreenshotUrl()   X-Ref
returns a default picture for those occasions when there is no screenshot
available for the template

return: a url

getMiscTemplateFolder()   X-Ref
returns the path to the 'templates/misc/' folder

return: path



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