uopz-get-static.xml

<?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>
  <para>
   As of PHP 8.3.0, static initialzers are either computed during compile time,
   or if that is not possible, only when the function or method is run the first
   time, in which case the value of the static variable is reported as &null;
   prior to the first invocation.
  </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><methodname>ReflectionFunctionAbstract::getStaticVariables</methodname></member>
   <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
-->