mirror of
https://github.com/php/doc-en.git
synced 2026-03-23 23:32:18 +01:00
140 lines
3.2 KiB
XML
140 lines
3.2 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<reference xml:id="class.arrayaccess" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
|
|
<title>The ArrayAccess interface</title>
|
|
<titleabbrev>ArrayAccess</titleabbrev>
|
|
|
|
<partintro>
|
|
|
|
<!-- {{{ ArrayAccess intro -->
|
|
<section xml:id="arrayaccess.intro">
|
|
&reftitle.intro;
|
|
<para>
|
|
Interface to provide accessing objects as arrays.
|
|
</para>
|
|
</section>
|
|
<!-- }}} -->
|
|
|
|
<section xml:id="arrayaccess.synopsis">
|
|
&reftitle.interfacesynopsis;
|
|
|
|
<!-- {{{ Synopsis -->
|
|
<classsynopsis class="interface">
|
|
<oointerface>
|
|
<interfacename>ArrayAccess</interfacename>
|
|
</oointerface>
|
|
|
|
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
|
|
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.arrayaccess')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='ArrayAccess'])">
|
|
<xi:fallback/>
|
|
</xi:include>
|
|
</classsynopsis>
|
|
<!-- }}} -->
|
|
|
|
</section>
|
|
|
|
<section xml:id="arrayaccess.examples">
|
|
&reftitle.examples;
|
|
<example xml:id="arrayaccess.example.basic"><!-- {{{ -->
|
|
<title>Basic usage</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
class Obj implements ArrayAccess {
|
|
public $container = [
|
|
"one" => 1,
|
|
"two" => 2,
|
|
"three" => 3,
|
|
];
|
|
|
|
public function offsetSet($offset, $value): void {
|
|
if (is_null($offset)) {
|
|
$this->container[] = $value;
|
|
} else {
|
|
$this->container[$offset] = $value;
|
|
}
|
|
}
|
|
|
|
public function offsetExists($offset): bool {
|
|
return isset($this->container[$offset]);
|
|
}
|
|
|
|
public function offsetUnset($offset): void {
|
|
unset($this->container[$offset]);
|
|
}
|
|
|
|
public function offsetGet($offset): mixed {
|
|
return isset($this->container[$offset]) ? $this->container[$offset] : null;
|
|
}
|
|
}
|
|
|
|
$obj = new Obj;
|
|
|
|
var_dump(isset($obj["two"]));
|
|
var_dump($obj["two"]);
|
|
unset($obj["two"]);
|
|
var_dump(isset($obj["two"]));
|
|
$obj["two"] = "A value";
|
|
var_dump($obj["two"]);
|
|
$obj[] = 'Append 1';
|
|
$obj[] = 'Append 2';
|
|
$obj[] = 'Append 3';
|
|
print_r($obj);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
bool(true)
|
|
int(2)
|
|
bool(false)
|
|
string(7) "A value"
|
|
obj Object
|
|
(
|
|
[container:obj:private] => Array
|
|
(
|
|
[one] => 1
|
|
[three] => 3
|
|
[two] => A value
|
|
[0] => Append 1
|
|
[1] => Append 2
|
|
[2] => Append 3
|
|
)
|
|
|
|
)
|
|
]]>
|
|
</screen>
|
|
</example><!-- }}} -->
|
|
</section>
|
|
|
|
</partintro>
|
|
|
|
&language.predefined.arrayaccess.offsetexists;
|
|
&language.predefined.arrayaccess.offsetget;
|
|
&language.predefined.arrayaccess.offsetset;
|
|
&language.predefined.arrayaccess.offsetunset;
|
|
|
|
</reference>
|
|
<!-- 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
|
|
-->
|