mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 17:08:54 +00:00
123 lines
3.3 KiB
XML
123 lines
3.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<phpdoc:classref xml:id="class.stringable" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
|
|
<title>The Stringable interface</title>
|
|
<titleabbrev>Stringable</titleabbrev>
|
|
|
|
<partintro>
|
|
|
|
<!-- {{{ Stringable intro -->
|
|
<section xml:id="stringable.intro">
|
|
&reftitle.intro;
|
|
<para>
|
|
The <interfacename>Stringable</interfacename> interface denotes a class as
|
|
having a <link linkend="object.tostring">__toString()</link> method. Unlike most interfaces,
|
|
<interfacename>Stringable</interfacename> is implicitly present on any class that
|
|
has the magic <link linkend="object.tostring">__toString()</link> method defined, although it
|
|
can and should be declared explicitly.
|
|
</para>
|
|
<para>
|
|
Its primary value is to allow functions to type check against the union
|
|
type <literal>string|Stringable</literal> to accept either a string primitive
|
|
or an object that can be cast to a string.
|
|
</para>
|
|
</section>
|
|
<!-- }}} -->
|
|
|
|
<section xml:id="stringable.synopsis">
|
|
&reftitle.interfacesynopsis;
|
|
|
|
<!-- {{{ Synopsis -->
|
|
<classsynopsis>
|
|
<ooclass>
|
|
<classname>Stringable</classname>
|
|
</ooclass>
|
|
|
|
<classsynopsisinfo>
|
|
<oointerface>
|
|
<interfacename>Stringable</interfacename>
|
|
</oointerface>
|
|
</classsynopsisinfo>
|
|
|
|
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
|
|
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.stringable')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
|
|
<xi:fallback/>
|
|
</xi:include>
|
|
</classsynopsis>
|
|
<!-- }}} -->
|
|
|
|
</section>
|
|
|
|
<section xml:id="stringable.examples">
|
|
<title>Stringable Examples</title>
|
|
<para>
|
|
<example xml:id="stringable.basic-example">
|
|
<title>Basic Stringable Usage</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
class IPv4Address implements Stringable {
|
|
private string $oct1;
|
|
private string $oct2;
|
|
private string $oct3;
|
|
private string $oct4;
|
|
|
|
public function __construct(string $oct1, string $oct2, string $oct3, string $oct4) {
|
|
$this->oct1 = $oct1;
|
|
$this->oct2 = $oct2;
|
|
$this->oct3 = $oct3;
|
|
$this->oct4 = $oct4;
|
|
}
|
|
|
|
public function __toString(): string {
|
|
return "$this->oct1.$this->oct2.$this->oct3.$this->oct4";
|
|
}
|
|
}
|
|
|
|
function showStuff(string|Stringable $value) {
|
|
// A Stringable will get converted to a string here by calling
|
|
// __toString.
|
|
print $value;
|
|
}
|
|
|
|
$ip = new IPv4Address('123', '234', '42', '9');
|
|
|
|
showStuff($ip);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
123.234.42.9
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</section>
|
|
|
|
</partintro>
|
|
|
|
&language.predefined.stringable.tostring;
|
|
</phpdoc:classref>
|
|
<!-- 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
|
|
-->
|