Markup/Parser/Bbcode.php

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: Bbcode.php 21128 2010-02-21 15:36:07Z kokx $
Classes: Zend_Markup_Parser_Bbcode

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_Parser_Bbcode
jump to top

Implements: Zend_Markup_Parser_ParserInterface
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
Constants: NEWLINE; TYPE_DEFAULT; TYPE_SINGLE; NAME_CHARSET; STATE_SCAN; STATE_SCANATTRS; STATE_PARSEVALUE
Properties: $_tree; $_current; $_value; $_valueLen; $_pointer; $_buffer; $_temp; $_searchedStoppers; $_tags; $_tokens; $_state
Methods: parse; _tokenize; _createTree; _checkTagDeclaration; _getType; _isStopper; _addToSearchedStoppers; _removeFromSearchedStoppers

Description

Constants

NEWLINE
jump to class

 NEWLINE = '[newline\0]'

Details

value: [newline\0]

TYPE_DEFAULT
jump to class

 TYPE_DEFAULT = 'default'

Details

value: default

TYPE_SINGLE
jump to class

 TYPE_SINGLE = 'single'

Details

value: single

NAME_CHARSET
jump to class

 NAME_CHARSET = '^\[\]=\s'

Details

value: ^\[\]=\s

STATE_SCAN
jump to class

 STATE_SCAN = '0'

Details

value: 0

STATE_SCANATTRS
jump to class

 STATE_SCANATTRS = '1'

Details

value: 1

STATE_PARSEVALUE
jump to class

 STATE_PARSEVALUE = '2'

Details

value: 2

Properties

$_buffer
jump to class

string $_buffer = ''

The buffer

Details

$_buffer: string
visibility: protected
default
final: false
static: false

$_current
jump to class

Zend_Markup_Token $_current = ''

Current token

Details

$_current: Zend_Markup_Token
visibility: protected
default
final: false
static: false

$_pointer
jump to class

int $_pointer = '0'

Current pointer

Details

$_pointer: int
visibility: protected
default: 0
final: false
static: false

$_searchedStoppers
jump to class

array $_searchedStoppers = 'array'

Stoppers that we are searching for

Details

$_searchedStoppers: array
visibility: protected
default: array
final: false
static: false

$_state
jump to class

int $_state = 'self'

State

Details

$_state: int
visibility: protected
default: self
final: false
static: false

$_tags
jump to class

array $_tags = 'array'

Tag information

Details

$_tags: array
visibility: protected
default: array
final: false
static: false

$_temp
jump to class

array $_temp = ''

Temporary tag storage

Details

$_temp: array
visibility: protected
default
final: false
static: false

$_tokens
jump to class

array $_tokens = 'array'

Token array

Details

$_tokens: array
visibility: protected
default: array
final: false
static: false

$_tree
jump to class

Zend_Markup_TokenList $_tree = ''

Token tree

Details

$_tree: Zend_Markup_TokenList
visibility: protected
default
final: false
static: false

$_value
jump to class

string $_value = ''

Source to tokenize

Details

$_value: string
visibility: protected
default
final: false
static: false

$_valueLen
jump to class

int $_valueLen = '0'

Length of the value

Details

$_valueLen: int
visibility: protected
default: 0
final: false
static: false

Methods

_addToSearchedStoppers
jump to class

_addToSearchedStoppers(
          Zend_Markup_Token $token
          )
        
        :
        void

Add to searched stoppers

Arguments

$token: Zend_Markup_Token

Details

visibility: protected
final: false
static: false

_checkTagDeclaration
jump to class

_checkTagDeclaration(
          string $name
          )
        
        :
        void

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

Arguments

$name: string

Details

visibility: protected
final: false
static: false

_createTree
jump to class

_createTree(
          
          )
        
        :
        void

Parse the token array into a tree

Details

visibility: public
final: false
static: false

_getType
jump to class

_getType(
          string $name
          )
        
        :
        string

Check the tag's type

Arguments

$name: string

Output

string

Details

visibility: protected
final: false
static: false

_isStopper
jump to class

_isStopper(
          string $tag
          )
        
        :
        bool

Check if the tag is a stopper

Arguments

$tag: string

Output

bool

Details

visibility: protected
final: false
static: false

_removeFromSearchedStoppers
jump to class

_removeFromSearchedStoppers(
          Zend_Markup_Token $token
          )
        
        :
        void

Remove from searched stoppers

Arguments

$token: Zend_Markup_Token

Details

visibility: protected
final: false
static: false

_tokenize
jump to class

_tokenize(
          
          )
        
        :
        void

Tokenize

Details

visibility: protected
final: false
static: false

parse
jump to class

parse(
          string $value
          )
        
        :
        Zend_Markup_TokenList

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

Arguments

$value: string

Output

Zend_Markup_TokenList

Details

visibility: public
final: false
static: false

API Documentation

Markup/Parser/Bbcode.php

Description

Zend_Markup_Parser_Bbcodejump to top

Description

Constants

NEWLINEjump to class

Details

TYPE_DEFAULTjump to class

Details

TYPE_SINGLEjump to class

Details

NAME_CHARSETjump to class

Details

STATE_SCANjump to class

Details

STATE_SCANATTRSjump to class

Details

STATE_PARSEVALUEjump to class

Details

Properties

$_bufferjump to class

Details

$_currentjump to class

Details

$_pointerjump to class

Details

$_searchedStoppersjump to class

Details

$_statejump to class

Details

$_tagsjump to class

Details

$_tempjump to class

Details

$_tokensjump to class

Details

$_treejump to class

Details

$_valuejump to class

Details

$_valueLenjump to class

Details

Methods

_addToSearchedStoppersjump to class

Arguments

Details

_checkTagDeclarationjump to class

Arguments

Details

_createTreejump to class

Details

_getTypejump to class

Arguments

Output

Details

_isStopperjump to class

Arguments

Output

Details

_removeFromSearchedStoppersjump to class

Arguments

Details

_tokenizejump to class

Details

parsejump to class

Arguments

Output

Details

Zend_Markup_Parser_Bbcode
jump to top

NEWLINE
jump to class

TYPE_DEFAULT
jump to class

TYPE_SINGLE
jump to class

NAME_CHARSET
jump to class

STATE_SCAN
jump to class

STATE_SCANATTRS
jump to class

STATE_PARSEVALUE
jump to class

$_buffer
jump to class

$_current
jump to class

$_pointer
jump to class

$_searchedStoppers
jump to class

$_state
jump to class

$_tags
jump to class

$_temp
jump to class

$_tokens
jump to class

$_tree
jump to class

$_value
jump to class

$_valueLen
jump to class

_addToSearchedStoppers
jump to class

_checkTagDeclaration
jump to class

_createTree
jump to class

_getType
jump to class

_isStopper
jump to class

_removeFromSearchedStoppers
jump to class

_tokenize
jump to class

parse
jump to class