PHPXRef 0.7.1 : MediaWiki-1.24.0 : Detail view of Preprocessor

[Source view] [Print] [Project Stats]

Preprocessor using PHP arrays This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

File Size:	2111 lines (57 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 12 classes

Preprocessor_Hash:: (5 methods):
  __construct()
  newFrame()
  newCustomFrame()
  newPartNodeArray()
  preprocessToObj()

PPDStack_Hash:: (1 method):
__construct()

PPDStackElement_Hash:: (2 methods):
__construct()
breakSyntax()

PPDPart_Hash:: (1 method):
__construct()

PPDAccum_Hash:: (5 methods):
  __construct()
  addLiteral()
  addNode()
  addNodeWithText()
  addAccum()

PPFrame_Hash:: (22 methods):
  __construct()
  newChild()
  cachedExpand()
  expand()
  implodeWithFlags()
  implode()
  virtualImplode()
  virtualBracketedImplode()
  __toString()
  getPDBK()
  getArguments()
  getNumberedArguments()
  getNamedArguments()
  isEmpty()
  getArgument()
  loopCheck()
  isTemplate()
  getTitle()
  setVolatile()
  isVolatile()
  setTTL()
  getTTL()

PPTemplateFrame_Hash:: (13 methods):
  __construct()
  __toString()
  cachedExpand()
  isEmpty()
  getArguments()
  getNumberedArguments()
  getNamedArguments()
  getNumberedArgument()
  getNamedArgument()
  getArgument()
  isTemplate()
  setVolatile()
  setTTL()

PPCustomFrame_Hash:: (5 methods):
  __construct()
  __toString()
  isEmpty()
  getArgument()
  getArguments()

PPNode_Hash_Tree:: (15 methods):
  __construct()
  __toString()
  newWithText()
  addChild()
  getChildren()
  getFirstChild()
  getNextSibling()
  getChildrenOfType()
  getLength()
  item()
  getName()
  splitArg()
  splitExt()
  splitHeading()
  splitTemplate()

PPNode_Hash_Text:: (12 methods):
  __construct()
  __toString()
  getNextSibling()
  getChildren()
  getFirstChild()
  getChildrenOfType()
  getLength()
  item()
  getName()
  splitArg()
  splitExt()
  splitHeading()

PPNode_Hash_Array:: (12 methods):
  __construct()
  __toString()
  getLength()
  item()
  getName()
  getNextSibling()
  getChildren()
  getFirstChild()
  getChildrenOfType()
  splitArg()
  splitExt()
  splitHeading()

PPNode_Hash_Attr:: (12 methods):
  __construct()
  __toString()
  getName()
  getNextSibling()
  getChildren()
  getFirstChild()
  getChildrenOfType()
  getLength()
  item()
  splitArg()
  splitExt()
  splitHeading()

Class: Preprocessor_Hash - X-Ref

Differences from DOM schema:
* attribute nodes are children
* "<h>" nodes that aren't at the top are replaced with <possible-h>

__construct( $parser ) X-Ref

newFrame() X-Ref

return: PPFrame_Hash

newCustomFrame( $args ) X-Ref

param: array $args
return: PPCustomFrame_Hash

newPartNodeArray( $values ) X-Ref

param: array $values
return: PPNode_Hash_Array

preprocessToObj( $text, $flags = 0 ) X-Ref

Preprocess some wikitext and return the document tree.
This is the ghost of Parser::replace_variables().

param: string $text The text to parse
param: int $flags Bitwise combination of:
return: PPNode_Hash_Tree

Class: PPDStack_Hash - X-Ref

Stack class to help Preprocessor::preprocessToObj()

__construct() X-Ref

No description

Class: PPDStackElement_Hash - X-Ref

__construct( $data = array() X-Ref

No description

breakSyntax( $openingCount = false ) X-Ref

Get the accumulator that would result if the close is not found.

param: int|bool $openingCount
return: PPDAccum_Hash

Class: PPDPart_Hash - X-Ref

__construct( $out = '' ) X-Ref

No description

Class: PPDAccum_Hash - X-Ref

__construct() X-Ref

No description

addLiteral( $s ) X-Ref

Append a string literal

param: string $s

addNode( PPNode $node ) X-Ref

Append a PPNode

param: PPNode $node

addNodeWithText( $name, $value ) X-Ref

Append a tree node with text contents

param: string $name
param: string $value

addAccum( $accum ) X-Ref

Append a PPDAccum_Hash
Takes over ownership of the nodes in the source argument. These nodes may
subsequently be modified, especially nextSibling.

param: PPDAccum_Hash $accum

Class: PPFrame_Hash - X-Ref

An expansion frame, used as a context to expand the result of preprocessToObj()

__construct( $preprocessor ) X-Ref

Construct a new preprocessor frame.

param: Preprocessor $preprocessor The parent preprocessor

newChild( $args = false, $title = false, $indexOffset = 0 ) X-Ref

Create a new child frame
$args is optionally a multi-root PPNode or array containing the template arguments

param: array|bool|PPNode_Hash_Array $args
param: Title|bool $title
param: int $indexOffset
return: PPTemplateFrame_Hash

cachedExpand( $key, $root, $flags = 0 ) X-Ref

param: string|int $key
param: string|PPNode $root
param: int $flags
return: string

expand( $root, $flags = 0 ) X-Ref

param: string|PPNode $root
param: int $flags
return: string

implodeWithFlags( $sep, $flags ) X-Ref

param: string $sep
param: int $flags
param: string|PPNode $args,...
return: string

implode( $sep ) X-Ref

Implode with no flags specified
This previously called implodeWithFlags but has now been inlined to reduce stack depth

param: string $sep
param: string|PPNode $args,...
return: string

virtualImplode( $sep ) X-Ref

Makes an object that, when expand()ed, will be the same as one obtained
with implode()

param: string $sep
param: string|PPNode $args,...
return: PPNode_Hash_Array

virtualBracketedImplode( $start, $sep, $end ) X-Ref

Virtual implode with brackets

param: string $start
param: string $sep
param: string $end
param: string|PPNode $args,...
return: PPNode_Hash_Array

__toString() X-Ref

No description

getPDBK( $level = false ) X-Ref

param: bool $level
return: array|bool|string

getArguments() X-Ref

return: array

getNumberedArguments() X-Ref

return: array

getNamedArguments() X-Ref

return: array

isEmpty() X-Ref

Returns true if there are no arguments in this frame

return: bool

getArgument( $name ) X-Ref

param: string $name
return: bool

loopCheck( $title ) X-Ref

Returns true if the infinite loop check is OK, false if a loop is detected

param: Title $title
return: bool

isTemplate() X-Ref

Return true if the frame is a template frame

return: bool

getTitle() X-Ref

Get a title of frame

return: Title

setVolatile( $flag = true ) X-Ref

Set the volatile flag

param: bool $flag

isVolatile() X-Ref

Get the volatile flag

return: bool

setTTL( $ttl ) X-Ref

Set the TTL

param: int $ttl

getTTL() X-Ref

Get the TTL

return: int|null

Class: PPTemplateFrame_Hash - X-Ref

Expansion frame with template arguments

__construct( $preprocessor, $parent = false, $numberedArgs = array() X-Ref

param: Preprocessor $preprocessor
param: bool|PPFrame $parent
param: array $numberedArgs
param: array $namedArgs
param: bool|Title $title

__toString() X-Ref

No description

cachedExpand( $key, $root, $flags = 0 ) X-Ref

param: string|int $key
param: string|PPNode $root
param: int $flags
return: string

isEmpty() X-Ref

Returns true if there are no arguments in this frame

return: bool

getArguments() X-Ref

return: array

getNumberedArguments() X-Ref

return: array

getNamedArguments() X-Ref

return: array

getNumberedArgument( $index ) X-Ref

param: int $index
return: array|bool

getNamedArgument( $name ) X-Ref

param: string $name
return: bool

getArgument( $name ) X-Ref

param: string $name
return: array|bool

isTemplate() X-Ref

Return true if the frame is a template frame

return: bool

setVolatile( $flag = true ) X-Ref

No description

setTTL( $ttl ) X-Ref

No description

Class: PPCustomFrame_Hash - X-Ref

Expansion frame with custom arguments

__construct( $preprocessor, $args ) X-Ref

No description

__toString() X-Ref

No description

isEmpty() X-Ref

return: bool

getArgument( $index ) X-Ref

param: int $index
return: bool

getArguments() X-Ref

No description

Class: PPNode_Hash_Tree - X-Ref

__construct( $name ) X-Ref

No description

__toString() X-Ref

No description

newWithText( $name, $text ) X-Ref

param: string $name
param: string $text
return: PPNode_Hash_Tree

addChild( $node ) X-Ref

No description

getChildren() X-Ref

return: PPNode_Hash_Array

getFirstChild() X-Ref

No description

getNextSibling() X-Ref

No description

getChildrenOfType( $name ) X-Ref

No description

getLength() X-Ref

return: bool

item( $i ) X-Ref

param: int $i
return: bool

getName() X-Ref

return: string

splitArg() X-Ref

Split a "<part>" node into an associative array containing:
- name          PPNode name
- index         String index
- value         PPNode value

return: array

splitExt() X-Ref

Split an "<ext>" node into an associative array containing name, attr, inner and close
All values in the resulting array are PPNodes. Inner and close are optional.

return: array

splitHeading() X-Ref

Split an "<h>" node

return: array

splitTemplate() X-Ref

Split a "<template>" or "<tplarg>" node

return: array

Class: PPNode_Hash_Text - X-Ref

__construct( $value ) X-Ref

No description

__toString() X-Ref

No description

getNextSibling() X-Ref

No description

getChildren() X-Ref