php/archived-doc-en
1
0
Fork 0
mirror of https://github.com/php/doc-en.git synced 2026-03-23 23:32:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

componere: fix XML by converting para to simpara tags via script (#5152)

Browse Source
This commit is contained in:
Gina Peter Banyard
2026-01-18 22:59:13 +00:00
committed by GitHub
parent 22492de2ee
commit 6dcc757d98
40 changed files with 327 additions and 406 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
reference/componere/book.xml
View File

@@ -1,33 +1,32 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<book xml:id="book.componere" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="book.componere">
<?phpdoc extension-membership="pecl" ?>
<title>Componere</title>
<titleabbrev>Componere</titleabbrev>
<preface xml:id="intro.componere">
&reftitle.intro;
<para>
Componere <subscript>(latin, English: compose)</subscript> targets production environments and provides an API for
<simpara>
Componere <subscript>(latin, English: compose)</subscript> targets production environments and provides an API for
composition of classes, monkey patching, and casting.
</para>
</simpara>
<formalpara>
<title>Composition:</title>
<para>
<classname>Componere\Definition</classname> is used to define (or redefine) a class at runtime;
The class can then be registered, and in the case of redefinition it replaces the original class
<classname>Componere\Definition</classname> is used to define (or redefine) a class at runtime;
The class can then be registered, and in the case of redefinition it replaces the original class
for as long as the <classname>Componere\Definition</classname> exists.
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.componere-definition')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.componere-definition')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])"/>
</para>
</formalpara>
<formalpara>
<title>Patching:</title>
<para>
<classname>Componere\Patch</classname> is used to change the class of a specific instance of an object at runtime;
<classname>Componere\Patch</classname> is used to change the class of a specific instance of an object at runtime;
Upon application the patch will remain applied for as long as the <classname>Componere\Patch</classname> exists, and can be reverted explicitly.
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.componere-patch')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.componere-patch')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])"/>
</para>
</formalpara>
@@ -36,8 +35,8 @@
<para>
<classname>Componere\</classname> casting functions can cast among user defined compatible types;
Where compatible means <classname>Type</classname> is sub or super to the type of <parameter>object</parameter>.
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('componere.cast')/db:refsect1[@role='description']/descendant::db:methodsynopsis)" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('componere.cast_by_ref')/db:refsect1[@role='description']/descendant::db:methodsynopsis)" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('componere.cast')/db:refsect1[@role='description']/descendant::db:methodsynopsis)"/>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('componere.cast_by_ref')/db:refsect1[@role='description']/descendant::db:methodsynopsis)"/>
</para>
</formalpara>
@@ -51,7 +50,6 @@
&reference.componere.componere.value;
&reference.componere.reference;
</book>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

12
reference/componere/componere.abstract.definition.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.componere-abstract-definition" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.componere-abstract-definition" role="class">
<title>The Componere\Abstract\Definition class</title>
<titleabbrev>Componere\Abstract\Definition</titleabbrev>
@@ -11,9 +10,9 @@
<!-- {{{ Componere\Abstract\Definition intro -->
<section xml:id="componere-abstract-definition.intro">
&reftitle.intro;
<para>
<simpara>
This final abstract represents a class entry, and should not be used by the programmer.
</para>
</simpara>
</section>
<!-- }}} -->
@@ -33,9 +32,9 @@
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.componere-abstract-definition')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.componere-abstract-definition')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
</classsynopsis>
<!-- }}} -->
@@ -46,7 +45,6 @@
&reference.componere.componere.abstract.entities.definition;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

22
reference/componere/componere.definition.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.componere-definition" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.componere-definition" role="class">
<title>The Componere\Definition class</title>
<titleabbrev>Componere\Definition</titleabbrev>
@@ -11,12 +10,12 @@
<!-- {{{ Componere\Definition intro -->
<section xml:id="componere-definition.intro">
&reftitle.intro;
<para>
<simpara>
The Definition class allows the programmer to build and register a type at runtime.
</para>
<para>
</simpara>
<simpara>
Should a Definition replace an existing class, the existing class will be restored when the Definition is destroyed.
</para>
</simpara>
</section>
<!-- }}} -->
@@ -35,7 +34,7 @@
<modifier>final</modifier>
<classname>Componere\Definition</classname>
</ooclass>
<ooclass>
<modifier>extends</modifier>
<classname>Componere\Abstract\Definition</classname>
@@ -44,13 +43,13 @@
<!-- }}} -->
<classsynopsisinfo role="comment">Constructors</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.componere-definition')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.componere-definition')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])"/>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.componere-definition')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.componere-definition')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.componere-abstract-definition')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.componere-abstract-definition')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
</classsynopsis>
<!-- }}} -->
@@ -67,7 +66,6 @@
&reference.componere.componere.definition.getclosure;
&reference.componere.componere.definition.getclosures;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

14
reference/componere/componere.method.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.componere-method" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.componere-method" role="class">
<title>The Componere\Method class</title>
<titleabbrev>Componere\Method</titleabbrev>
@@ -11,9 +10,9 @@
<!-- {{{ Componere\Method intro -->
<section xml:id="componere-method.intro">
&reftitle.intro;
<para>
<simpara>
A Method represents a function with modifiable accessibility flags
</para>
</simpara>
</section>
<!-- }}} -->
@@ -34,10 +33,10 @@
<!-- }}} -->
<classsynopsisinfo role="comment">Constructor</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.componere-method')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.componere-method')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])"/>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.componere-method')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.componere-method')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
</classsynopsis>
<!-- }}} -->
@@ -52,7 +51,6 @@
&reference.componere.componere.method.getreflector;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

24
reference/componere/componere.patch.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.componere-patch" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.componere-patch" role="class">
<title>The Componere\Patch class</title>
<titleabbrev>Componere\Patch</titleabbrev>
@@ -11,12 +10,12 @@
<!-- {{{ Componere\Patch intro -->
<section xml:id="componere-patch.intro">
&reftitle.intro;
<para>
<simpara>
The Patch class allows the programmer to change the type of an instance at runtime without registering a new Definition
</para>
<para>
</simpara>
<simpara>
When a Patch is destroyed it is reverted, so that instances that were patched during the lifetime of the Patch are restored to their formal type.
</para>
</simpara>
</section>
<!-- }}} -->
@@ -33,7 +32,7 @@
<modifier>final</modifier>
<classname>Componere\Patch</classname>
</ooclass>
<ooclass>
<modifier>extends</modifier>
<classname>Componere\Abstract\Definition</classname>
@@ -42,13 +41,13 @@
<!-- }}} -->
<classsynopsisinfo role="comment">Constructors</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.componere-patch')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.componere-patch')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])"/>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.componere-patch')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.componere-patch')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.componere-abstract-definition')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.componere-abstract-definition')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
</classsynopsis>
<!-- }}} -->
@@ -66,7 +65,6 @@
&reference.componere.componere.patch.getclosures;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

14
reference/componere/componere.value.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.componere-value" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.componere-value" role="class">
<title>The Componere\Value class</title>
<titleabbrev>Componere\Value</titleabbrev>
@@ -11,9 +10,9 @@
<!-- {{{ Componere\Value intro -->
<section xml:id="componere-value.intro">
&reftitle.intro;
<para>
<simpara>
A Value represents a PHP variable of all types, including undefined
</para>
</simpara>
</section>
<!-- }}} -->
@@ -34,10 +33,10 @@
<!-- }}} -->
<classsynopsisinfo role="comment">Constructor</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.componere-value')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.componere-value')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])"/>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.componere-value')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.componere-value')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
</classsynopsis>
<!-- }}} -->
@@ -55,7 +54,6 @@
&reference.componere.componere.value.hasdefault;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/componere/componere/abstract/definition/addinterface.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere-abstract-definition.addinterface" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere-abstract-definition.addinterface">
<refnamediv>
<refname>Componere\Abstract\Definition::addInterface</refname>
<refpurpose>Add Interface</refpurpose>
@@ -13,9 +12,9 @@
<modifier>public</modifier> <type>Definition</type><methodname>Componere\Abstract\Definition::addInterface</methodname>
<methodparam><type>string</type><parameter>interface</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Shall implement the given interface on the current definition
</para>
</simpara>
</refsect1>
@@ -25,9 +24,9 @@
<varlistentry>
<term><parameter>interface</parameter></term>
<listitem>
<para>
<simpara>
The case insensitive name of an interface
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -35,22 +34,21 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The current Definition
</para>
</simpara>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
<simpara>
Shall throw <type>RuntimeException</type> if <type>Definition</type> was registered
</para>
</simpara>
</warning>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

28
reference/componere/componere/abstract/definition/addmethod.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere-abstract-definition.addmethod" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere-abstract-definition.addmethod">
<refnamediv>
<refname>Componere\Abstract\Definition::addMethod</refname>
<refpurpose>Add Method</refpurpose>
@@ -14,9 +13,9 @@
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>Componere\Method</type><parameter>method</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Shall create or override a method on the current definition.
</para>
</simpara>
</refsect1>
@@ -26,17 +25,17 @@
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
<simpara>
The case insensitive name for method
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>method</parameter></term>
<listitem>
<para>
<simpara>
<type>Componere\Method</type> not previously added to another <type>Definition</type>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -44,28 +43,27 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The current Definition
</para>
</simpara>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
<simpara>
Shall throw <type>RuntimeException</type> if <type>Definition</type> was registered
</para>
</simpara>
</warning>
<warning>
<para>
<simpara>
Shall throw <type>RuntimeException</type> if Method was added to another Definition
</para>
</simpara>
</warning>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/componere/componere/abstract/definition/addtrait.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere-abstract-definition.addtrait" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere-abstract-definition.addtrait">
<refnamediv>
<refname>Componere\Abstract\Definition::addTrait</refname>
<refpurpose>Add Trait</refpurpose>
@@ -13,9 +12,9 @@
<modifier>public</modifier> <type>Definition</type><methodname>Componere\Abstract\Definition::addTrait</methodname>
<methodparam><type>string</type><parameter>trait</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Shall use the given trait for the current definition
</para>
</simpara>
</refsect1>
@@ -25,9 +24,9 @@
<varlistentry>
<term><parameter>trait</parameter></term>
<listitem>
<para>
<simpara>
The case insensitive name of a trait
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -35,23 +34,22 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The current Definition
</para>
</simpara>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
<simpara>
Shall throw <type>RuntimeException</type> if <type>Definition</type> was registered
</para>
</simpara>
</warning>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

14
reference/componere/componere/abstract/definition/getreflector.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere-abstract-definition.getreflector" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere-abstract-definition.getreflector">
<refnamediv>
<refname>Componere\Abstract\Definition::getReflector</refname>
<refpurpose>Reflection</refpurpose>
@@ -11,24 +10,23 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>ReflectionClass</type><methodname>Componere\Abstract\Definition::getReflector</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Shall create or return a ReflectionClass
</para>
</simpara>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
A ReflectionClass for the current definition (cached)
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

36
reference/componere/componere/definition/addconstant.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere-definition.addconstant" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere-definition.addconstant">
<refnamediv>
<refname>Componere\Definition::addConstant</refname>
<refpurpose>Add Constant</refpurpose>
@@ -14,9 +13,9 @@
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>Componere\Value</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Shall declare a class constant on the current Definition
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,17 +24,17 @@
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
<simpara>
The case sensitive name for the constant
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
<simpara>
The Value for the constant, must not be undefined or static
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -43,37 +42,36 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The current Definition
</para>
</simpara>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
<simpara>
Shall throw <type>RuntimeException</type> if <type>Definition</type> was registered
</para>
</simpara>
</warning>
<warning>
<para>
<simpara>
Shall throw <type>RuntimeException</type> if <parameter>name</parameter> is already declared as a constant
</para>
</simpara>
</warning>
<warning>
<para>
<simpara>
Shall throw <type>RuntimeException</type> if <parameter>value</parameter> is static
</para>
</simpara>
</warning>
<warning>
<para>
<simpara>
Shall throw <type>RuntimeException</type> if <parameter>value</parameter> is undefined
</para>
</simpara>
</warning>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

28
reference/componere/componere/definition/addproperty.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere-definition.addproperty" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere-definition.addproperty">
<refnamediv>
<refname>Componere\Definition::addProperty</refname>
<refpurpose>Add Property</refpurpose>
@@ -14,9 +13,9 @@
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>Componere\Value</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Shall declare a class property on the current Definition
</para>
</simpara>
</refsect1>
@@ -26,17 +25,17 @@
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
<simpara>
The case sensitive name for the property
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
<simpara>
The default Value for the property
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -44,27 +43,26 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The current Definition
</para>
</simpara>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
<simpara>
Shall throw <type>RuntimeException</type> if <type>Definition</type> was registered
</para>
</simpara>
</warning>
<warning>
<para>
<simpara>
Shall throw <type>RuntimeException</type> if <parameter>name</parameter> is already declared as a property
</para>
</simpara>
</warning>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

36
reference/componere/componere/definition/construct.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere-definition.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere-definition.construct">
<refnamediv>
<refname>Componere\Definition::__construct</refname>
<refpurpose>Definition Construction</refpurpose>
@@ -41,25 +40,25 @@
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
<simpara>
A case insensitive class name
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>parent</parameter></term>
<listitem>
<para>
<simpara>
A case insensitive class name
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>interfaces</parameter></term>
<listitem>
<para>
<simpara>
An array of case insensitive class names
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -68,34 +67,33 @@
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
<simpara>
Shall throw <type>InvalidArgumentException</type> if an attempt is made to replace an internal class
</para>
</simpara>
</warning>
<warning>
<para>
<simpara>
Shall throw <type>InvalidArgumentException</type> if an attempt is made to replace an interface
</para>
</simpara>
</warning>
<warning>
<para>
<simpara>
Shall throw <type>InvalidArgumentException</type> if an attempt is made to replace a trait
</para>
</simpara>
</warning>
<warning>
<para>
<simpara>
Shall throw <type>RuntimeException</type> if a class in <parameter>interfaces</parameter> cannot be found
</para>
</simpara>
</warning>
<warning>
<para>
<simpara>
Shall throw <type>RuntimeException</type> if a class in <parameter>interfaces</parameter> is not an interface
</para>
</simpara>
</warning>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

24
reference/componere/componere/definition/getclosure.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere-definition.getclosure" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere-definition.getclosure">
<refnamediv>
<refname>Componere\Definition::getClosure</refname>
<refpurpose>Get Closure</refpurpose>
@@ -13,9 +12,9 @@
<modifier>public</modifier> <type>Closure</type><methodname>Componere\Definition::getClosure</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Shall return a Closure for the method specified by name
</para>
</simpara>
</refsect1>
@@ -25,9 +24,9 @@
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
<simpara>
The case insensitive name of the method
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -35,27 +34,26 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
A Closure bound to the correct scope
</para>
</simpara>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
<simpara>
Shall throw <type>RuntimeException</type> if <type>Definition</type> was registered
</para>
</simpara>
</warning>
<warning>
<para>
<simpara>
Shall throw <type>RuntimeException</type> if <parameter>name</parameter> could not be found
</para>
</simpara>
</warning>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/componere/componere/definition/getclosures.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere-definition.getclosures" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere-definition.getclosures">
<refnamediv>
<refname>Componere\Definition::getClosures</refname>
<refpurpose>Get Closures</refpurpose>
@@ -11,32 +10,31 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>Componere\Definition::getClosures</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Shall return an array of Closures
</para>
</simpara>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Shall return all methods as an array of Closure objects bound to the correct scope
</para>
</simpara>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
<simpara>
Shall throw <type>RuntimeException</type> if <type>Definition</type> was registered
</para>
</simpara>
</warning>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

14
reference/componere/componere/definition/isregistered.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere-definition.isregistered" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere-definition.isregistered">
<refnamediv>
<refname>Componere\Definition::isRegistered</refname>
<refpurpose>State Detection</refpurpose>
@@ -11,23 +10,22 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>Componere\Definition::isRegistered</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Shall detect the registration state of this Definition
</para>
</simpara>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Shall return true if this Definition is registered
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

14
reference/componere/componere/definition/register.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere-definition.register" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere-definition.register">
<refnamediv>
<refname>Componere\Definition::register</refname>
<refpurpose>Registration</refpurpose>
@@ -11,25 +10,24 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Componere\Definition::register</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Shall register the current Definition
</para>
</simpara>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
<simpara>
Shall throw <type>RuntimeException</type> if <type>Definition</type> was registered
</para>
</simpara>
</warning>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

10
reference/componere/componere/method/construct.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere-method.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere-method.construct">
<refnamediv>
<refname>Componere\Method::__construct</refname>
<refpurpose>Method Construction</refpurpose>
@@ -22,9 +21,9 @@
<varlistentry>
<term><parameter>closure</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -33,7 +32,6 @@
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

14
reference/componere/componere/method/getreflector.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere-method.getreflector" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere-method.getreflector">
<refnamediv>
<refname>Componere\Method::getReflector</refname>
<refpurpose>Reflection</refpurpose>
@@ -11,23 +10,22 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>ReflectionMethod</type><methodname>Componere\Method::getReflector</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Shall create or return a ReflectionMethod
</para>
</simpara>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
A ReflectionMethod for the current method (cached)
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

14
reference/componere/componere/method/setprivate.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere-method.setprivate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere-method.setprivate">
<refnamediv>
<refname>Componere\Method::setPrivate</refname>
<refpurpose>Accessibility Modification</refpurpose>
@@ -11,28 +10,27 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>Method</type><methodname>Componere\Method::setPrivate</methodname>
<void />
<void/>
</methodsynopsis>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The current Method
</para>
</simpara>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
<simpara>
Shall throw <type>RuntimeException</type> if access level was previously set
</para>
</simpara>
</warning>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

14
reference/componere/componere/method/setprotected.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere-method.setprotected" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere-method.setprotected">
<refnamediv>
<refname>Componere\Method::setProtected</refname>
<refpurpose>Accessibility Modification</refpurpose>
@@ -11,29 +10,28 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>Method</type><methodname>Componere\Method::setProtected</methodname>
<void />
<void/>
</methodsynopsis>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The current Method
</para>
</simpara>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
<simpara>
Shall throw <type>RuntimeException</type> if access level was previously set
</para>
</simpara>
</warning>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

10
reference/componere/componere/method/setstatic.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere-method.setstatic" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere-method.setstatic">
<refnamediv>
<refname>Componere\Method::setStatic</refname>
<refpurpose>Accessibility Modification</refpurpose>
@@ -11,20 +10,19 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>Method</type><methodname>Componere\Method::setStatic</methodname>
<void />
<void/>
</methodsynopsis>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The current Method
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

10
reference/componere/componere/patch/apply.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere-patch.apply" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere-patch.apply">
<refnamediv>
<refname>Componere\Patch::apply</refname>
<refpurpose>Application</refpurpose>
@@ -11,17 +10,16 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Componere\Patch::apply</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Shall apply the current patch
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/componere/componere/patch/construct.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere-patch.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere-patch.construct">
<refnamediv>
<refname>Componere\Patch::__construct</refname>
<refpurpose>Patch Construction</refpurpose>
@@ -27,17 +26,17 @@
<varlistentry>
<term><parameter>instance</parameter></term>
<listitem>
<para>
<simpara>
The target for this Patch
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>interfaces</parameter></term>
<listitem>
<para>
<simpara>
A case insensitive array of class names
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -46,19 +45,18 @@
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
<simpara>
Shall throw <type>RuntimeException</type> if a class in <parameter>interfaces</parameter> cannot be found
</para>
</simpara>
</warning>
<warning>
<para>
<simpara>
Shall throw <type>RuntimeException</type> if a class in <parameter>interfaces</parameter> is not an interface
</para>
</simpara>
</warning>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

22
reference/componere/componere/patch/derive.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere-patch.derive" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere-patch.derive">
<refnamediv>
<refname>Componere\Patch::derive</refname>
<refpurpose>Patch Derivation</refpurpose>
@@ -13,9 +12,9 @@
<modifier>public</modifier> <type>Patch</type><methodname>Componere\Patch::derive</methodname>
<methodparam><type>object</type><parameter>instance</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Shall derive a <type>Patch</type> for the given <parameter>instance</parameter>
</para>
</simpara>
</refsect1>
@@ -25,9 +24,9 @@
<varlistentry>
<term><parameter>instance</parameter></term>
<listitem>
<para>
<simpara>
The target for the derived Patch
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -35,22 +34,21 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<type>Patch</type> for <parameter>instance</parameter> derived from the current <type>Patch</type>
</para>
<simpara>
<type>Patch</type> for <parameter>instance</parameter> derived from the current <type>Patch</type>
</simpara>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
<simpara>
Shall throw <type>InvalidArgumentException</type> if <parameter>instance</parameter> is not compatible
</para>
</simpara>
</warning>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

22
reference/componere/componere/patch/getclosure.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere-patch.getclosure" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere-patch.getclosure">
<refnamediv>
<refname>Componere\Patch::getClosure</refname>
<refpurpose>Get Closure</refpurpose>
@@ -13,9 +12,9 @@
<modifier>public</modifier> <type>Closure</type><methodname>Componere\Patch::getClosure</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Shall return a Closure for the method specified by name
</para>
</simpara>
</refsect1>
@@ -25,9 +24,9 @@
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
<simpara>
The case insensitive name of the method
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -35,22 +34,21 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A Closure bound to the correct scope and object
</para>
<simpara>
A Closure bound to the correct scope and object
</simpara>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
<simpara>
Shall throw <type>RuntimeException</type> if <parameter>name</parameter> could not be found
</para>
</simpara>
</warning>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

14
reference/componere/componere/patch/getclosures.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere-patch.getclosures" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere-patch.getclosures">
<refnamediv>
<refname>Componere\Patch::getClosures</refname>
<refpurpose>Get Closures</refpurpose>
@@ -11,24 +10,23 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>Componere\Patch::getClosures</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Shall return an array of Closures
</para>
</simpara>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Shall return all methods as an array of Closure objects bound to the correct scope and object
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

10
reference/componere/componere/patch/revert.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere-patch.revert" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere-patch.revert">
<refnamediv>
<refname>Componere\Patch::revert</refname>
<refpurpose>Reversal</refpurpose>
@@ -11,16 +10,15 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Componere\Patch::revert</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Shall revert the current patch
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/componere/componere/value/construct.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere-value.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere-value.construct">
<refnamediv>
<refname>Componere\Value::__construct</refname>
<refpurpose>Value Construction</refpurpose>
@@ -13,9 +12,9 @@
<modifier>public</modifier> <methodname>Componere\Value::__construct</methodname>
<methodparam choice="opt"><type>mixed</type><parameter>default</parameter></methodparam>
</constructorsynopsis>
<para>
<simpara>
</para>
</simpara>
</refsect1>
@@ -25,9 +24,9 @@
<varlistentry>
<term><parameter>default</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -36,16 +35,15 @@
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
<simpara>
Shall throw <type>InvalidArgumentException</type> if <parameter>default</parameter> does not have a suitable value
</para>
</simpara>
</warning>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

10
reference/componere/componere/value/hasdefault.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere-value.hasdefault" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere-value.hasdefault">
<refnamediv>
<refname>Componere\Value::hasDefault</refname>
<refpurpose>Value Interaction</refpurpose>
@@ -11,17 +10,16 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>Componere\Value::hasDefault</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

10
reference/componere/componere/value/isprivate.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere-value.isprivate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere-value.isprivate">
<refnamediv>
<refname>Componere\Value::isPrivate</refname>
<refpurpose>Accessibility Detection</refpurpose>
@@ -11,17 +10,16 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>Componere\Value::isPrivate</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

10
reference/componere/componere/value/isprotected.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere-value.isprotected" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere-value.isprotected">
<refnamediv>
<refname>Componere\Value::isProtected</refname>
<refpurpose>Accessibility Detection</refpurpose>
@@ -11,17 +10,16 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>Componere\Value::isProtected</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

10
reference/componere/componere/value/isstatic.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere-value.isstatic" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere-value.isstatic">
<refnamediv>
<refname>Componere\Value::isStatic</refname>
<refpurpose>Accessibility Detection</refpurpose>
@@ -11,17 +10,16 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>Componere\Value::isStatic</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/componere/componere/value/setprivate.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere-value.setprivate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere-value.setprivate">
<refnamediv>
<refname>Componere\Value::setPrivate</refname>
<refpurpose>Accessibility Modification</refpurpose>
@@ -11,33 +10,32 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>Value</type><methodname>Componere\Value::setPrivate</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The current Value
</para>
</simpara>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
<simpara>
Shall throw <type>RuntimeException</type> if access level was previously set
</para>
</simpara>
</warning>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/componere/componere/value/setprotected.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere-value.setprotected" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere-value.setprotected">
<refnamediv>
<refname>Componere\Value::setProtected</refname>
<refpurpose>Accessibility Modification</refpurpose>
@@ -11,33 +10,32 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>Value</type><methodname>Componere\Value::setProtected</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The current Value
</para>
</simpara>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
<para>
<simpara>
Shall throw <type>RuntimeException</type> if access level was previously set
</para>
</simpara>
</warning>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

14
reference/componere/componere/value/setstatic.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere-value.setstatic" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere-value.setstatic">
<refnamediv>
<refname>Componere\Value::setStatic</refname>
<refpurpose>Accessibility Modification</refpurpose>
@@ -11,24 +10,23 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>Value</type><methodname>Componere\Value::setStatic</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
</para>
</simpara>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The current Value
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

13
reference/componere/configure.xml
View File

@@ -1,20 +1,17 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="componere.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere.installation">
&reftitle.install;
<para>
<simpara>
Use <option role="configure">--with-componere[=DIR]</option> when compiling PHP.
</para>
</simpara>
<para>
<simpara>
Windows users should include <filename>php_componere.dll</filename> into &php.ini;
</para>
</simpara>
</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

37
reference/componere/functions/componere.cast.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere.cast" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere.cast">
<refnamediv>
<refname>Componere\cast</refname>
<refpurpose>Casting</refpurpose>
@@ -22,17 +21,17 @@
<varlistentry>
<term><parameter>type</parameter></term>
<listitem>
<para>
<simpara>
A user defined type
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>object</parameter></term>
<listitem>
<para>
<simpara>
An object with a user defined type compatible with <exceptionname>Type</exceptionname>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -40,44 +39,44 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
An <type>object</type> of type <exceptionname>Type</exceptionname>, cast from <parameter>object</parameter>
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<warning>
<para>
<simpara>
Shall throw <type>InvalidArgumentException</type> if the type of <parameter>object</parameter> is or is derived from an internal class
</para>
</simpara>
</warning>
<warning>
<para>
<simpara>
Shall throw <type>InvalidArgumentException</type> if <exceptionname>Type</exceptionname> is an interface
</para>
</simpara>
</warning>
<warning>
<para>
<simpara>
Shall throw <type>InvalidArgumentException</type> if <exceptionname>Type</exceptionname> is a trait
</para>
</simpara>
</warning>
<warning>
<para>
<simpara>
Shall throw <type>InvalidArgumentException</type> if <exceptionname>Type</exceptionname> is an abstract
</para>
</simpara>
</warning>
<warning>
<para>
<simpara>
Shall throw <type>InvalidArgumentException</type> if <exceptionname>Type</exceptionname> is not compatible with the type of <parameter>object</parameter>
</para>
</simpara>
</warning>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><xref linkend="componere.cast_by_ref" /></member>
<member><xref linkend="componere.cast_by_ref"/></member>
</simplelist>
</refsect1>

37
reference/componere/functions/componere.cast_by_ref.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="componere.cast_by_ref" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere.cast_by_ref">
<refnamediv>
<refname>Componere\cast_by_ref</refname>
<refpurpose>Casting</refpurpose>
@@ -22,17 +21,17 @@
<varlistentry>
<term><exceptionname>type</exceptionname></term>
<listitem>
<para>
<simpara>
A user defined type
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>object</parameter></term>
<listitem>
<para>
<simpara>
An object with a user defined type compatible with <exceptionname>Type</exceptionname>
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -40,44 +39,44 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
An <type>object</type> of type <exceptionname>Type</exceptionname>, cast from <parameter>object</parameter>, where members are references to <parameter>object</parameter> members
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<warning>
<para>
<simpara>
Shall throw <type>InvalidArgumentException</type> if the type of <parameter>object</parameter> is or is derived from an internal class
</para>
</simpara>
</warning>
<warning>
<para>
<simpara>
Shall throw <type>InvalidArgumentException</type> if <exceptionname>Type</exceptionname> is an interface
</para>
</simpara>
</warning>
<warning>
<para>
<simpara>
Shall throw <type>InvalidArgumentException</type> if <exceptionname>Type</exceptionname> is a trait
</para>
</simpara>
</warning>
<warning>
<para>
<simpara>
Shall throw <type>InvalidArgumentException</type> if <exceptionname>Type</exceptionname> is an abstract
</para>
</simpara>
</warning>
<warning>
<para>
<simpara>
Shall throw <type>InvalidArgumentException</type> if <exceptionname>Type</exceptionname> is not compatible with the type of <parameter>object</parameter>
</para>
</simpara>
</warning>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><xref linkend="componere.cast" /></member>
<member><xref linkend="componere.cast"/></member>
</simplelist>
</refsect1>

16
reference/componere/setup.xml
View File

@@ -1,26 +1,24 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<chapter xml:id="componere.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="componere.setup">
&reftitle.setup;
<section xml:id="componere.requirements">
&reftitle.required;
<para>
<simpara>
Reflection is required
</para>
</simpara>
</section>
<section xml:id="componere.installation">
&reftitle.install;
<para>
Componere source and releases are available on
<link xlink:href="&url.git.hub;krakjoe/componere">github</link>
</para>
<simpara>
Componere source and releases are available on
<link xlink:href="&url.git.hub;krakjoe/componere">github</link>
</simpara>
</section>
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml