include/HTMLPurifier/standalone/HTMLPurifier/Lexer/PH5P.php

Show:

inherited

Classes

Table of Contents

\HTML5
jump to top

Package:

Constants

 
                PCDATA
                = 0

 
                RCDATA
                = 1

 
                CDATA
                = 2

 
                PLAINTEXT
                = 3

 
                DOCTYPE
                = 0

 
                STARTTAG
                = 1

 
                ENDTAG
                = 2

 
                COMMENT
                = 3

 
                CHARACTR
                = 4

 
                EOF
                = 5

Properties


                 $EOF= ''

Details

Type: n/a


                 $char= ''

Details

Type: n/a


                 $content_model= ''

Details

Type: n/a


                 $data= ''

Details

Type: n/a


                 $entities= 'array('AElig;','AElig','AMP;','AMP','Aacute;','Aacute',
    'Acirc;','Acirc','Agrave;','Agrave','Alpha;','Aring;','Aring','Atilde;',
    'Atilde','Auml;','Auml','Beta;','COPY;','COPY','Ccedil;','Ccedil','Chi;',
    'Dagger;','Delta;','ETH;','ETH','Eacute;','Eacute','Ecirc;','Ecirc','Egrave;',
    'Egrave','Epsilon;','Eta;','Euml;','Euml','GT;','GT','Gamma;','Iacute;',
    'Iacute','Icirc;','Icirc','Igrave;','Igrave','Iota;','Iuml;','Iuml','Kappa;',
    'LT;','LT','Lambda;','Mu;','Ntilde;','Ntilde','Nu;','OElig;','Oacute;',
    'Oacute','Ocirc;','Ocirc','Ograve;','Ograve','Omega;','Omicron;','Oslash;',
    'Oslash','Otilde;','Otilde','Ouml;','Ouml','Phi;','Pi;','Prime;','Psi;',
    'QUOT;','QUOT','REG;','REG','Rho;','Scaron;','Sigma;','THORN;','THORN',
    'TRADE;','Tau;','Theta;','Uacute;','Uacute','Ucirc;','Ucirc','Ugrave;',
    'Ugrave','Upsilon;','Uuml;','Uuml','Xi;','Yacute;','Yacute','Yuml;','Zeta;',
    'aacute;','aacute','acirc;','acirc','acute;','acute','aelig;','aelig',
    'agrave;','agrave','alefsym;','alpha;','amp;','amp','and;','ang;','apos;',
    'aring;','aring','asymp;','atilde;','atilde','auml;','auml','bdquo;','beta;',
    'brvbar;','brvbar','bull;','cap;','ccedil;','ccedil','cedil;','cedil',
    'cent;','cent','chi;','circ;','clubs;','cong;','copy;','copy','crarr;',
    'cup;','curren;','curren','dArr;','dagger;','darr;','deg;','deg','delta;',
    'diams;','divide;','divide','eacute;','eacute','ecirc;','ecirc','egrave;',
    'egrave','empty;','emsp;','ensp;','epsilon;','equiv;','eta;','eth;','eth',
    'euml;','euml','euro;','exist;','fnof;','forall;','frac12;','frac12',
    'frac14;','frac14','frac34;','frac34','frasl;','gamma;','ge;','gt;','gt',
    'hArr;','harr;','hearts;','hellip;','iacute;','iacute','icirc;','icirc',
    'iexcl;','iexcl','igrave;','igrave','image;','infin;','int;','iota;',
    'iquest;','iquest','isin;','iuml;','iuml','kappa;','lArr;','lambda;','lang;',
    'laquo;','laquo','larr;','lceil;','ldquo;','le;','lfloor;','lowast;','loz;',
    'lrm;','lsaquo;','lsquo;','lt;','lt','macr;','macr','mdash;','micro;','micro',
    'middot;','middot','minus;','mu;','nabla;','nbsp;','nbsp','ndash;','ne;',
    'ni;','not;','not','notin;','nsub;','ntilde;','ntilde','nu;','oacute;',
    'oacute','ocirc;','ocirc','oelig;','ograve;','ograve','oline;','omega;',
    'omicron;','oplus;','or;','ordf;','ordf','ordm;','ordm','oslash;','oslash',
    'otilde;','otilde','otimes;','ouml;','ouml','para;','para','part;','permil;',
    'perp;','phi;','pi;','piv;','plusmn;','plusmn','pound;','pound','prime;',
    'prod;','prop;','psi;','quot;','quot','rArr;','radic;','rang;','raquo;',
    'raquo','rarr;','rceil;','rdquo;','real;','reg;','reg','rfloor;','rho;',
    'rlm;','rsaquo;','rsquo;','sbquo;','scaron;','sdot;','sect;','sect','shy;',
    'shy','sigma;','sigmaf;','sim;','spades;','sub;','sube;','sum;','sup1;',
    'sup1','sup2;','sup2','sup3;','sup3','sup;','supe;','szlig;','szlig','tau;',
    'there4;','theta;','thetasym;','thinsp;','thorn;','thorn','tilde;','times;',
    'times','trade;','uArr;','uacute;','uacute','uarr;','ucirc;','ucirc',
    'ugrave;','ugrave','uml;','uml','upsih;','upsilon;','uuml;','uuml','weierp;',
    'xi;','yacute;','yacute','yen;','yen','yuml;','yuml','zeta;','zwj;','zwnj;')'

Default value

array('AElig;','AElig','AMP;','AMP','Aacute;','Aacute',
    'Acirc;','Acirc','Agrave;','Agrave','Alpha;','Aring;','Aring','Atilde;',
    'Atilde','Auml;','Auml','Beta;','COPY;','COPY','Ccedil;','Ccedil','Chi;',
    'Dagger;','Delta;','ETH;','ETH','Eacute;','Eacute','Ecirc;','Ecirc','Egrave;',
    'Egrave','Epsilon;','Eta;','Euml;','Euml','GT;','GT','Gamma;','Iacute;',
    'Iacute','Icirc;','Icirc','Igrave;','Igrave','Iota;','Iuml;','Iuml','Kappa;',
    'LT;','LT','Lambda;','Mu;','Ntilde;','Ntilde','Nu;','OElig;','Oacute;',
    'Oacute','Ocirc;','Ocirc','Ograve;','Ograve','Omega;','Omicron;','Oslash;',
    'Oslash','Otilde;','Otilde','Ouml;','Ouml','Phi;','Pi;','Prime;','Psi;',
    'QUOT;','QUOT','REG;','REG','Rho;','Scaron;','Sigma;','THORN;','THORN',
    'TRADE;','Tau;','Theta;','Uacute;','Uacute','Ucirc;','Ucirc','Ugrave;',
    'Ugrave','Upsilon;','Uuml;','Uuml','Xi;','Yacute;','Yacute','Yuml;','Zeta;',
    'aacute;','aacute','acirc;','acirc','acute;','acute','aelig;','aelig',
    'agrave;','agrave','alefsym;','alpha;','amp;','amp','and;','ang;','apos;',
    'aring;','aring','asymp;','atilde;','atilde','auml;','auml','bdquo;','beta;',
    'brvbar;','brvbar','bull;','cap;','ccedil;','ccedil','cedil;','cedil',
    'cent;','cent','chi;','circ;','clubs;','cong;','copy;','copy','crarr;',
    'cup;','curren;','curren','dArr;','dagger;','darr;','deg;','deg','delta;',
    'diams;','divide;','divide','eacute;','eacute','ecirc;','ecirc','egrave;',
    'egrave','empty;','emsp;','ensp;','epsilon;','equiv;','eta;','eth;','eth',
    'euml;','euml','euro;','exist;','fnof;','forall;','frac12;','frac12',
    'frac14;','frac14','frac34;','frac34','frasl;','gamma;','ge;','gt;','gt',
    'hArr;','harr;','hearts;','hellip;','iacute;','iacute','icirc;','icirc',
    'iexcl;','iexcl','igrave;','igrave','image;','infin;','int;','iota;',
    'iquest;','iquest','isin;','iuml;','iuml','kappa;','lArr;','lambda;','lang;',
    'laquo;','laquo','larr;','lceil;','ldquo;','le;','lfloor;','lowast;','loz;',
    'lrm;','lsaquo;','lsquo;','lt;','lt','macr;','macr','mdash;','micro;','micro',
    'middot;','middot','minus;','mu;','nabla;','nbsp;','nbsp','ndash;','ne;',
    'ni;','not;','not','notin;','nsub;','ntilde;','ntilde','nu;','oacute;',
    'oacute','ocirc;','ocirc','oelig;','ograve;','ograve','oline;','omega;',
    'omicron;','oplus;','or;','ordf;','ordf','ordm;','ordm','oslash;','oslash',
    'otilde;','otilde','otimes;','ouml;','ouml','para;','para','part;','permil;',
    'perp;','phi;','pi;','piv;','plusmn;','plusmn','pound;','pound','prime;',
    'prod;','prop;','psi;','quot;','quot','rArr;','radic;','rang;','raquo;',
    'raquo','rarr;','rceil;','rdquo;','real;','reg;','reg','rfloor;','rho;',
    'rlm;','rsaquo;','rsquo;','sbquo;','scaron;','sdot;','sect;','sect','shy;',
    'shy','sigma;','sigmaf;','sim;','spades;','sub;','sube;','sum;','sup1;',
    'sup1','sup2;','sup2','sup3;','sup3','sup;','supe;','szlig;','szlig','tau;',
    'there4;','theta;','thetasym;','thinsp;','thorn;','thorn','tilde;','times;',
    'times','trade;','uArr;','uacute;','uacute','uarr;','ucirc;','ucirc',
    'ugrave;','ugrave','uml;','uml','upsih;','upsilon;','uuml;','uuml','weierp;',
    'xi;','yacute;','yacute','yen;','yen','yuml;','yuml','zeta;','zwj;','zwnj;')

Details

Type: n/a


                 $escape= 'false'

Default valuefalseDetails

Type: n/a


                 $state= ''

Details

Type: n/a


                 $token= ''

Details

Type: n/a


                 $tree= ''

Details

Type: n/a

Methods

__construct(
           $data
          )
        
        :
          void

Parameters

Name	Type	Description
$data

afterAttributeNameState(
          
          )
        
        :
          void

afterDoctypeNameState(
          
          )
        
        :
          void

attributeNameState(
          
          )
        
        :
          void

attributeValueDoubleQuotedState(
          
          )
        
        :
          void

attributeValueSingleQuotedState(
          
          )
        
        :
          void

attributeValueUnquotedState(
          
          )
        
        :
          void

beforeAttributeNameState(
          
          )
        
        :
          void

beforeAttributeValueState(
          
          )
        
        :
          void

beforeDoctypeNameState(
          
          )
        
        :
          void

bogusCommentState(
          
          )
        
        :
          void

bogusDoctypeState(
          
          )
        
        :
          void

character(
           $s,  $l
              =
              0
          )
        
        :
          void

Parameters

Name	Type	Description
$s
$l

characters(
           $char_class,  $start
          )
        
        :
          void

Parameters

Name	Type	Description
$char_class
$start

closeTagOpenState(
          
          )
        
        :
          void

commentDashState(
          
          )
        
        :
          void

commentEndState(
          
          )
        
        :
          void

commentState(
          
          )
        
        :
          void

dataState(
          
          )
        
        :
          void

doctypeNameState(
          
          )
        
        :
          void

doctypeState(
          
          )
        
        :
          void

emitToken(
           $token
          )
        
        :
          void

Parameters

Name	Type	Description
$token

entity(
          
          )
        
        :
          void

entityDataState(
          
          )
        
        :
          void

entityInAttributeValueState(
          
          )
        
        :
          void

markupDeclarationOpenState(
          
          )
        
        :
          void

tagNameState(
          
          )
        
        :
          void

tagOpenState(
          
          )
        
        :
          void

\HTML5TreeConstructer
jump to top

Package:

Constants

 
                INIT_PHASE
                = 0

 
                ROOT_PHASE
                = 1

 
                MAIN_PHASE
                = 2

 
                END_PHASE
                = 3

 
                BEFOR_HEAD
                = 0

 
                IN_HEAD
                = 1

 
                AFTER_HEAD
                = 2

 
                IN_BODY
                = 3

 
                IN_TABLE
                = 4

 
                IN_CAPTION
                = 5

 
                IN_CGROUP
                = 6

 
                IN_TBODY
                = 7

 
                IN_ROW
                = 8

 
                IN_CELL
                = 9

 
                IN_SELECT
                = 10

 
                AFTER_BODY
                = 11

 
                IN_FRAME
                = 12

 
                AFTR_FRAME
                = 13

 
                SPECIAL
                = 0

 
                SCOPING
                = 1

 
                FORMATTING
                = 2

 
                PHRASING
                = 3

 
                MARKER
                = 0

Properties


                 $a_formatting= 'array()'

Default valuearray()Details

Type: n/a


                 $dom= ''

Details

Type: n/a


                 $form_pointer= 'null'

Default valuenullDetails

Type: n/a


                 $formatting= 'array('a','b','big','em','font','i','nobr','s','small','strike','strong','tt','u')'

Default valuearray('a','b','big','em','font','i','nobr','s','small','strike','strong','tt','u')Details

Type: n/a


                 $foster_parent= 'null'

Default valuenullDetails

Type: n/a


                 $head_pointer= 'null'

Default valuenullDetails

Type: n/a


                 $mode= ''

Details

Type: n/a


                 $phase= ''

Details

Type: n/a


                 $scoping= 'array('button','caption','html','marquee','object','table','td','th')'

Default valuearray('button','caption','html','marquee','object','table','td','th')Details

Type: n/a


                 $special= 'array('address','area','base','basefont','bgsound',
    'blockquote','body','br','center','col','colgroup','dd','dir','div','dl',
    'dt','embed','fieldset','form','frame','frameset','h1','h2','h3','h4','h5',
    'h6','head','hr','iframe','image','img','input','isindex','li','link',
    'listing','menu','meta','noembed','noframes','noscript','ol','optgroup',
    'option','p','param','plaintext','pre','script','select','spacer','style',
    'tbody','textarea','tfoot','thead','title','tr','ul','wbr')'

Default value

array('address','area','base','basefont','bgsound',
    'blockquote','body','br','center','col','colgroup','dd','dir','div','dl',
    'dt','embed','fieldset','form','frame','frameset','h1','h2','h3','h4','h5',
    'h6','head','hr','iframe','image','img','input','isindex','li','link',
    'listing','menu','meta','noembed','noframes','noscript','ol','optgroup',
    'option','p','param','plaintext','pre','script','select','spacer','style',
    'tbody','textarea','tfoot','thead','title','tr','ul','wbr')

Details

Type: n/a


                 $stack= 'array()'

Default valuearray()Details

Type: n/a

Methods

__construct(
          
          )
        
        :
          void

afterBody(
           $token
          )
        
        :
          void

Parameters

Name	Type	Description
$token

afterFrameset(
           $token
          )
        
        :
          void

Parameters

Name	Type	Description
$token

afterHead(
           $token
          )
        
        :
          void

Parameters

Name	Type	Description
$token

appendToRealParent(
           $node
          )
        
        :
          void

Parameters

Name	Type	Description
$node

beforeHead(
           $token
          )
        
        :
          void

Parameters

Name	Type	Description
$token

clearStackToTableContext(
           $elements
          )
        
        :
          void

Parameters

Name	Type	Description
$elements

clearTheActiveFormattingElementsUpToTheLastMarker(
          
          )
        
        :
          void

closeCell(
          
          )
        
        :
          void

elementInScope(
           $el,  $table
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$el
$table

emitToken(
           $token
          )
        
        :
          void

Parameters

Name	Type	Description
$token

generateImpliedEndTags(
           $exclude
              =
              array()
          )
        
        :
          void

Parameters

Name	Type	Description
$exclude

getElementCategory(
           $node
          )
        
        :
          void

Parameters

Name	Type	Description
$node

inBody(
           $token
          )
        
        :
          void

Parameters

Name	Type	Description
$token

inCaption(
           $token
          )
        
        :
          void

Parameters

Name	Type	Description
$token

inCell(
           $token
          )
        
        :
          void

Parameters

Name	Type	Description
$token

inColumnGroup(
           $token
          )
        
        :
          void

Parameters

Name	Type	Description
$token

inFrameset(
           $token
          )
        
        :
          void

Parameters

Name	Type	Description
$token

inHead(
           $token
          )
        
        :
          void

Parameters

Name	Type	Description
$token

inRow(
           $token
          )
        
        :
          void

Parameters

Name	Type	Description
$token

inSelect(
           $token
          )
        
        :
          void

Parameters

Name	Type	Description
$token

inTable(
           $token
          )
        
        :
          void

Parameters

Name	Type	Description
$token

inTableBody(
           $token
          )
        
        :
          void

Parameters

Name	Type	Description
$token

initPhase(
           $token
          )
        
        :
          void

Parameters

Name	Type	Description
$token

insertComment(
           $data
          )
        
        :
          void

Parameters

Name	Type	Description
$data

insertElement(
           $token,  $append
              =
              true,  $check
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$token
$append
$check

insertText(
           $data
          )
        
        :
          void

Parameters

Name	Type	Description
$data

mainPhase(
           $token
          )
        
        :
          void

Parameters

Name	Type	Description
$token

reconstructActiveFormattingElements(
          
          )
        
        :
          void

resetInsertionMode(
          
          )
        
        :
          void

rootElementPhase(
           $token
          )
        
        :
          void

Parameters

Name	Type	Description
$token

trailingEndPhase(
           $token
          )
        
        :
          void

Parameters

Name	Type	Description
$token

\HTMLPurifier_Lexer_PH5P
jump to top

Package: SugarCRM

Experimental HTML5-based parser using Jeroen van der Meer's PH5P library.

Occupies space in the HTML5 pseudo-namespace, which may cause conflicts.

Parent(s): \HTMLPurifier_Lexer_DOMLex < \HTMLPurifier_Lexer
Note: Recent changes to PHP's DOM extension have resulted in some fatal error conditions with the original version of PH5P. Pending changes, this lexer will punt to DirectLex if DOM throughs an exception.

Properties


                 $_special_entity2str= 'array(
                    '&quot;' => '"',
                    '&amp;'  => '&',
                    '&lt;'   => '<',
                    '&gt;'   => '>',
                    '&#39;'  => "'",
                    '&#039;' => "'",
                    '&#x27;' => "'"
            )'

inherited

Most common entity to raw value conversion table for special entities.

Inherited from: \HTMLPurifier_Lexer::$$_special_entity2str \HTMLPurifier_Lexer_DOMLex::$$_special_entity2str

Default value

array(
                    '&quot;' => '"',
                    '&amp;'  => '&',
                    '&lt;'   => '<',
                    '&gt;'   => '>',
                    '&#39;'  => "'",
                    '&#039;' => "'",
                    '&#x27;' => "'"
            )

Details

Type: n/a
Inherited_from: \HTMLPurifier_Lexer::$$_special_entity2str
Inherited_from: \HTMLPurifier_Lexer_DOMLex::$$_special_entity2str


                 $factory= ''

inheritedInherited from: \HTMLPurifier_Lexer_DOMLex::$$factory

Details

Type: n/a
Inherited_from: \HTMLPurifier_Lexer_DOMLex::$$factory


                 $tracksLineNumbers= 'false'

inherited

Whether or not this lexer implements line-number/column-number tracking.

Inherited from: \HTMLPurifier_Lexer::$$tracksLineNumbers \HTMLPurifier_Lexer_DOMLex::$$tracksLineNumbers

If it does, set to true.

Default valuefalseDetails

Type: n/a
Inherited_from: \HTMLPurifier_Lexer::$$tracksLineNumbers
Inherited_from: \HTMLPurifier_Lexer_DOMLex::$$tracksLineNumbers

Methods

CDATACallback(
           $matches
          )
        
        :
          void

staticinherited

Callback function for escapeCDATA() that does the work.

Inherited from: \HTMLPurifier_Lexer::CDATACallback()\HTMLPurifier_Lexer_DOMLex::CDATACallback()

Parameters

Name	Type	Description
$matches

Details

Params: $matches PCRE matches array, with index 0 the entire match and 1 the inside of the CDATA section.
Returns: Escaped internals of the CDATA section.
Warning: Though this is public in order to let the callback happen, calling it directly is not recommended.

__construct(
          
          )
        
        :
          void

inherited

Inherited from: \HTMLPurifier_Lexer_DOMLex::__construct()

callbackArmorCommentEntities(
           $matches
          )
        
        :
          void

inherited

Callback function that entity-izes ampersands in comments so that callbackUndoCommentSubst doesn't clobber them

Inherited from: \HTMLPurifier_Lexer_DOMLex::callbackArmorCommentEntities()

Parameters

Name	Type	Description
$matches

callbackUndoCommentSubst(
           $matches
          )
        
        :
          void

inherited

Callback function for undoing escaping of stray angled brackets in comments

Inherited from: \HTMLPurifier_Lexer_DOMLex::callbackUndoCommentSubst()

Parameters

Name	Type	Description
$matches

create(
          \$config $config
          )
        
        :
          \Concrete

staticinherited

Retrieves or sets the default Lexer as a Prototype Factory.

Inherited from: \HTMLPurifier_Lexer::create()\HTMLPurifier_Lexer_DOMLex::create()

By default HTMLPurifier_Lexer_DOMLex will be returned. There are a few exceptions involving special features that only DirectLex implements.

Parameters

Name	Type	Description
$config	\$config	Instance of HTMLPurifier_Config

Returns

Type	Description
\Concrete	lexer.

Details

Note: The behavior of this class has changed, rather than accepting a prototype object, it now accepts a configuration object. To specify your own prototype, set %Core.LexerImpl to it. This change in behavior de-singletonizes the lexer object.

createEndNode(
           $node,  $tokens
          )
        
        :
          void

inherited

Inherited from: \HTMLPurifier_Lexer_DOMLex::createEndNode()

Parameters

Name	Type	Description
$node
$tokens

createStartNode(
          \$node $node, \$tokens $tokens, \$collect $collect
          )
        
        :
          void

inherited

Inherited from: \HTMLPurifier_Lexer_DOMLex::createStartNode()

Parameters

Name	Type	Description
$node	\$node	DOMNode to be tokenized.
$tokens	\$tokens	Array-list of already tokenized tokens.
$collect	\$collect	Says whether or start and close are collected, set to false at first recursion because it's the implicit DIV tag you're dealing with.

Details

Returns: bool if the token needs an endtoken

escapeCDATA(
          \$string $string
          )
        
        :
          void

staticinherited

Translates CDATA sections into regular sections (through escaping).

Inherited from: \HTMLPurifier_Lexer::escapeCDATA()\HTMLPurifier_Lexer_DOMLex::escapeCDATA()

Parameters

Name	Type	Description
$string	\$string	HTML string to process.

Details

Returns: HTML with CDATA sections escaped.

escapeCommentedCDATA(
           $string
          )
        
        :
          void

staticinherited

Special CDATA case that is especially convoluted for

include/HTMLPurifier/standalone/HTMLPurifier/Lexer/PH5P.php

\HTML5jump to top

Constants

Properties

Methods

\HTML5TreeConstructerjump to top

Constants

Properties

Methods

\HTMLPurifier_Lexer_PH5Pjump to top

Properties

Methods

\HTML5
jump to top

\HTML5TreeConstructer
jump to top

\HTMLPurifier_Lexer_PH5P
jump to top