From 584248bf889c40bf2c442eab36fb2259efc862bf Mon Sep 17 00:00:00 2001
From: Stefan Marr <gron@php.net>
Date: Mon, 17 Oct 2011 21:45:11 +0000
Subject: [PATCH] Added documentation of class_uses based on documentation of
 class_implements.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@318175 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/spl/functions/class-uses.xml | 139 +++++++++++++++++++++++++
 1 file changed, 139 insertions(+)
 create mode 100644 reference/spl/functions/class-uses.xml

diff --git a/reference/spl/functions/class-uses.xml b/reference/spl/functions/class-uses.xml
new file mode 100644
index 0000000000..8e2ac961e1
--- /dev/null
+++ b/reference/spl/functions/class-uses.xml
@@ -0,0 +1,139 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- $Revision: 315005 $ -->
+<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>array</type><methodname>class_uses</methodname>
+   <methodparam><type>mixed</type><parameter>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>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>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 allow this function to load the class automatically through
+       the <link linkend="language.oop5.autoload">__autoload</link> magic
+       method.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   An array on success, or &false; on error.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title><function>class_implements</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'));
+
+
+function __autoload($class_name) {
+   require_once $class_name . '.php';
+}
+
+// use __autoload to load the 'not_loaded' class
+print_r(class_implements('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
+-->