[ Index ]

PHP Cross Reference of phpBB-3.1.12-deutsch

title

Body

[close]

/vendor/symfony/yaml/Symfony/Component/Yaml/ -> Parser.php (summary)

(no description)

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

Defines 1 class

Parser:: (18 methods):
  __construct()
  parse()
  getRealCurrentLineNb()
  getCurrentLineIndentation()
  getNextEmbedBlock()
  moveToNextLine()
  moveToPreviousLine()
  parseValue()
  parseBlockScalar()
  isNextLineIndented()
  isCurrentLineEmpty()
  isCurrentLineBlank()
  isCurrentLineComment()
  isCurrentLineLastLineInDocument()
  cleanup()
  isNextLineUnIndentedCollection()
  isStringUnIndentedCollectionItem()
  isBlockScalarHeader()


Class: Parser  - X-Ref

Parser parses YAML strings to convert them to PHP arrays.

__construct($offset = 0, $totalNumberOfLines = null)   X-Ref
Constructor.

param: int      $offset             The offset of YAML document (used for line numbers in error messages)
param: int|null $totalNumberOfLines The overall number of lines being parsed

parse($value, $exceptionOnInvalidType = false, $objectSupport = false)   X-Ref
Parses a YAML string to a PHP value.

param: string $value                  A YAML string
param: bool   $exceptionOnInvalidType true if an exception must be thrown on invalid types (a PHP resource or object), false otherwise
param: bool   $objectSupport          true if object support is enabled, false otherwise
return: mixed A PHP value

getRealCurrentLineNb()   X-Ref
Returns the current line number (takes the offset into account).

return: int The current line number

getCurrentLineIndentation()   X-Ref
Returns the current line indentation.

return: int The current line indentation

getNextEmbedBlock($indentation = null, $inSequence = false)   X-Ref
Returns the next embed block of YAML.

param: int  $indentation The indent level at which the block is to be read, or null for default
param: bool $inSequence  True if the enclosing data structure is a sequence
return: string A YAML string

moveToNextLine()   X-Ref
Moves the parser to the next line.

return: bool

moveToPreviousLine()   X-Ref
Moves the parser to the previous line.


parseValue($value, $exceptionOnInvalidType, $objectSupport)   X-Ref
Parses a YAML value.

param: string $value                  A YAML value
param: bool   $exceptionOnInvalidType True if an exception must be thrown on invalid types false otherwise
param: bool   $objectSupport          True if object support is enabled, false otherwise
return: mixed A PHP value

parseBlockScalar($style, $chomping = '', $indentation = 0)   X-Ref
Parses a block scalar.

param: string $style       The style indicator that was used to begin this block scalar (| or >)
param: string $chomping    The chomping indicator that was used to begin this block scalar (+ or -)
param: int    $indentation The indentation indicator that was used to begin this block scalar
return: string The text value

isNextLineIndented()   X-Ref
Returns true if the next line is indented.

return: bool Returns true if the next line is indented, false otherwise

isCurrentLineEmpty()   X-Ref
Returns true if the current line is blank or if it is a comment line.

return: bool Returns true if the current line is empty or if it is a comment line, false otherwise

isCurrentLineBlank()   X-Ref
Returns true if the current line is blank.

return: bool Returns true if the current line is blank, false otherwise

isCurrentLineComment()   X-Ref
Returns true if the current line is a comment line.

return: bool Returns true if the current line is a comment line, false otherwise

isCurrentLineLastLineInDocument()   X-Ref
No description

cleanup($value)   X-Ref
Cleanups a YAML string to be parsed.

param: string $value The input YAML string
return: string A cleaned up YAML string

isNextLineUnIndentedCollection()   X-Ref
Returns true if the next line starts unindented collection.

return: bool Returns true if the next line starts unindented collection, false otherwise

isStringUnIndentedCollectionItem()   X-Ref
Returns true if the string is un-indented collection item.

return: bool Returns true if the string is un-indented collection item, false otherwise

isBlockScalarHeader()   X-Ref
Tests whether or not the current line is the header of a block scalar.

return: bool



Generated: Thu Jan 11 00:25:41 2018 Cross-referenced by PHPXref 0.7.1