php-doc-en/reference/runkit/functions/runkit-import.xml
Dmitry Zenovich ffa0c6ba23 runkit: describe changes of 1.0.1
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@338018 c90b9560-bf6c-de11-be94-00142212c4b1
2015-10-22 11:28:17 +00:00

104 lines
3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry xml:id="function.runkit-import" xmlns="http://docbook.org/ns/docbook">
<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><initializer>RUNKIT_IMPORT_CLASS_METHODS</initializer></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
may 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 <link linkend="runkit.constants"><literal>RUNKIT_IMPORT_*</literal>
family of constants</link>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>runkit_import</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// import classes entirely
runkit_import('myfile.inc', RUNKIT_IMPORT_CLASSES);
/* import classes, but not imports their static properties
(RUNKIT_IMPORT_CLASS_STATIC_PROPS is available since 1.0.1) */
runkit_import('myfile.inc', RUNKIT_IMPORT_CLASSES & ~RUNKIT_IMPORT_CLASS_STATIC_PROPS);
/* import only static properties of classes
(RUNKIT_IMPORT_CLASS_STATIC_PROPS is available since 1.0.1) */
runkit_import('myfile.inc', RUNKIT_IMPORT_CLASS_STATIC_PROPS);
?>
]]>
</programlisting>
</example>
</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:"~/.phpdoc/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
-->