php-doc-en/reference/parsekit/functions/parsekit-compile-string.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<refentry id="function.parsekit-compile-string">
 <refnamediv>
  <refname>parsekit_compile_string</refname>
  <refpurpose>Compile a string of PHP code and return the resulting op array</refpurpose>
 </refnamediv>
 <refsect1>
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>parsekit_compile_string</methodname>
   <methodparam><type>string</type><parameter>phpcode</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter role="reference">errors</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
  </methodsynopsis>
  &warn.experimental.func;
 </refsect1>
 <refsect1>
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>phpcode</parameter></term>
     <listitem>
      <para>
       A string containing phpcode. Similar to the argument to <function>eval</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>errors</parameter></term>
     <listitem>
      <para>
       A 2D hash of errors (including fatal errors) encountered during compilation.
       Returned by reference.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>options</parameter></term>
     <listitem>
      <para>
       One of either <constant>PARSEKIT_QUIET</constant> or 
       <constant>PARSEKIT_SIMPLE</constant>. To produce varying
       degrees of verbosity in the returned output.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1>
  &reftitle.returnvalues;
  <para>
   Returns a complex multi-layer array structure as detailed below.
  </para>
 </refsect1>
 <!-- No changelog: it's only in PECL. -->
 <refsect1>
  &reftitle.examples;
  <para>
   <example>
    <title><function>parsekit_compile_string</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
  $ops = parsekit_compile_string('
echo "Foo\n";
', $errors, PARSEKIT_QUIET);

  var_dump($ops);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
array(20) {
  ["type"]=>
  int(4)
  ["type_name"]=>
  string(14) "ZEND_EVAL_CODE"
  ["fn_flags"]=>
  int(0)
  ["num_args"]=>
  int(0)
  ["required_num_args"]=>
  int(0)
  ["pass_rest_by_reference"]=>
  bool(false)
  ["uses_this"]=>
  bool(false)
  ["line_start"]=>
  int(0)
  ["line_end"]=>
  int(0)
  ["return_reference"]=>
  bool(false)
  ["refcount"]=>
  int(1)
  ["last"]=>
  int(3)
  ["size"]=>
  int(3)
  ["T"]=>
  int(0)
  ["last_brk_cont"]=>
  int(0)
  ["current_brk_cont"]=>
  int(-1)
  ["backpatch_count"]=>
  int(0)
  ["done_pass_two"]=>
  bool(true)
  ["filename"]=>
  string(17) "Parsekit Compiler"
  ["opcodes"]=>
  array(3) {
    [8594800]=>
    array(5) {
      ["opcode"]=>
      int(40)
      ["opcode_name"]=>
      string(9) "ZEND_ECHO"
      ["flags"]=>
      int(768)
      ["op1"]=>
      array(3) {
        ["type"]=>
        int(1)
        ["type_name"]=>
        string(8) "IS_CONST"
        ["constant"]=>
        &string(4) "Foo
"
      }
      ["lineno"]=>
      int(2)
    }
    ["859484C"]=>
    array(6) {
      ["opcode"]=>
      int(62)
      ["opcode_name"]=>
      string(11) "ZEND_RETURN"
      ["flags"]=>
      int(16777984)
      ["op1"]=>
      array(3) {
        ["type"]=>
        int(1)
        ["type_name"]=>
        string(8) "IS_CONST"
        ["constant"]=>
        &NULL
      }
      ["extended_value"]=>
      int(0)
      ["lineno"]=>
      int(3)
    }
    [8594898]=>
    array(4) {
      ["opcode"]=>
      int(149)
      ["opcode_name"]=>
      string(21) "ZEND_HANDLE_EXCEPTION"
      ["flags"]=>
      int(0)
      ["lineno"]=>
      int(3)
    }
  }
}
]]>
    </screen>
   </example>
  </para>
 </refsect1>
 <refsect1>
  &reftitle.seealso;
  <para>
   <function>parsekit_compile_file</function>
  </para>
 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->