php-doc-en/reference/runkit7/functions/runkit7-constant-add.xml
2020-02-10 14:58:49 +00:00

93 lines
2.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.runkit7-constant-add" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>runkit7_constant_add</refname>
<refpurpose>
Similar to define(), but allows defining in class definitions as well
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>runkit7_constant_add</methodname>
<methodparam><type>string</type><parameter>constname</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>newVisibility</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>constname</parameter></term>
<listitem>
<para>
Name of constant to declare. Either a string to indicate a global constant,
or <literal>classname::constname</literal> to indicate a class constant.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
NULL, Bool, Long, Double, String, Array, or Resource value to store in the new constant.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>newVisibility</parameter></term>
<listitem>
<para>
Visibility of the constant, for class constants. Public by default.
One of the <constant>RUNKIT7_ACC_*</constant> constants.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>define</function></member>
<member><function>runkit7_constant_redefine</function></member>
<member><function>runkit7_constant_remove</function></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
-->