From 8ee23b4f18f9aa0105a1b339758f61f4aeccd2bf Mon Sep 17 00:00:00 2001 From: Philip Olson Date: Tue, 15 Jul 2008 22:41:05 +0000 Subject: [PATCH] added new inclued documentation git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@262786 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/inclued/book.xml | 52 +++++++++ reference/inclued/configure.xml | 38 ++++++ reference/inclued/constants.xml | 32 ++++++ reference/inclued/examples.xml | 81 +++++++++++++ .../inclued/functions/inclued-get-data.xml | 108 ++++++++++++++++++ reference/inclued/ini.xml | 100 ++++++++++++++++ reference/inclued/reference.xml | 30 +++++ reference/inclued/setup.xml | 49 ++++++++ 8 files changed, 490 insertions(+) create mode 100644 reference/inclued/book.xml create mode 100644 reference/inclued/configure.xml create mode 100644 reference/inclued/constants.xml create mode 100644 reference/inclued/examples.xml create mode 100644 reference/inclued/functions/inclued-get-data.xml create mode 100644 reference/inclued/ini.xml create mode 100644 reference/inclued/reference.xml create mode 100644 reference/inclued/setup.xml diff --git a/reference/inclued/book.xml b/reference/inclued/book.xml new file mode 100644 index 0000000000..047fd91618 --- /dev/null +++ b/reference/inclued/book.xml @@ -0,0 +1,52 @@ + + + + + + + Inclusion hierarchy viewer + inclued + + + &reftitle.intro; + + Traces through and dumps the hierarchy of file inclusions and class inheritance at runtime. + + + The files may have been included using + include, include_once, + require, or require_once. + + + Class inheritance dependencies are also reported. + + + + &reference.inclued.setup; + &reference.inclued.constants; + &reference.inclued.examples; + &reference.inclued.reference; + + + + + diff --git a/reference/inclued/configure.xml b/reference/inclued/configure.xml new file mode 100644 index 0000000000..177e2dfbf7 --- /dev/null +++ b/reference/inclued/configure.xml @@ -0,0 +1,38 @@ + + + +
+ &reftitle.install; + + + &pecl.info; + &url.pecl.package;inclued + + + The latest PECL/inclued Win32 DLL is available here: + php_inclued.dll + + +
+ + + diff --git a/reference/inclued/constants.xml b/reference/inclued/constants.xml new file mode 100644 index 0000000000..f71f250de1 --- /dev/null +++ b/reference/inclued/constants.xml @@ -0,0 +1,32 @@ + + + + + &reftitle.constants; + &extension.constants; + + &no.constants; + + + + + diff --git a/reference/inclued/examples.xml b/reference/inclued/examples.xml new file mode 100644 index 0000000000..ad870715a9 --- /dev/null +++ b/reference/inclued/examples.xml @@ -0,0 +1,81 @@ + + + + + &reftitle.examples; + +
+ Example that implements inclued into an application + + This example demonstrates the process of implementing inclued into + an existing application, and viewing the results. + + + + Getting the data from inclued + + +]]> + + + + + Now that some data exists, it's time to make sense of it in the form of + a graph. The inclued extension includes a PHP file named + gengraph.php that creates a dot file that + requires the graphviz library. + However, this form is not required. + + + + Example use of gengraph.php + + This example creates an image named inclued.png that + shows the inclued data. + + + + + + +
+ + + + diff --git a/reference/inclued/functions/inclued-get-data.xml b/reference/inclued/functions/inclued-get-data.xml new file mode 100644 index 0000000000..a8a288eebe --- /dev/null +++ b/reference/inclued/functions/inclued-get-data.xml @@ -0,0 +1,108 @@ + + + + + inclued_get_data + Get the inclued data + + + + &reftitle.description; + + arrayinclued_get_data + + + + Get the inclued data. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The inclued data. + + + + + &reftitle.examples; + + + <function>inclued_get_data</function> example + + See the inclued examples + section for ways to create a graphs with this data. + + + +]]> + + &example.outputs.similar; + + Array + ( + [0] => Array + ( + [operation] => include + [op_type] => 2 + [filename] => x.php + [opened_path] => /tmp/x.php + [fromfile] => /tmp/z.php + [fromline] => 2 + ) + ) +) +]]> + + + + + + + &reftitle.seealso; + + + inclued examples + debug_backtrace + include + + + + + + + diff --git a/reference/inclued/ini.xml b/reference/inclued/ini.xml new file mode 100644 index 0000000000..0bd328e520 --- /dev/null +++ b/reference/inclued/ini.xml @@ -0,0 +1,100 @@ + + + +
+ &reftitle.runtime; + &extension.runtime; + + + + inclued &ConfigureOptions; + + + + &Name; + &Default; + &Changeable; + Changelog + + + + + inclued.enabled + Off + PHP_INI_* + + + + inclued.dumpdir + Off + PHP_INI_* + + + + +
+ + &ini.php.constants; + + + + &ini.descriptions.title; + + + + + + + inclued.enabled + int + + + + Whether or not to enable inclued. + + + + + + + inclued.dumpdir + int + + + + Location (path) to the directory that stores inclued files. If set, each + PHP request will create a file. + + + + Because every request creates a file, this directory may fill up fast! + + + + + + + +
+ + + diff --git a/reference/inclued/reference.xml b/reference/inclued/reference.xml new file mode 100644 index 0000000000..abab7e267e --- /dev/null +++ b/reference/inclued/reference.xml @@ -0,0 +1,30 @@ + + + + + inclued &Functions; + + &reference.inclued.entities.functions; + + + + diff --git a/reference/inclued/setup.xml b/reference/inclued/setup.xml new file mode 100644 index 0000000000..43b1b45044 --- /dev/null +++ b/reference/inclued/setup.xml @@ -0,0 +1,49 @@ + + + + + &reftitle.setup; + +
+ &reftitle.required; + + PHP version 5.1.0 or greater. + + + The included gengraph.php file utilizes + the graphviz library, + however, this is not required. + +
+ + &reference.inclued.configure; + &reference.inclued.ini; + +
+ &reftitle.resources; + &no.resource; +
+ + + + +