mirror of
https://github.com/php/doc-en.git
synced 2026-04-25 08:18:10 +02:00
KapitanOczywisty
134 lines
3.0 KiB
XML
134 lines
3.0 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.class-uses" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>class_uses</refname>
|
|
<refpurpose>
|
|
Return the traits used by the given class
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type class="union"><type>array</type><type>false</type></type><methodname>class_uses</methodname>
|
|
<methodparam><type class="union"><type>object</type><type>string</type></type><parameter>object_or_class</parameter></methodparam>
|
|
<methodparam choice="opt"><type>bool</type><parameter>autoload</parameter><initializer>&true;</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
This function returns an array with the names of the traits that the
|
|
given <parameter>object_or_class</parameter> uses. This does however not include
|
|
any traits used by a parent class.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>object_or_class</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
An object (class instance) or a string (class name).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>autoload</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Whether to <link linkend="language.oop5.autoload">autoload</link>
|
|
if not already loaded.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
An array on success, or &false; when the given class doesn't exist.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>class_uses</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
trait foo { }
|
|
class bar {
|
|
use foo;
|
|
}
|
|
|
|
print_r(class_uses(new bar));
|
|
|
|
print_r(class_uses('bar'));
|
|
|
|
spl_autoload_register();
|
|
|
|
// use autoloading to load the 'not_loaded' class
|
|
print_r(class_uses('not_loaded', true));
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
Array
|
|
(
|
|
[foo] => foo
|
|
)
|
|
Array
|
|
(
|
|
[foo] => foo
|
|
)
|
|
Array
|
|
(
|
|
[trait_of_not_loaded] => trait_of_not_loaded
|
|
)
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>class_parents</function></member>
|
|
<member><function>get_declared_traits</function></member>
|
|
</simplelist>
|
|
</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
|
|
-->
|