php-doc-en/reference/hw/functions/hw-objrec2array.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
  <refentry id="function.hw-objrec2array">
   <refnamediv>
    <refname>hw_objrec2array</refname>
    <refpurpose>Convert attributes from object record to object array</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <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.
     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.
     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. The array is an associated 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>
    <para>
     See also <function>hw_array2objrec</function>.
    </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:"../../../../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
-->