mirror of
https://github.com/php/doc-en.git
synced 2026-03-24 15:52:15 +01:00
138 lines
3.6 KiB
XML
138 lines
3.6 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<refentry xml:id="reflectionproperty.setrawvalue" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>ReflectionProperty::setRawValue</refname>
|
|
<refpurpose>Sets the value of a property, bypassing a set hook if defined</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis role="ReflectionProperty">
|
|
<modifier>public</modifier> <type>void</type><methodname>ReflectionProperty::setRawValue</methodname>
|
|
<methodparam><type>object</type><parameter>object</parameter></methodparam>
|
|
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<simpara>
|
|
Sets the value of a property, bypassing a <literal>set</literal> hook if defined.
|
|
</simpara>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>object</parameter></term>
|
|
<listitem>
|
|
<simpara>
|
|
The object on which to set the property value.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>value</parameter></term>
|
|
<listitem>
|
|
<simpara>
|
|
The value to write. It must still be valid according to the property's type.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<simpara>
|
|
&return.void;
|
|
</simpara>
|
|
</refsect1>
|
|
|
|
<refsect1 role="errors">
|
|
&reftitle.errors;
|
|
<simpara>
|
|
If the property is virtual, an <classname>Error</classname> will be thrown,
|
|
as there is no raw value to set.
|
|
</simpara>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example xml:id="reflectionproperty.setrawvalue.example.basic">
|
|
<title><methodname>ReflectionProperty::setRawValue</methodname> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
class Example
|
|
{
|
|
public int $age {
|
|
set {
|
|
if ($value <= 0) {
|
|
throw new \InvalidArgumentException();
|
|
}
|
|
$this->age = $value;
|
|
}
|
|
}
|
|
}
|
|
|
|
$example = new Example();
|
|
|
|
$rClass = new \ReflectionClass(Example::class);
|
|
$rProp = $rClass->getProperty('age');
|
|
|
|
// These would go through the set hook, and throw an exception.
|
|
try {
|
|
$example->age = -2;
|
|
} catch (InvalidArgumentException) {
|
|
echo "InvalidArgumentException for setting property to -2\n";
|
|
}
|
|
try {
|
|
$rProp->setValue($example, -2);
|
|
} catch (InvalidArgumentException) {
|
|
echo "InvalidArgumentException for using ReflectionProperty::setValue() with -2\n";
|
|
}
|
|
|
|
// But this would set the $age to -2 without error.
|
|
$rProp->setRawValue($example, -2);
|
|
echo $example->age;
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
InvalidArgumentException for setting property to -2
|
|
InvalidArgumentException for using ReflectionProperty::setValue() with -2
|
|
-2
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<simplelist>
|
|
<member><link linkend="language.oop5.visibility-members-aviz">Asymmetric property visibility</link></member>
|
|
</simplelist>
|
|
</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
|
|
-->
|