mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 22:38:55 +00:00
81ee02feed
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@322381 c90b9560-bf6c-de11-be94-00142212c4b1
129 lines
3.3 KiB
XML
129 lines
3.3 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="arrayobject.setflags" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>ArrayObject::setFlags</refname>
|
|
<refpurpose>Sets the behavior flags.</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>void</type><methodname>ArrayObject::setFlags</methodname>
|
|
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Set the flags that change the behavior of the ArrayObject.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>flags</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The new ArrayObject behavior.
|
|
It takes on either a bitmask, or named constants. Using named
|
|
constants is strongly encouraged to ensure compatibility for future
|
|
versions.
|
|
</para>
|
|
<para>
|
|
The available behavior flags are listed below. The actual
|
|
meanings of these flags are described in the
|
|
<link linkend="arrayobject.constants">predefined constants</link>.
|
|
<table>
|
|
<title>ArrayObject behavior flags</title>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>value</entry>
|
|
<entry>constant</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>1</entry>
|
|
<entry>
|
|
<link linkend="arrayobject.constants.std-prop-list">ArrayObject::STD_PROP_LIST</link>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>2</entry>
|
|
<entry>
|
|
<link linkend="arrayobject.constants.array-as-props">ArrayObject::ARRAY_AS_PROPS</link>
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.void;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>ArrayObject::setFlags</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// Array of available fruits
|
|
$fruits = array("lemons" => 1, "oranges" => 4, "bananas" => 5, "apples" => 10);
|
|
|
|
$fruitsArrayObject = new ArrayObject($fruits);
|
|
|
|
// Try to use array key as property
|
|
var_dump($fruitsArrayObject->lemons);
|
|
// Set the flag so that the array keys can be used as properties of the ArrayObject
|
|
$fruitsArrayObject->setFlags(ArrayObject::ARRAY_AS_PROPS);
|
|
// Try it again
|
|
var_dump($fruitsArrayObject->lemons);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
NULL
|
|
int(1)
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</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
|
|
-->
|