<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/book.parle.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'class.parle-rparser.php',
    1 => 'Parle\\RParser',
    2 => 'The Parle\\RParser class',
  ),
  'up' => 
  array (
    0 => 'book.parle.php',
    1 => 'Parle',
  ),
  'prev' => 
  array (
    0 => 'parle-parser.validate.php',
    1 => 'Parle\\Parser::validate',
  ),
  'next' => 
  array (
    0 => 'parle-rparser.advance.php',
    1 => 'Parle\\RParser::advance',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/parle/parle.rparser.xml',
  ),
  'history' => 
  array (
  ),
  'extra_header_links' => 
  array (
    'rel' => 'alternate',
    'href' => '/manual/en/feeds/class.parle-rparser.atom',
    'type' => 'application/atom+xml',
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="class.parle-rparser" class="reference">

 <h1 class="title">The Parle\RParser class</h1>
 

 <div class="partintro"><p class="verinfo">(PECL parle &gt;= 0.7.0)</p>


  <div class="section" id="parle-rparser.intro">
   <h2 class="title">Introduction</h2>
   <p class="para">
    Parser class. Rules can be defined on the fly. Once finalized, a <span class="classname"><a href="class.parle-rlexer.php" class="classname">Parle\RLexer</a></span> instance is required to deliver the token stream.
   </p>
  </div>


  <div class="section" id="parle-rparser.synopsis">
   <h2 class="title">Class synopsis</h2>


   <div class="classsynopsis">
    <span class="ooclass"><strong class="classname"></strong></span>


    <div class="classsynopsisinfo">
     <span class="ooclass">
      <span class="modifier">class</span> <strong class="classname">Parle\RParser</strong>
     </span>
     {</div>

    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Constants */</div>
    <div class="fieldsynopsis">
     <span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.parle-rparser.php#parle-rparser.constants.action-error"><var class="varname">ACTION_ERROR</var></a></var><span class="initializer"> = 0</span>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.parle-rparser.php#parle-rparser.constants.action-shift"><var class="varname">ACTION_SHIFT</var></a></var><span class="initializer"> = 1</span>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.parle-rparser.php#parle-rparser.constants.action-reduce"><var class="varname">ACTION_REDUCE</var></a></var><span class="initializer"> = 2</span>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.parle-rparser.php#parle-rparser.constants.action-goto"><var class="varname">ACTION_GOTO</var></a></var><span class="initializer"> = 3</span>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.parle-rparser.php#parle-rparser.constants.action-accept"><var class="varname">ACTION_ACCEPT</var></a></var><span class="initializer"> = 4</span>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.parle-rparser.php#parle-rparser.constants.error-syntax"><var class="varname">ERROR_SYNTAX</var></a></var><span class="initializer"> = 0</span>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.parle-rparser.php#parle-rparser.constants.error-non-associative"><var class="varname">ERROR_NON_ASSOCIATIVE</var></a></var><span class="initializer"> = 1</span>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.parle-rparser.php#parle-rparser.constants.error-unknown-token"><var class="varname">ERROR_UNKNOWN_TOKEN</var></a></var><span class="initializer"> = 2</span>;</div>


    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Properties */</div>
    <div class="fieldsynopsis"><span class="modifier">public</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="varname"><a href="class.parle-rparser.php#parle-rparser.props.action">$<var class="varname">action</var></a></var><span class="initializer"> = 0</span>;</div>

    <div class="fieldsynopsis"><span class="modifier">public</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="varname"><a href="class.parle-rparser.php#parle-rparser.props.reduceId">$<var class="varname">reduceId</var></a></var><span class="initializer"> = 0</span>;</div>


    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
    <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><a href="parle-rparser.advance.php" class="methodname">advance</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="parle-rparser.build.php" class="methodname">build</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="parle-rparser.consume.php" class="methodname">consume</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$data</code></span>, <span class="methodparam"><span class="type"><a href="class.parle-rlexer.php" class="type Parle\RLexer">Parle\RLexer</a></span> <code class="parameter">$rlexer</code></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="parle-rparser.dump.php" class="methodname">dump</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="parle-rparser.errorinfo.php" class="methodname">errorInfo</a></span>(): <span class="type"><a href="class.parle-errorinfo.php" class="type Parle\ErrorInfo">Parle\ErrorInfo</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="parle-rparser.left.php" class="methodname">left</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$tok</code></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="parle-rparser.nonassoc.php" class="methodname">nonassoc</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$tok</code></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="parle-rparser.precedence.php" class="methodname">precedence</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$tok</code></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="parle-rparser.push.php" class="methodname">push</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$name</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$rule</code></span>): <span class="type"><a href="language.types.integer.php" class="type int">int</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="parle-rparser.reset.php" class="methodname">reset</a></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$tokenId</code><span class="initializer"> = ?</span></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="parle-rparser.right.php" class="methodname">right</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$tok</code></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="parle-rparser.sigil.php" class="methodname">sigil</a></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$idx</code><span class="initializer"> = ?</span></span>): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="parle-rparser.sigilcount.php" class="methodname">sigilCount</a></span>(): <span class="type"><a href="language.types.integer.php" class="type int">int</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="parle-rparser.sigilname.php" class="methodname">sigilName</a></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$idx</code></span>): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="parle-rparser.token.php" class="methodname">token</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$tok</code></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="parle-rparser.tokenid.php" class="methodname">tokenId</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$tok</code></span>): <span class="type"><a href="language.types.integer.php" class="type int">int</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="parle-rparser.trace.php" class="methodname">trace</a></span>(): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="parle-rparser.validate.php" class="methodname">validate</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$data</code></span>, <span class="methodparam"><span class="type"><a href="class.parle-rlexer.php" class="type Parle\RLexer">Parle\RLexer</a></span> <code class="parameter">$lexer</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

   }</div>


  </div>


  <div class="section" id="parle-rparser.constants">
   <h2 class="title">Predefined Constants</h2>
   <dl>

    
     <dt id="parle-rparser.constants.action-error"><strong><code><a href="class.parle-rparser.php#parle-rparser.constants.action-error">Parle\RParser::ACTION_ERROR</a></code></strong></dt>
     <dd>
      <p class="para"/>
     </dd>
    

    
     <dt id="parle-rparser.constants.action-shift"><strong><code><a href="class.parle-rparser.php#parle-rparser.constants.action-shift">Parle\RParser::ACTION_SHIFT</a></code></strong></dt>
     <dd>
      <p class="para"/>
     </dd>
    

    
     <dt id="parle-rparser.constants.action-reduce"><strong><code><a href="class.parle-rparser.php#parle-rparser.constants.action-reduce">Parle\RParser::ACTION_REDUCE</a></code></strong></dt>
     <dd>
      <p class="para"/>
     </dd>
    

    
     <dt id="parle-rparser.constants.action-goto"><strong><code><a href="class.parle-rparser.php#parle-rparser.constants.action-goto">Parle\RParser::ACTION_GOTO</a></code></strong></dt>
     <dd>
      <p class="para"/>
     </dd>
    

    
     <dt id="parle-rparser.constants.action-accept"><strong><code><a href="class.parle-rparser.php#parle-rparser.constants.action-accept">Parle\RParser::ACTION_ACCEPT</a></code></strong></dt>
     <dd>
      <p class="para"/>
     </dd>
    

    
     <dt id="parle-rparser.constants.error-syntax"><strong><code><a href="class.parle-rparser.php#parle-rparser.constants.error-syntax">Parle\RParser::ERROR_SYNTAX</a></code></strong></dt>
     <dd>
      <p class="para"/>
     </dd>
    

    
     <dt id="parle-rparser.constants.error-non-associative"><strong><code><a href="class.parle-rparser.php#parle-rparser.constants.error-non-associative">Parle\RParser::ERROR_NON_ASSOCIATIVE</a></code></strong></dt>
     <dd>
      <p class="para"/>
     </dd>
    

    
     <dt id="parle-rparser.constants.error-unknown-token"><strong><code><a href="class.parle-rparser.php#parle-rparser.constants.error-unknown-token">Parle\RParser::ERROR_UNKNOWN_TOKEN</a></code></strong></dt>
     <dd>
      <p class="para"/>
     </dd>
    

   </dl>
  </div>



  <div class="section" id="parle-rparser.props">
   <h2 class="title">Properties</h2>
   <dl>
    
     <dt id="parle-rparser.props.action"><var class="varname">action</var></dt>
     <dd>
      <p class="para">Current parser action that matches one of the action class constants, readonly.</p>
     </dd>
    
    
     <dt id="parle-rparser.props.reduceId"><var class="varname">reduceId</var></dt>
     <dd>
      <p class="para">Grammar rule id just processed in the reduce action. The value corresponds either to a token or to a production id. Readonly.</p>
     </dd>
    
   </dl>
  </div>


 </div>

 
 






























































































































<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="parle-rparser.advance.php">Parle\RParser::advance</a> — Process next parser rule</li><li><a href="parle-rparser.build.php">Parle\RParser::build</a> — Finalize the grammar rules</li><li><a href="parle-rparser.consume.php">Parle\RParser::consume</a> — Consume the data for processing</li><li><a href="parle-rparser.dump.php">Parle\RParser::dump</a> — Dump the grammar</li><li><a href="parle-rparser.errorinfo.php">Parle\RParser::errorInfo</a> — Retrieve the error information</li><li><a href="parle-rparser.left.php">Parle\RParser::left</a> — Declare a token with left-associativity</li><li><a href="parle-rparser.nonassoc.php">Parle\RParser::nonassoc</a> — Declare a token with no associativity</li><li><a href="parle-rparser.precedence.php">Parle\RParser::precedence</a> — Declare a precedence rule</li><li><a href="parle-rparser.push.php">Parle\RParser::push</a> — Add a grammar rule</li><li><a href="parle-rparser.reset.php">Parle\RParser::reset</a> — Reset parser state</li><li><a href="parle-rparser.right.php">Parle\RParser::right</a> — Declare a token with right-associativity</li><li><a href="parle-rparser.sigil.php">Parle\RParser::sigil</a> — Retrieve a matching part of a rule</li><li><a href="parle-rparser.sigilcount.php">Parle\RParser::sigilCount</a> — Number of elements in matched rule</li><li><a href="parle-rparser.sigilname.php">Parle\RParser::sigilName</a> — Retrieve a rule or token name</li><li><a href="parle-rparser.token.php">Parle\RParser::token</a> — Declare a token</li><li><a href="parle-rparser.tokenid.php">Parle\RParser::tokenId</a> — Get token id</li><li><a href="parle-rparser.trace.php">Parle\RParser::trace</a> — Trace the parser operation</li><li><a href="parle-rparser.validate.php">Parle\RParser::validate</a> — Validate input</li></ul>
</div>
<?php manual_footer($setup); ?>