mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 18:38:55 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
90 lines
2.7 KiB
XML
90 lines
2.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.hw-objrec2array" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>hw_objrec2array</refname>
|
|
<refpurpose>Convert attributes from object record to object array</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>hw_objrec2array</methodname>
|
|
<methodparam><type>string</type><parameter>object_record</parameter></methodparam>
|
|
<methodparam choice="opt"><type>array</type><parameter>format</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Converts an <parameter>object_record</parameter> into an object array.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>object_record</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The object record.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>format</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
An associative array with the attribute name as its key and the value
|
|
being one of <literal>HW_ATTR_LANG</literal> or
|
|
<literal>HW_ATTR_NONE</literal>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns an array. The keys of the resulting array are the attributes names.
|
|
Multi-value attributes like 'Title' in different languages form its own
|
|
array. The keys of this array are the left part to the colon of the
|
|
attribute value. This left part must be two characters long.
|
|
</para>
|
|
<para>
|
|
Other multi-value attributes without a prefix form an indexed array. If
|
|
the optional parameter is missing the attributes 'Title', 'Description'
|
|
and 'Keyword' are treated as language attributes and the attributes
|
|
'Group', 'Parent' and 'HtmlAttr' as non-prefixed multi-value attributes.
|
|
By passing an array holding the type for each attribute you can
|
|
alter this behaviour.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>hw_array2objrec</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
|
|
-->
|