1
0
mirror of https://github.com/php/doc-en.git synced 2026-03-23 23:32:18 +01:00

Add documentation for missing attribute constructors (#2126)

Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>
This commit is contained in:
Máté Kocsis
2023-01-02 21:33:51 +01:00
committed by GitHub
parent 170218df33
commit 681fd84dbd
11 changed files with 233 additions and 16 deletions

View File

@@ -5,7 +5,7 @@
<sect2 xml:id="migration82.new-features.core">
<title>PHP Core</title>
<sect3 xml:id="migration82.new-features.core.sensitive-parameter">
<sect3 xml:id="migration82.new-features.core.sensitiveparameter">
<title>SensitiveParameter Attribute</title>
<para>

View File

@@ -0,0 +1,44 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="allowdynamicproperties.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AllowDynamicProperties::__construct</refname>
<refpurpose>Construct a new AllowDynamicProperties attribute instance</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<constructorsynopsis role="AllowDynamicProperties">
<modifier>public</modifier> <methodname>AllowDynamicProperties::__construct</methodname>
<void/>
</constructorsynopsis>
<para>
Constructs a new <classname>AllowDynamicProperties</classname> instance.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</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
-->

View File

@@ -0,0 +1,53 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="attribute.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Attribute::__construct</refname>
<refpurpose>Construct a new Attribute instance</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<constructorsynopsis role="Attribute">
<modifier>public</modifier> <methodname>Attribute::__construct</methodname>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>Attribute::TARGET_ALL</initializer></methodparam>
</constructorsynopsis>
<para>
Constructs a new <classname>Attribute</classname> instance.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry><term><parameter>flags</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</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
-->

View File

@@ -9,9 +9,9 @@
</partintro>
&language.predefined.attributes.attribute;
&language.predefined.attributes.allow-dynamic-properties;
&language.predefined.attributes.return-type-will-change;
&language.predefined.attributes.sensitive-parameter;
&language.predefined.attributes.allowdynamicproperties;
&language.predefined.attributes.returntypewillchange;
&language.predefined.attributes.sensitiveparameter;
</part>
<!-- Keep this comment at the end of the file
Local variables:

View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<phpdoc:classref xml:id="class.allow-dynamic-properties" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<phpdoc:classref xml:id="class.allowdynamicproperties" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The AllowDynamicProperties class</title>
<titleabbrev>AllowDynamicProperties</titleabbrev>
<partintro>
<section xml:id="allow-dynamic-properties.intro">
<section xml:id="allowdynamicproperties.intro">
&reftitle.intro;
<para>
This attribute is used to mark classes that allow
@@ -13,7 +13,7 @@
</para>
</section>
<section xml:id="allow-dynamic-properties.synopsis">
<section xml:id="allowdynamicproperties.synopsis">
&reftitle.classsynopsis;
<classsynopsis>
@@ -27,6 +27,11 @@
<classname>AllowDynamicProperties</classname>
</ooclass>
</classsynopsisinfo>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.allowdynamicproperties')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='AllowDynamicProperties'])">
<xi:fallback/>
</xi:include>
</classsynopsis>
</section>
@@ -64,13 +69,15 @@ Deprecated: Creation of dynamic property DefaultBehaviour::$nonExistingProp is d
</example>
</section>
<section xml:id="allow-dynamic-properties.seealso">
<section xml:id="allowdynamicproperties.seealso">
&reftitle.seealso;
<para><link linkend="language.attributes">Attributes overview</link></para>
</section>
</partintro>
&language.predefined.allowdynamicproperties.construct;
</phpdoc:classref>
<!-- Keep this comment at the end of the file
Local variables:

View File

@@ -32,6 +32,11 @@
<classname>Attribute</classname>
</ooclass>
</classsynopsisinfo>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.attribute')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='Attribute'])">
<xi:fallback/>
</xi:include>
</classsynopsis>
</section>
@@ -43,6 +48,8 @@
</partintro>
&language.predefined.attribute.construct;
</phpdoc:classref>
<!-- Keep this comment at the end of the file
Local variables:

View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<phpdoc:classref xml:id="class.return-type-will-change" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<phpdoc:classref xml:id="class.returntypewillchange" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The ReturnTypeWillChange class</title>
<titleabbrev>ReturnTypeWillChange</titleabbrev>
<partintro>
<section xml:id="return-type-will-change.intro">
<section xml:id="returntypewillchange.intro">
&reftitle.intro;
<para>
Most non-final internal methods now require overriding methods to declare
@@ -18,7 +18,7 @@
</para>
</section>
<section xml:id="return-type-will-change.synopsis">
<section xml:id="returntypewillchange.synopsis">
&reftitle.classsynopsis;
<classsynopsis>
@@ -32,17 +32,24 @@
<classname>ReturnTypeWillChange</classname>
</ooclass>
</classsynopsisinfo>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.returntypewillchange')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='ReturnTypeWillChange'])">
<xi:fallback/>
</xi:include>
</classsynopsis>
</section>
<section xml:id="return-type-will-change.seealso">
<section xml:id="returntypewillchange.seealso">
&reftitle.seealso;
<para><link linkend="language.attributes">Attributes overview</link></para>
</section>
</partintro>
&language.predefined.returntypewillchange.construct;
</phpdoc:classref>
<!-- Keep this comment at the end of the file
Local variables:

View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<phpdoc:classref xml:id="class.sensitive-parameter" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<phpdoc:classref xml:id="class.sensitiveparameter" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The SensitiveParameter class</title>
<titleabbrev>SensitiveParameter</titleabbrev>
<partintro>
<section xml:id="sensitive-parameter.intro">
<section xml:id="sensitiveparameter.intro">
&reftitle.intro;
<para>
<!-- TODO Link -->
@@ -14,7 +14,7 @@
</para>
</section>
<section xml:id="sensitive-parameter.synopsis">
<section xml:id="sensitiveparameter.synopsis">
&reftitle.classsynopsis;
<classsynopsis>
@@ -28,6 +28,11 @@
<classname>SensitiveParameter</classname>
</ooclass>
</classsynopsisinfo>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.sensitiveparameter')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='SensitiveParameter'])">
<xi:fallback/>
</xi:include>
</classsynopsis>
</section>
@@ -86,13 +91,15 @@ Stack trace:
</example>
</section>
<section xml:id="sensitive-parameter.seealso">
<section xml:id="sensitiveparameter.seealso">
&reftitle.seealso;
<para><link linkend="language.attributes">Attributes overview</link></para>
</section>
</partintro>
&language.predefined.sensitiveparameter.construct;
</phpdoc:classref>
<!-- Keep this comment at the end of the file
Local variables:

View File

@@ -0,0 +1,44 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="returntypewillchange.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ReturnTypeWillChange::__construct</refname>
<refpurpose>Construct a new ReturnTypeWillChange attribute instance</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<constructorsynopsis role="ReturnTypeWillChange">
<modifier>public</modifier> <methodname>ReturnTypeWillChange::__construct</methodname>
<void/>
</constructorsynopsis>
<para>
Constructs a new <classname>ReturnTypeWillChange</classname> instance.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</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
-->

View File

@@ -0,0 +1,44 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="sensitiveparameter.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SensitiveParameter::__construct</refname>
<refpurpose>Construct a new SensitiveParameter attribute instance</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<constructorsynopsis role="SensitiveParameter">
<modifier>public</modifier> <methodname>SensitiveParameter::__construct</methodname>
<void/>
</constructorsynopsis>
<para>
Constructs a new <classname>SensitiveParameter</classname> instance.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</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
-->

View File

@@ -162,9 +162,13 @@
<function name="stdclass" from="PHP 4, PHP 5, PHP 7, PHP 8"/>
<function name="Attribute" from="PHP 8"/>
<function name="Attribute::__construct" from="PHP 8"/>
<function name="ReturnTypeWillChange" from="PHP 8 &gt;= 8.1.0"/>
<function name="ReturnTypeWillChange::__construct" from="PHP 8 &gt;= 8.1.0"/>
<function name="AllowDynamicProperties" from="PHP 8 &gt;= 8.2.0"/>
<function name="AllowDynamicProperties::__construct" from="PHP 8 &gt;= 8.2.0"/>
<function name="SensitiveParameter" from="PHP 8 &gt;= 8.2.0"/>
<function name="SensitiveParameter::__construct" from="PHP 8 &gt;= 8.2.0"/>
</versions>
<!-- Keep this comment at the end of the file
Local variables: