PHP Класс Capsule, symfony-1.4

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$vars The variables that can be used by the templates.

Защищенные свойства (Protected)

Свойство Тип Описание
$initialized Has template been initialized.
$outputDirectory string Where should output files be written? (This is named inconsistently to be compatible w/ Texen.)
$templatePath string Look for templates here (if relative path provided).

Открытые методы

Метод Описание
__construct ( )
clear ( mixed $which = null ) : void Clears one or several or all variables.
display ( string $__template ) : void Low overhead (no output buffering) method to simply dump template to buffer.
get ( string $name ) : mixed Gets value of specified var or NULL if var has not been put().
getOutputDirectory ( ) : string Get basepath to use for output file creation.
getTemplatePath ( ) : string Get the basepath to use for template lookups.
parse ( string $template, string $outputFile = null, boolean $append = false ) : string Fetches the results of a tempalte parse and either returns the string or writes results to a specified output file.
put ( string $name, mixed $value ) Adds a variable to the context.
putAll ( array $vars, boolean $recursiveMerge = false ) : void Merges in passed hash to vars array.
putCopy ( string $name, mixed $value ) Makes a copy of the value and puts it into the context.
putRef ( $name, &$value ) Put a variable into the context, assigning it by reference.
setOutputDirectory ( string $v ) Set a basepath to use for output file creation.
setTemplatePath ( string $v ) Set the basepath to use for template lookups.

Защищенные методы

Метод Описание
resolvePath ( string $file, string $basepath ) : string This returns a "best guess" path for the given file.

Описание методов

__construct() публичный Метод

public __construct ( )

clear() публичный Метод

Clears one or several or all variables.
public clear ( mixed $which = null ) : void
$which mixed String name of var, or array of names.
Результат void

display() публичный Метод

Low overhead (no output buffering) method to simply dump template to buffer.
public display ( string $__template ) : void
$__template string
Результат void

get() публичный Метод

Gets value of specified var or NULL if var has not been put().
public get ( string $name ) : mixed
$name string Variable name to retrieve.
Результат mixed

getOutputDirectory() публичный Метод

Get basepath to use for output file creation.
public getOutputDirectory ( ) : string
Результат string

getTemplatePath() публичный Метод

Get the basepath to use for template lookups.
public getTemplatePath ( ) : string
Результат string

parse() публичный Метод

Fetches the results of a tempalte parse and either returns the string or writes results to a specified output file.
public parse ( string $template, string $outputFile = null, boolean $append = false ) : string
$template string The template filename (relative to templatePath or absolute).
$outputFile string If specified, contents of template will also be written to this file.
$append boolean Should output be appended to source file?
Результат string The "parsed" template output.

put() публичный Метод

Resulting template will have access to ${$name$} variable.
public put ( string $name, mixed $value )
$name string
$value mixed

putAll() публичный Метод

Given an array like: array( 'myvar' => 'Hello', 'myvar2' => 'Hello') Resulting template will have access to $myvar and $myvar2.
public putAll ( array $vars, boolean $recursiveMerge = false ) : void
$vars array
$recursiveMerge boolean Should matching keys be recursively merged?
Результат void

putCopy() публичный Метод

This is primarily to force copying (cloning) of objects, rather than the default behavior which is to assign them by reference.
public putCopy ( string $name, mixed $value )
$name string
$value mixed

putRef() публичный Метод

This means that if the template modifies the variable, then it will also be modified in the context.
public putRef ( $name, &$value )
$name

resolvePath() защищенный Метод

This returns a "best guess" path for the given file.
protected resolvePath ( string $file, string $basepath ) : string
$file string File name or possibly absolute path.
$basepath string The basepath that should be prepended if $file is not absolute.
Результат string "Best guess" path for this file.

setOutputDirectory() публичный Метод

Set a basepath to use for output file creation.
public setOutputDirectory ( string $v )
$v string

setTemplatePath() публичный Метод

Set the basepath to use for template lookups.
public setTemplatePath ( string $v )
$v string

Описание свойств

$initialized защищенное свойство

Has template been initialized.
protected $initialized

$outputDirectory защищенное свойство

Where should output files be written? (This is named inconsistently to be compatible w/ Texen.)
protected string $outputDirectory
Результат string

$templatePath защищенное свойство

Look for templates here (if relative path provided).
protected string $templatePath
Результат string

$vars публичное свойство

The variables that can be used by the templates.
public $vars