Markup/Parser/Bbcode.php

Show: inherited
Table of Contents

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 [email protected] so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Markup  
Subpackage
Parser  
Version
$Id: Bbcode.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Markup_Parser_Bbcode
jump to top

Package: Zend\Markup\Parser

Implements
\Zend_Markup_Parser_ParserInterface
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

Constant  NEWLINE = "[newline\0]"
Constant  TYPE_DEFAULT = 'default'
Constant  TYPE_SINGLE = 'single'
Constant  NAME_CHARSET = '^\[\]=\s'
Constant  STATE_SCAN = 0
Constant  STATE_SCANATTRS = 1
Constant  STATE_PARSEVALUE = 2

Properties

Propertyprotectedstring $_buffer = ''

The buffer

Default value''Details
Type
string
Propertyprotected\Zend_Markup_Token $_current =

Current token

Details
Type
\Zend_Markup_Token
Propertyprotectedint $_pointer = 0

Current pointer

Default value0Details
Type
int
Propertyprotectedarray $_searchedStoppers = array()

Stoppers that we are searching for

Default valuearray()Details
Type
array
Propertyprotectedint $_state = self::STATE_SCAN

State

Default valueself::STATE_SCANDetails
Type
int
Propertyprotectedarray $_tags = array('Zend_Markup_Root' => array('type' => self::TYPE_DEFAULT, 'stoppers' => array()), '*' => array('type' => self::TYPE_DEFAULT, 'stoppers' => array(self::NEWLINE, '[/*]', '[/]')), 'hr' => array('type' => self::TYPE_SINGLE, 'stoppers' => array()), 'code' => array('type' => self::TYPE_DEFAULT, 'stoppers' => array('[/code]', '[/]'), 'parse_inside' => false))

Tag information

Default valuearray('Zend_Markup_Root' => array('type' => self::TYPE_DEFAULT, 'stoppers' => array()), '*' => array('type' => self::TYPE_DEFAULT, 'stoppers' => array(self::NEWLINE, '[/*]', '[/]')), 'hr' => array('type' => self::TYPE_SINGLE, 'stoppers' => array()), 'code' => array('type' => self::TYPE_DEFAULT, 'stoppers' => array('[/code]', '[/]'), 'parse_inside' => false))Details
Type
array
Propertyprotectedarray $_temp =

Temporary tag storage

Details
Type
array
Propertyprotectedarray $_tokens = array()

Token array

Default valuearray()Details
Type
array
Propertyprotected\Zend_Markup_TokenList $_tree =

Token tree

Details
Type
\Zend_Markup_TokenList
Propertyprotectedstring $_value = ''

Source to tokenize

Default value''Details
Type
string
Propertyprotectedint $_valueLen = 0

Length of the value

Default value0Details
Type
int

Methods

methodprotected_addToSearchedStoppers(\Zend_Markup_Token $token) : void

Add to searched stoppers

Parameters
Name Type Description
$token \Zend_Markup_Token
methodprotected_checkTagDeclaration(string $name) : void

Check if there is a tag declaration, and if it isnt there, add it

Parameters
Name Type Description
$name string
methodpublic_createTree() : void

Parse the token array into a tree

methodprotected_getType(string $name) : string

Check the tag's type

Parameters
Name Type Description
$name string
Returns
Type Description
string
methodprotected_isStopper(string $tag) : bool

Check if the tag is a stopper

Parameters
Name Type Description
$tag string
Returns
Type Description
bool
methodprotected_removeFromSearchedStoppers(\Zend_Markup_Token $token) : void

Remove from searched stoppers

Parameters
Name Type Description
$token \Zend_Markup_Token
methodprotected_tokenize() : void

Tokenize

methodpublicparse(string $value) : \Zend_Markup_TokenList

Prepare the parsing of a bbcode string, the real parsing is done in {@link _parse()}

This should output something like this:

array(
    array(
        'tag'        => '[tag="a" attr=val]',
        'type'       => Zend_Markup::TYPE_TAG,
        'name'       => 'tag',
        'stoppers'   => array('[/]', '[/tag]'),
        'attributes' => array(
            'tag'  => 'a',
            'attr' => 'val'
        )
    ),
    array(
        'tag'   => 'value',
        'type'  => Zend_Markup::TYPE_NONE
    ),
    array(
        'tag'        => '[/tag]',
        'type'       => Zend_Markup::TYPE_STOPPER,
        'name'       => 'tag',
        'stoppers'   => array(),
        'attributes' => array()
    )
)
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Markup_TokenList
Documentation was generated by phpDocumentor 2.0.0a8.