mirror of
https://github.com/php/doc-en.git
synced 2026-03-23 23:32:18 +01:00
111 lines
2.6 KiB
XML
111 lines
2.6 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<refentry xml:id="backedenum.from" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>BackedEnum::from</refname>
|
|
<refpurpose>Maps a scalar to an enum instance</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis role="BackedEnum">
|
|
<modifier>public</modifier> <modifier>static</modifier> <type>static</type><methodname>BackedEnum::from</methodname>
|
|
<methodparam><type class="union"><type>int</type><type>string</type></type><parameter>value</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
The <methodname>from</methodname> method translates a <type>string</type> or <type>int</type>
|
|
into the corresponding Enum case, if any. If there is no matching case defined, it will throw
|
|
a <classname>ValueError</classname>.
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>value</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The scalar value to map to an enum case.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
A case instance of this enumeration.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title>Basic usage</title>
|
|
<para>
|
|
The following example illustrates how enum cases are returned.
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
enum Suit: string
|
|
{
|
|
case Hearts = 'H';
|
|
case Diamonds = 'D';
|
|
case Clubs = 'C';
|
|
case Spades = 'S';
|
|
}
|
|
|
|
$h = Suit::from('H');
|
|
|
|
var_dump($h);
|
|
|
|
$b = Suit::from('B');
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
enum(Suit::Hearts)
|
|
|
|
Fatal error: Uncaught ValueError: "B" is not a valid backing value for enum "Suit" in /file.php:15
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><methodname>UnitEnum::cases</methodname></member>
|
|
<member><methodname>BackedEnum::tryFrom</methodname></member>
|
|
</simplelist>
|
|
</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
|
|
-->
|