php-doc-en/reference/spl/splfixedarray/offsetset.xml
2014-09-05 07:44:07 +00:00

80 lines
2.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="splfixedarray.offsetset" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SplFixedArray::offsetSet</refname>
<refpurpose>Sets a new value at a specified index</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>SplFixedArray::offsetSet</methodname>
<methodparam><type>int</type><parameter>index</parameter></methodparam>
<methodparam><type>mixed</type><parameter>newval</parameter></methodparam>
</methodsynopsis>
<para>
Sets the value at the specified <parameter>index</parameter> to <parameter>newval</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>index</parameter></term>
<listitem>
<para>
The index being set.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>newval</parameter></term>
<listitem>
<para>
The new value for the <parameter>index</parameter>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="errors"><!-- {{{ -->
&reftitle.errors;
<para>
Throws <classname>RuntimeException</classname> when <parameter>index</parameter> is outside
the defined size of the array or when <parameter>index</parameter> cannot be parsed as an integer.
</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
-->