uopz-flags.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="function.uopz-flags" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>uopz_flags</refname>
  <refpurpose>Get or set flags on function or class</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>uopz_flags</methodname>
   <methodparam><type>string</type><parameter>function</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>PHP_INT_MAX</initializer></methodparam>
  </methodsynopsis>
  <methodsynopsis>
   <type>int</type><methodname>uopz_flags</methodname>
   <methodparam><type>string</type><parameter>class</parameter></methodparam>
   <methodparam><type>string</type><parameter>function</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>PHP_INT_MAX</initializer></methodparam>
  </methodsynopsis>
  <para>
   Get or set the flags on a class or function entry at runtime
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>class</parameter></term>
    <listitem>
     <para>
      The name of a class
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>function</parameter></term>
    <listitem>
     <para>
      The name of the function. If <parameter>class</parameter> is given and an empty string
      is passed as <parameter>function</parameter>, <function>uopz_flags</function>
      gets or sets the flags of the class entry.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry> 
    <term><parameter>flags</parameter></term>
    <listitem>
     <para>
      A valid set of ZEND_ACC_ flags.
      If omitted, <function>uopz_flags</function> acts as getter.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   If setting, returns old flags, else returns flags
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <simpara>
   As of PHP 7.4.0, if the parameter <parameter>flags</parameter> is passed,
   <function>uopz_flags</function> throws a <classname>RuntimeException</classname>,
   if <link linkend="book.opcache">OPcache</link> is enabled,
   and the class entry of <parameter>class</parameter>
   or the function entry of <parameter>function</parameter> is immutable.
  </simpara>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>PECL uopz 5.0.0</entry>
      <entry>
       The <parameter>flags</parameter> parameter is now optional. Formerly,
       <constant>ZEND_ACC_FETCH</constant> had to be passed to use <function>uopz_flags</function>
       as getter.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>uopz_flags</function> example</title>
   <programlisting role="php">
<![CDATA[
<?php
class Test {
    public function method() {
        return __CLASS__;
    }
}

$flags = uopz_flags("Test", "method");

var_dump((bool) (uopz_flags("Test", "method") & ZEND_ACC_PRIVATE));
var_dump((bool) (uopz_flags("Test", "method") & ZEND_ACC_STATIC));

var_dump(uopz_flags("Test", "method", $flags|ZEND_ACC_STATIC|ZEND_ACC_PRIVATE));

var_dump((bool) (uopz_flags("Test", "method") & ZEND_ACC_PRIVATE));
var_dump((bool) (uopz_flags("Test", "method") & ZEND_ACC_STATIC));
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
bool(false)
bool(false)
int(1234567890)
bool(true)
bool(true)
]]>
   </screen>
  </example>
  <example>
   <title>"Unfinalize" a Class</title>
   <programlisting role="php">
<![CDATA[
<?php
final class MyClass
{
}

$flags = uopz_flags(MyClass::class, '');
uopz_flags(MyClass::class, '', $flags & ~ZEND_ACC_FINAL);
var_dump((new ReflectionClass(MyClass::class))->isFinal());
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
bool(false)
]]>
   </screen>
  </example>
 </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
-->