PHP Class RFormatter, php-ref

显示文件 Open project: digitalnature/php-ref Class Usage Examples

Public Methods

Method Description
bubbles ( array $items ) Generate modifier tokens
cacheLock ( string $id ) Ends cache capturing for the given ID
colDiv ( integer $padLen = null ) Column divider (cell delimiter)
didCache ( string $id ) : boolean Resolve cache request
emptyGroup ( string $prefix = '' ) Generate empty group token
endContain ( ) Generate container ending token
endExp ( ) Input expression end
endGroup ( ) Generate group ending token
endRoot ( ) Root ending token
endRow ( ) Generate row ending token
flush ( ) Flush output and send contents to the output device
sectionTitle ( string $title ) Generate section title
sep ( string $label = ' ' ) Separator token
startContain ( string | array $type, string | boolean $label = false ) Generate container start token
startExp ( ) Input expression start
startGroup ( string $prefix = '' ) : boolean Generate group start token
startRoot ( ) Root starting token
startRow ( ) Generate row start token
text ( string | array $type, string | null $text = null, string | array | null $meta = null, string | null $uri = null ) Generate a base entity

Method Details

bubbles() public method

Generate modifier tokens
public bubbles ( array $items )
$items array

cacheLock() public method

Ends cache capturing for the given ID
public cacheLock ( string $id )
$id string

colDiv() public method

Column divider (cell delimiter)
public colDiv ( integer $padLen = null )
$padLen integer

didCache() public method

If the ID is not present in the cache, then a new cache entry is created for the given ID, and string offsets are captured until cacheLock is called This method must return TRUE if the ID exists in the cache, and append the cached item to the output, FALSE otherwise.
public didCache ( string $id ) : boolean
$id string
return boolean

emptyGroup() public method

Generate empty group token
public emptyGroup ( string $prefix = '' )
$prefix string

endContain() public method

Generate container ending token
public endContain ( )

endExp() public method

Input expression end
public endExp ( )

endGroup() public method

Generate group ending token
public endGroup ( )

endRoot() public method

Root ending token
public endRoot ( )

endRow() public method

Generate row ending token
public endRow ( )

flush() abstract public method

Flush output and send contents to the output device
abstract public flush ( )

sectionTitle() public method

Generate section title
public sectionTitle ( string $title )
$title string

sep() public method

Separator token
public sep ( string $label = ' ' )
$label string

startContain() public method

Generate container start token
public startContain ( string | array $type, string | boolean $label = false )
$type string | array
$label string | boolean

startExp() public method

Input expression start
public startExp ( )

startGroup() public method

This method must return boolean TRUE on success, false otherwise (eg. max depth reached). The evaluator will skip this group on FALSE
public startGroup ( string $prefix = '' ) : boolean
$prefix string
return boolean

startRoot() public method

Root starting token
public startRoot ( )

startRow() public method

Generate row start token
public startRow ( )

text() abstract public method

Generate a base entity
abstract public text ( string | array $type, string | null $text = null, string | array | null $meta = null, string | null $uri = null )
$type string | array
$text string | null
$meta string | array | null
$uri string | null