API Documentation

Markup/Token.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Markup
subpackage
Parser
version
$Id: Token.php 20277 2010-01-14 14:17:12Z kokx $
Classes
Zend_Markup_Token

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Markup_Token
jump to top

category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Markup
Constants
TYPE_NONE
TYPE_TAG
Properties
$_children
$_tag
$_type
$_name
$_attributes
$_stopper
$_parent
Methods
__construct
setStopper
getStopper
getName
getType
getTag
getAttribute
hasAttribute
getAttributes
addAttribute
attributeIsEmpty
addChild
setChildren
getChildren
hasChildren
getParent
setParent
__clone

Description

Constants

TYPE_NONE
jump to class

 TYPE_NONE = 'none'

Details

value
none

TYPE_TAG
jump to class

 TYPE_TAG = 'tag'

Details

value
tag

Properties

$_attributes
jump to class

array $_attributes = 'array'

Tag attributes

Details

$_attributes
array
visibility
protected
default
array
final
false
static
false

$_children
jump to class

Zend_Markup_TokenList $_children = ''

Children of this token

Details

$_children
Zend_Markup_TokenList
visibility
protected
default
final
false
static
false

$_name
jump to class

string $_name = ''

Tag name

Details

$_name
string
visibility
protected
default
final
false
static
false

$_parent
jump to class

Zend_Markup_Token $_parent = ''

The parent token

Details

$_parent
Zend_Markup_Token
visibility
protected
default
final
false
static
false

$_stopper
jump to class

string $_stopper = ''

The used tag stopper (empty when none is found)

Details

$_stopper
string
visibility
protected
default
final
false
static
false

$_tag
jump to class

string $_tag = ''

The complete tag

Details

$_tag
string
visibility
protected
default
final
false
static
false

$_type
jump to class

string $_type = ''

The tag's type

Details

$_type
string
visibility
protected
default
final
false
static
false

Methods

__clone
jump to class

__clone( ) : void

Magic clone function

Details
visibility
public
final
false
static
false

__construct
jump to class

__construct( string $tag, string $type, string $name, array $attributes = array, Zend_Markup_Token $parent = null ) : void

Construct the token

Arguments
$tag
string
$type
string
$name
string
$attributes
array
$parent
Zend_Markup_Token
Details
visibility
public
final
false
static
false

addAttribute
jump to class

addAttribute(  $name,  $value ) : Zend_Markup_Token

Add an attribute

Arguments
$name
$value
Output
Zend_Markup_Token
Details
visibility
public
final
false
static
false

addChild
jump to class

addChild(  $child ) : void

Add a child token

Arguments
$child
Details
visibility
public
final
false
static
false

attributeIsEmpty
jump to class

attributeIsEmpty( string $name ) : bool

Check if an attribute is empty

Arguments
$name
string
Output
bool
Details
visibility
public
final
false
static
false

getAttribute
jump to class

getAttribute( string $name ) : string

Get an attribute

Arguments
$name
string
Output
string
Details
visibility
public
final
false
static
false

getAttributes
jump to class

getAttributes( ) : array

Get all the attributes

Output
array
Details
visibility
public
final
false
static
false

getChildren
jump to class

getChildren( ) : Zend_Markup_TokenList

Get the children for this token

Output
Zend_Markup_TokenList
Details
visibility
public
final
false
static
false

getName
jump to class

getName( ) : string

Get the token's name

Output
string
Details
visibility
public
final
false
static
false

getParent
jump to class

getParent( ) : Zend_Markup_Token

Get the parent token (if any)

Output
Zend_Markup_Token
Details
visibility
public
final
false
static
false

getStopper
jump to class

getStopper( ) : string

Get the stopper

Output
string
Details
visibility
public
final
false
static
false

getTag
jump to class

getTag( ) : string

Get the complete tag

Output
string
Details
visibility
public
final
false
static
false

getType
jump to class

getType( ) : string

Get the token's type

Output
string
Details
visibility
public
final
false
static
false

hasAttribute
jump to class

hasAttribute( string $name ) : bool

Check if the token has an attribute

Arguments
$name
string
Output
bool
Details
visibility
public
final
false
static
false

hasChildren
jump to class

hasChildren( ) : bool

Does this token have any children

Output
bool
Details
visibility
public
final
false
static
false

setChildren
jump to class

setChildren( Zend_Markup_TokenList $children ) : Zend_Markup_Token

Set the children token list

Arguments
$children
Zend_Markup_TokenList
Output
Zend_Markup_Token
Details
visibility
public
final
false
static
false

setParent
jump to class

setParent( Zend_Markup_Token $parent ) : Zend_Markup_Token

Set a parent token

Arguments
$parent
Zend_Markup_Token
Output
Zend_Markup_Token
Details
visibility
public
final
false
static
false

setStopper
jump to class

setStopper( string $stopper ) : Zend_Markup_Token

Set the stopper

Arguments
$stopper
string
Output
Zend_Markup_Token
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.