reflectionproperty.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.reflectionproperty" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>The ReflectionProperty class</title>
 <titleabbrev>ReflectionProperty</titleabbrev>

 <partintro>

<!-- {{{ ReflectionProperty intro -->
  <section xml:id="reflectionproperty.intro">
   &reftitle.intro;
   <para>
    The <classname>ReflectionProperty</classname> class reports
    information about class properties.
   </para>
  </section>
<!-- }}} -->

  <section xml:id="reflectionproperty.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis class="class">
    <ooclass>
     <classname>ReflectionProperty</classname>
    </ooclass>

    <oointerface>
     <modifier>implements</modifier>
     <interfacename>Reflector</interfacename>
    </oointerface>

    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="reflectionproperty.constants.is-static">ReflectionProperty::IS_STATIC</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="reflectionproperty.constants.is-readonly">ReflectionProperty::IS_READONLY</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="reflectionproperty.constants.is-public">ReflectionProperty::IS_PUBLIC</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="reflectionproperty.constants.is-protected">ReflectionProperty::IS_PROTECTED</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="reflectionproperty.constants.is-private">ReflectionProperty::IS_PRIVATE</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="reflectionproperty.constants.is-abstract">ReflectionProperty::IS_ABSTRACT</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="reflectionproperty.constants.is-protected-set">ReflectionProperty::IS_PROTECTED_SET</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="reflectionproperty.constants.is-private-set">ReflectionProperty::IS_PRIVATE_SET</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="reflectionproperty.constants.is-virtual">ReflectionProperty::IS_VIRTUAL</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="reflectionproperty.constants.is-final">ReflectionProperty::IS_FINAL</varname>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>string</type>
     <varname linkend="reflectionproperty.props.name">name</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>string</type>
     <varname linkend="reflectionproperty.props.class">class</varname>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.reflectionproperty')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='ReflectionProperty'])">
     <xi:fallback/>
    </xi:include>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.reflectionproperty')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='ReflectionProperty'])">
     <xi:fallback/>
    </xi:include>
   </classsynopsis>
<!-- }}} -->

  </section>

  
<!-- {{{ ReflectionProperty properties -->
  <section xml:id="reflectionproperty.props">
   &reftitle.properties;
   <variablelist>
    <varlistentry xml:id="reflectionproperty.props.name">
     <term><varname>name</varname></term>
     <listitem>
      <para>
       Name of the property. Read-only, throws
       <classname>ReflectionException</classname> in attempt to write.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="reflectionproperty.props.class">
     <term><varname>class</varname></term>
     <listitem>
      <para>
       Name of the class where the property is defined. Read-only, throws
       <classname>ReflectionException</classname> in attempt to write.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
<!-- }}} -->

  
<!-- {{{ ReflectionProperty constants -->
  <section xml:id="reflectionproperty.constants">
   &reftitle.constants;
   <section xml:id="reflectionproperty.constants.modifiers">
    <title>ReflectionProperty Modifiers</title>
    <variablelist>

     <varlistentry xml:id="reflectionproperty.constants.is-static">
      <term>
       <constant>ReflectionProperty::IS_STATIC</constant>
       <type>int</type>
      </term>
      <listitem>
       <para>
        Indicates <link linkend="language.oop5.static">static</link>
        properties.
        Prior to PHP 7.4.0, the value was <literal>1</literal>.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="reflectionproperty.constants.is-readonly">
      <term>
       <constant>ReflectionProperty::IS_READONLY</constant>
       <type>int</type>
      </term>
      <listitem>
       <para>
        Indicates <link linkend="language.oop5.properties.readonly-properties">readonly</link>
        properties. Available as of PHP 8.1.0.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="reflectionproperty.constants.is-public">
      <term>
       <constant>ReflectionProperty::IS_PUBLIC</constant>
       <type>int</type>
      </term>
      <listitem>
       <para>
        Indicates <link linkend="language.oop5.visibility">public</link>
        properties.
        Prior to PHP 7.4.0, the value was <literal>256</literal>.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="reflectionproperty.constants.is-protected">
      <term>
       <constant>ReflectionProperty::IS_PROTECTED</constant>
       <type>int</type>
      </term>
      <listitem>
       <para>
        Indicates <link linkend="language.oop5.visibility">protected</link>
        properties.
        Prior to PHP 7.4.0, the value was <literal>512</literal>.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="reflectionproperty.constants.is-private">
      <term>
       <constant>ReflectionProperty::IS_PRIVATE</constant>
       <type>int</type>
      </term>
      <listitem>
       <para>
        Indicates <link linkend="language.oop5.visibility">private</link>
        properties.
        Prior to PHP 7.4.0, the value was <literal>1024</literal>.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="reflectionproperty.constants.is-abstract">
      <term>
       <constant>ReflectionProperty::IS_ABSTRACT</constant>
       <type>int</type>
      </term>
      <listitem>
       <simpara>
        Indicates the property is
        <link linkend="language.oop5.abstract">abstract</link>.
        Available as of PHP 8.4.0.
       </simpara>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="reflectionproperty.constants.is-protected-set">
      <term>
       <constant>ReflectionProperty::IS_PROTECTED_SET</constant>
       <type>int</type>
      </term>
      <listitem>
       <simpara>
        Available as of PHP 8.4.0.
       </simpara>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="reflectionproperty.constants.is-private-set">
      <term>
       <constant>ReflectionProperty::IS_PRIVATE_SET</constant>
       <type>int</type>
      </term>
      <listitem>
       <simpara>
        Available as of PHP 8.4.0.
       </simpara>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="reflectionproperty.constants.is-virtual">
      <term>
       <constant>ReflectionProperty::IS_VIRTUAL</constant>
       <type>int</type>
      </term>
      <listitem>
       <simpara>
        Available as of PHP 8.4.0.
       </simpara>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="reflectionproperty.constants.is-final">
      <term>
       <constant>ReflectionProperty::IS_FINAL</constant>
       <type>int</type>
      </term>
      <listitem>
       <simpara>
        Indicates the property is
        <link linkend="language.oop5.final">final</link>.
        Available as of PHP 8.4.0.
       </simpara>
      </listitem>
     </varlistentry>

    </variablelist>
    <note>
     <para>
      The values of these constants may change between PHP versions.
      It is recommended to always use the constants
      and not rely on the values directly.
     </para>
    </note>
   </section>
  </section>
<!-- }}} -->

  <section role="changelog">
   &reftitle.changelog;
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.4.0</entry>
       <entry>
        The class constants are now typed.
       </entry>
      </row>
      <row>
       <entry>8.4.0</entry>
       <entry>
        Added <constant>ReflectionProperty::IS_VIRTUAL</constant>,
        <constant>ReflectionProperty::IS_PRIVATE_SET</constant>,
        <constant>ReflectionProperty::IS_PROTECTED_SET</constant>,
        <constant>ReflectionProperty::IS_ABSTRACT</constant>,
        and <constant>ReflectionProperty::IS_FINAL</constant>.
       </entry>
      </row>
      <row>
       <entry>8.0.0</entry>
       <entry>
        <methodname>ReflectionProperty::export</methodname> was removed.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </section>


 </partintro>

 &reference.reflection.entities.reflectionproperty;

</reference>
<!-- 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
-->