Docs For Class XT

$buildToc = false

[line 295]

Determines whether the template should build a table of contents (TOC) based on HTML header tags found within.

Defaults to false, and must be set to true in order to generate TOCs.

Tags:

access:

public

Type:

mixed

[ Top ]

$file = false

[line 354]

Contains the name of the file currently being processed.

This is set in the getDoc() method, so technically it will set the current file even when you're just retrieving its contents. This shouldn't affect its validity for most uses, but when you want to retrieve the last parsed file, it means you have to do so prior to calling getDoc() again, either directly or indirectly.

constructor XT [line 429]

XT XT(
[string
$path = ''], [string
$prefix = XT_DEFAULT_PREFIX])

Constructor method. $prefix is either XT_DEFAULT_PREFIX,

XT_POST_PREFIX, or a custom prefix. The prefix is essentially the XML namespace XT is to recognize. The use of multiple namespaces can allow you to partially parse a template, cache that, then parse the rest which might contain user-specific content such as personal information. XT_DEFAULT_PREFIX and XT_POST_PREFIX are constants defined by this package.

Tags:

access:

public

Parameters:

string	$path
string	$prefix

[ Top ]

method bind [line 795]

void bind(
string
$path, string
$data)

Bind some content to the specified tag.

Tags:

access:

public

Parameters:

string	$path
string	$data

[ Top ]

method bindAttr [line 815]

void bindAttr(
string
$path, string
$attr, string
$value)

Bind an attribute to the specified tag.

Tags:

access:

public

Parameters:

string	$path
string	$attr
string	$value

[ Top ]

method box [line 870]

string box(
string
$name, [associative
$parameters = array ()])

Executes the specified box using the Sitellite box API, which is essentially just an include. Note: This is now an alias for the loader_box() function.

Tags:

access:

public

Parameters:

string	$name
associative	$parameters	array $parameters

[ Top ]

method convertEntities [line 1082]

string convertEntities(
string
$data)

Converts HTML entities into XT-compatible ch:entity tags.

method fill [line 567]

string fill(
string
$data, [object
$obj = ''], [boolean
$carry = false])

Executes a template. $obj is an optional object you can pass to the template, which makes its properties immediately available to the template. $carry is used internally to determine whether to reset the object register before executing.

Tags:

access:

public

Parameters:

string	$data
object	$obj
boolean	$carry

[ Top ]

method form [line 893]

string form(
string
$name)

Executes the specified form using the Sitellite form API, which is essentially just an include of a file that defines a subclass of saf.MailForm. Note: This is now an alias for the loader_form() function.

method ignoreUntilLevel [line 492]

void ignoreUntilLevel(
[mixed
$level = false])

[ Top ]

method makeToc [line 1894]

string makeToc(
[string
$title = ''])

Generates a table of contents as an HTML unordered list, based on the $toc property. Note: Also requires $buildToc to be set to true.

method messy [line 840]

string messy(
string
$data, [object
$obj = ''], [boolean
$carry = false])

Uses the saf.HTML.Messy package to implement a "messy" parser in XT, allowing for invalid markup in templates (ie.

HTML instead of XHTML). Of course since the markup accepted is invalid, your mileage may vary. This method is discouraged unless you have a good reason for using it.

Tags:

access:

public

Parameters:

string	$data
object	$obj
boolean	$carry

[ Top ]

method path [line 484]

string path(
)

Returns either the contents of the $path property, or the current working directory, which should be used as the path instead.

Tags:

access:

public

[ Top ]

method reverseEntities [line 1060]

string reverseEntities(
string
$data)

Reverses the conversion of HTML entities to XT-compatible ch:entity tags.

method validate [line 516]

boolean validate(
string
$data)

Validates a template to see if it is a valid XML document.

method wrap [line 998]

string wrap(
string
$str)

Wraps $str in xt:tpl tags and returns it.

Packages

Classes

Files

Class: XT

Class Overview

Variables

Methods

Child Classes

Inherited Variables

Inherited Methods

Class Details

Class Variables

$buildToc = false

Tags:

$cacheCount = 0

Tags:

$cacheDuration = 3600

Tags:

$cacheLocation = 'store:cache/templates/'

Tags:

$error =

Tags:

$err_byte =

Tags:

$err_code =

Tags:

$err_colnum =

Tags:

$err_line =

Tags:

$exp =

Tags:

$file = false

Tags:

$isHtml = true

Tags:

$output = ''

Tags:

$path = ''

Tags:

$prefix = 'xt:'

Tags:

$selfClosing = array ( 'img', 'br', 'hr', 'meta', 'link', 'area', )

Tags:

$toc = array ()

Tags:

$_addToHeader = false

$_bind_attrs = array ()

$_bind_list = array ()

$_bind_parts = array ()

Class Methods

constructor XT [line 429]

Tags:

Parameters:

method bind [line 795]

Tags:

Parameters:

method bindAttr [line 815]

Tags:

Parameters:

method box [line 870]

Tags:

Parameters:

method convertEntities [line 1082]

Tags:

Parameters:

method fill [line 567]

Tags:

Parameters:

method form [line 893]

Tags:

Parameters:

method ignoreUntilLevel [line 492]

method makeToc [line 1894]

Tags:

Parameters:

method messy [line 840]

Tags:

Parameters:

method path [line 484]

$selfClosing = array (
'img',
'br',
'hr',
'meta',
'link',
'area',
)