Document uopz_get_static() and uopz_set_static()

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@345273 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Christoph Michael Becker 2018-07-04 21:55:48 +00:00
parent ad6817fb4d
commit ef509edbd7
3 changed files with 231 additions and 0 deletions

View file

@ -0,0 +1,110 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.uopz-get-static" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>uopz_get_static</refname>
<refpurpose>Gets the static variables from function or method scope</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="procedural">
<type>array</type><methodname>uopz_get_static</methodname>
<methodparam><type>string</type><parameter>class</parameter></methodparam>
<methodparam><type>string</type><parameter>function</parameter></methodparam>
</methodsynopsis>
<methodsynopsis role="procedural">
<type>array</type><methodname>uopz_get_static</methodname>
<methodparam><type>string</type><parameter>function</parameter></methodparam>
</methodsynopsis>
<para>
Gets the static variables from function or method scope.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>class</parameter></term>
<listitem>
<para>
The name of the class.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>function</parameter></term>
<listitem>
<para>
The name of the function or method.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an associative <type>array</type> of variable names mapped to their
current values on success, or &null; if the function or method does not exist.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example xml:id="uopz-get-static.example.basic">
<title>Basic <function>uopz_get_static</function> Usage</title>
<programlisting role="php">
<![CDATA[
<?php
function foo() {
static $bar = 'baz';
}
var_dump(uopz_get_static('foo'));
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
array(1) {
["bar"]=>
string(3) "baz"
}
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>uopz_set_static</function></member>
</simplelist>
</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,119 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.uopz-set-static" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>uopz_set_static</refname>
<refpurpose>Sets the static variables in function or method scope</refpurpose>
</refnamediv>
<refsect1 role="description"><!-- {{{ -->
&reftitle.description;
<methodsynopsis role="procedural">
<type>void</type><methodname>uopz_set_static</methodname>
<methodparam><type>string</type><parameter>function</parameter></methodparam>
<methodparam><type>array</type><parameter>static</parameter></methodparam>
</methodsynopsis>
<methodsynopsis role="procedural">
<type>void</type><methodname>uopz_set_static</methodname>
<methodparam><type>string</type><parameter>class</parameter></methodparam>
<methodparam><type>string</type><parameter>function</parameter></methodparam>
<methodparam><type>array</type><parameter>static</parameter></methodparam>
</methodsynopsis>
<para>
Sets the static variables in function or method scope.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>class</parameter></term>
<listitem>
<para>
The name of the class.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>function</parameter></term>
<listitem>
<para>
The name of the function or method.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>static</parameter></term>
<listitem>
<para>
The associative <type>array</type> of variable names mapped to their
values.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example xml:id="uopz-set-static.example.basic">
<title>Basic <function>uopz_set_static</function> Usage</title>
<programlisting role="php">
<![CDATA[
<?php
function foo() {
static $bar = 'baz';
var_dump($bar);
}
uopz_set_static('foo', ['bar' => 'qux']);
foo();
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
string(3) "qux"
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>uopz_get_static</function></member>
</simplelist>
</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

@ -27,6 +27,8 @@
<function name='uopz_set_mock' from='PECL uopz 5'/>
<function name='uopz_get_mock' from='PECL uopz 5'/>
<function name='uopz_unset_mock' from='PECL uopz 5'/>
<function name='uopz_get_static' from='PECL uopz 5'/>
<function name='uopz_set_static' from='PECL uopz 5'/>
</versions>
<!-- Keep this comment at the end of the file