[PHP-DOC] cvs: phpdoc /en/reference/runkit constants.xml /en/reference/runkit/functions runkit-import.xml

[Sara Golemon]

pollita         Mon May  2 15:50:54 2005 EDT

  Added files:                 
    /phpdoc/en/reference/runkit/functions       runkit-import.xml 

  Modified files:              
    /phpdoc/en/reference/runkit constants.xml 
  Log:
  Define runkit_import()
  
http://cvs.php.net/diff.php/phpdoc/en/reference/runkit/constants.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/runkit/constants.xml
diff -u phpdoc/en/reference/runkit/constants.xml:1.2 
phpdoc/en/reference/runkit/constants.xml:1.3
--- phpdoc/en/reference/runkit/constants.xml:1.2        Sun May  1 05:08:13 2005
+++ phpdoc/en/reference/runkit/constants.xml    Mon May  2 15:50:53 2005
@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. 
-->
 <section id="runkit.constants">
  &reftitle.constants;
@@ -12,7 +12,9 @@
    </term>
    <listitem>
     <simpara>
-     <function>runkit_import</function> flag
+     <function>runkit_import</function> flag indicating
+     that normal functions should be imported from the
+     specified file.
     </simpara>
    </listitem>
   </varlistentry>
@@ -23,7 +25,9 @@
    </term>
    <listitem>
     <simpara>
-     <function>runkit_import</function> flag
+     <function>runkit_import</function> flag indicating
+     that class methods should be imported from the
+     specified file.
     </simpara>
    </listitem>
   </varlistentry>
@@ -34,7 +38,10 @@
    </term>
    <listitem>
     <simpara>
-     <function>runkit_import</function> flag
+     <function>runkit_import</function> flag indicating
+     that class constants should be imported from the
+     specified file.  Note that this flag is only meaningful
+     in PHP versions 5.1.0 and above.
     </simpara>
    </listitem>
   </varlistentry>
@@ -45,7 +52,9 @@
    </term>
    <listitem>
     <simpara>
-     <function>runkit_import</function> flag
+     <function>runkit_import</function> flag indicating
+     that class standard properties should be imported
+     from the specified file.
     </simpara>
    </listitem>
   </varlistentry>
@@ -56,18 +65,24 @@
    </term>
    <listitem>
     <simpara>
-     <function>runkit_import</function> flag
+     <function>runkit_import</function> flag representing
+     a bitwise OR of the <constant>RUNKIT_IMPORT_CLASS_*</constant>
+     constants.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
-    <constant>RUNKIT_IMPORT_OVERRIDE</constant>
+    <constant>RUNKIT_IMPORT_OVERRIDE</constant> 
      (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
-     <function>runkit_import</function> flag
+     <function>runkit_import</function> flag indicating that
+     if any of the imported functions, methods, constants,
+     or properties already exist, they should be replaced with
+     the new definitions.  If this flag is not set, then any
+     imported definitions which already exist will be discarded.
     </simpara>
    </listitem>
   </varlistentry>

http://cvs.php.net/co.php/phpdoc/en/reference/runkit/functions/runkit-import.xml?r=1.1&p=1
Index: phpdoc/en/reference/runkit/functions/runkit-import.xml
+++ phpdoc/en/reference/runkit/functions/runkit-import.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.runkit-import">
 <refnamediv>
  <refname>runkit_import</refname>
  <refpurpose>
   Process a PHP file importing function and class definitions, overwriting 
where appropriate
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>runkit_import</methodname>
   <methodparam><type>string</type><parameter>filename</parameter></methodparam>
   <methodparam 
choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
  </methodsynopsis>
  <para>
   Similar to <function>include</function> however any code residing outside
   of a function or class is simply ignored.
   Additionally, depending on the value of <parameter>flags</parameter>,
   any functions or classes which already exist in the currently running 
environment
   will be automatically overwritten by their new definitions.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       Filename to import function and class definitions from
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Bitwise OR of the <constant>RUNKIT_IMPORT_*</constant> family of 
constants.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </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
-->