[doc-en] master: Replace `<literal>` nodes with `<constant>` for constants (#2310)

Author: Javier Spagnoletti (phansys) Committer: GitHub (web-flow) Pusher: kamil-tekiela Date: 2026-09-25T11:35:03+01:00 Commit: https://github.com/php/doc-en/commit/9c73659a3578fa34561e7e6531f98c4eaac4c990 Raw diff: https://github.com/php/doc-en/commit/9c73659a3578fa34561e7e6531f98c4eaac4c990.diff Replace <literal> nodes with <constant> for constants (#2310) Changed paths: M language-snippets.ent M reference/datetime/datetimezone/listidentifiers.xml M reference/intl/intlchar/enumchartypes.xml M reference/intl/intlchar/getblockcode.xml M reference/intl/intlchar/getpropertyenum.xml M reference/pdo/pdo/getattribute.xml M reference/pdo/pdo/prepare.xml M reference/pdo/pdo/query.xml M reference/pdo/pdostatement/bindcolumn.xml M reference/pdo/pdostatement/bindparam.xml M reference/pdo/pdostatement/bindvalue.xml M reference/pdo/pdostatement/fetch.xml M reference/pdo/pdostatement/getattribute.xml M reference/pdo/pdostatement/getcolumnmeta.xml M reference/pdo/pdostatement/setattribute.xml M reference/phar/Phar/canCompress.xml M reference/phar/Phar/compress.xml M reference/phar/Phar/compressFiles.xml M reference/phar/Phar/convertToData.xml M reference/phar/Phar/convertToExecutable.xml M reference/phar/Phar/getSupportedCompression.xml M reference/phar/Phar/isCompressed.xml M reference/phar/Phar/isFileFormat.xml M reference/phar/Phar/setSignatureAlgorithm.xml M reference/phar/PharData/compress.xml M reference/phar/PharData/compressFiles.xml M reference/phar/PharData/convertToData.xml M reference/phar/PharData/convertToExecutable.xml M reference/phar/PharData/setSignatureAlgorithm.xml Diff: diff --git a/language-snippets.ent b/language-snippets.ent index c678ce86b01c..529133edc4e8 100644 --- a/language-snippets.ent +++ b/language-snippets.ent @@ -1085,7 +1085,7 @@ Passing untrusted data to this parameter is <emphasis>insecure</emphasis>, unles <!ENTITY intl.locale-len.return '<simpara xmlns="http://docbook.org/ns/docbook">Returns &null; when the length of <parameter>locale</parameter> exceeds <constant>INTL_MAX_LOCALE_LEN</constant>.</simpara>'> -<!ENTITY intl.property.parameter '<simpara xmlns="http://docbook.org/ns/docbook">The Unicode property to lookup (see the <literal>IntlChar::PROPERTY_*</literal> constants).</simpara>'> +<!ENTITY intl.property.parameter '<simpara xmlns="http://docbook.org/ns/docbook">The Unicode property to lookup (see the <constant>IntlChar::PROPERTY_<replaceable>*</replaceable></constant> constants).</simpara>'> <!ENTITY intl.property.example 'Testing different properties'> diff --git a/reference/datetime/datetimezone/listidentifiers.xml b/reference/datetime/datetimezone/listidentifiers.xml index 05133236749a..54d75e82d4bd 100644 --- a/reference/datetime/datetimezone/listidentifiers.xml +++ b/reference/datetime/datetimezone/listidentifiers.xml @@ -69,7 +69,7 @@ <para> Returns the array of timezone identifiers. Only non-outdated items are returned. To get all, including outdated timezone identifiers, use the - <literal>DateTimeZone::ALL_WITH_BC</literal> as value for + <constant>DateTimeZone::ALL_WITH_BC</constant> as value for <parameter>timezoneGroup</parameter>. </para> </refsect1> diff --git a/reference/intl/intlchar/enumchartypes.xml b/reference/intl/intlchar/enumchartypes.xml index 241c13fdabb4..c7ad7f00e624 100644 --- a/reference/intl/intlchar/enumchartypes.xml +++ b/reference/intl/intlchar/enumchartypes.xml @@ -35,7 +35,7 @@ <simplelist> <member><type>int</type> <literal>$start</literal> - The starting code point of the range</member> <member><type>int</type> <literal>$end</literal> - The ending code point of the range</member> - <member><type>int</type> <literal>$name</literal> - The category type (one of the <literal>IntlChar::CHAR_CATEGORY_*</literal> constants)</member> + <member><type>int</type> <literal>$name</literal> - The category type (one of the <constant>IntlChar::CHAR_CATEGORY_<replaceable>*</replaceable></constant> constants)</member> </simplelist> </para> </listitem> diff --git a/reference/intl/intlchar/getblockcode.xml b/reference/intl/intlchar/getblockcode.xml index 308590a43578..d664e5b8ed49 100644 --- a/reference/intl/intlchar/getblockcode.xml +++ b/reference/intl/intlchar/getblockcode.xml @@ -33,7 +33,7 @@ &reftitle.returnvalues; <para> Returns the block value for <parameter>codepoint</parameter>. - See the <literal>IntlChar::BLOCK_CODE_*</literal> constants for possible return values. Returns &null; on failure. + See the <constant>IntlChar::BLOCK_CODE_<replaceable>*</replaceable></constant> constants for possible return values. Returns &null; on failure. </para> </refsect1> diff --git a/reference/intl/intlchar/getpropertyenum.xml b/reference/intl/intlchar/getpropertyenum.xml index 1283cfdf06a3..f735a1252581 100644 --- a/reference/intl/intlchar/getpropertyenum.xml +++ b/reference/intl/intlchar/getpropertyenum.xml @@ -42,7 +42,7 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns an <literal>IntlChar::PROPERTY_</literal> constant value, + Returns an <constant>IntlChar::PROPERTY_<replaceable>*</replaceable></constant> constant value, or <constant>IntlChar::PROPERTY_INVALID_CODE</constant> if the given name does not match any property. </para> </refsect1> diff --git a/reference/pdo/pdo/getattribute.xml b/reference/pdo/pdo/getattribute.xml index 02acc2a65c38..6ab7efbc7da0 100644 --- a/reference/pdo/pdo/getattribute.xml +++ b/reference/pdo/pdo/getattribute.xml @@ -35,17 +35,17 @@ <term><parameter>attribute</parameter></term> <listitem> <para> - One of the <literal>PDO::ATTR_*</literal> constants. The generic attributes that + One of the <constant>PDO::ATTR_<replaceable>*</replaceable></constant> constants. The generic attributes that apply to database connections are as follows: <simplelist> - <member><literal>PDO::ATTR_CASE</literal></member> - <member><literal>PDO::ATTR_DEFAULT_FETCH_MODE</literal></member> - <member><literal>PDO::ATTR_DRIVER_NAME</literal></member> - <member><literal>PDO::ATTR_ERRMODE</literal></member> - <member><literal>PDO::ATTR_ORACLE_NULLS</literal></member> - <member><literal>PDO::ATTR_PERSISTENT</literal></member> - <member><literal>PDO::ATTR_STATEMENT_CLASS</literal></member> - <member><literal>PDO::ATTR_STRINGIFY_FETCHES</literal></member> + <member><constant>PDO::ATTR_CASE</constant></member> + <member><constant>PDO::ATTR_DEFAULT_FETCH_MODE</constant></member> + <member><constant>PDO::ATTR_DRIVER_NAME</constant></member> + <member><constant>PDO::ATTR_ERRMODE</constant></member> + <member><constant>PDO::ATTR_ORACLE_NULLS</constant></member> + <member><constant>PDO::ATTR_PERSISTENT</constant></member> + <member><constant>PDO::ATTR_STATEMENT_CLASS</constant></member> + <member><constant>PDO::ATTR_STRINGIFY_FETCHES</constant></member> </simplelist> </para> <simpara> diff --git a/reference/pdo/pdo/prepare.xml b/reference/pdo/pdo/prepare.xml index aadd5ff889e9..406bc54e51cd 100644 --- a/reference/pdo/pdo/prepare.xml +++ b/reference/pdo/pdo/prepare.xml @@ -100,8 +100,8 @@ This array holds one or more key=&gt;value pairs to set attribute values for the PDOStatement object that this method returns. You would most commonly use this to set the - <literal>PDO::ATTR_CURSOR</literal> value to - <literal>PDO::CURSOR_SCROLL</literal> to request a scrollable cursor. + <constant>PDO::ATTR_CURSOR</constant> value to + <constant>PDO::CURSOR_SCROLL</constant> to request a scrollable cursor. Some drivers have driver-specific options that may be set at prepare-time. </para> diff --git a/reference/pdo/pdo/query.xml b/reference/pdo/pdo/query.xml index df0d6a7e31a0..d42becbcf3d9 100644 --- a/reference/pdo/pdo/query.xml +++ b/reference/pdo/pdo/query.xml @@ -88,7 +88,7 @@ <listitem> <para> The default fetch mode for the returned <classname>PDOStatement</classname>. - It must be one of the <link linkend="pdo.constants"><literal>PDO::FETCH_*</literal></link> constants. + It must be one of the <link linkend="pdo.constants"><constant>PDO::FETCH_<replaceable>*</replaceable></constant></link> constants. </para> <para> If this argument is passed to the function, the remaining arguments diff --git a/reference/pdo/pdostatement/bindcolumn.xml b/reference/pdo/pdostatement/bindcolumn.xml index d9c6b3323983..b4acf7ad11dc 100644 --- a/reference/pdo/pdostatement/bindcolumn.xml +++ b/reference/pdo/pdostatement/bindcolumn.xml @@ -66,7 +66,7 @@ <term><parameter>type</parameter></term> <listitem> <para> - Data type of the parameter, specified by the <link linkend="pdo.constants"><literal>PDO::PARAM_*</literal> + Data type of the parameter, specified by the <link linkend="pdo.constants"><constant>PDO::PARAM_<replaceable>*</replaceable></constant> constants</link>. </para> </listitem> diff --git a/reference/pdo/pdostatement/bindparam.xml b/reference/pdo/pdostatement/bindparam.xml index 4eccba223a9f..7eacbd042652 100644 --- a/reference/pdo/pdostatement/bindparam.xml +++ b/reference/pdo/pdostatement/bindparam.xml @@ -63,7 +63,7 @@ <term><parameter>type</parameter></term> <listitem> <para> - Explicit data type for the parameter using the <link linkend="pdo.constants"><literal>PDO::PARAM_*</literal> + Explicit data type for the parameter using the <link linkend="pdo.constants"><constant>PDO::PARAM_<replaceable>*</replaceable></constant> constants</link>. To return an INOUT parameter from a stored procedure, use the bitwise OR operator to set the <constant>PDO::PARAM_INPUT_OUTPUT</constant> bits diff --git a/reference/pdo/pdostatement/bindvalue.xml b/reference/pdo/pdostatement/bindvalue.xml index c00530288b4f..f032b5143c84 100644 --- a/reference/pdo/pdostatement/bindvalue.xml +++ b/reference/pdo/pdostatement/bindvalue.xml @@ -49,7 +49,7 @@ <term><parameter>type</parameter></term> <listitem> <para> - Explicit data type for the parameter using the <link linkend="pdo.constants"><literal>PDO::PARAM_*</literal> + Explicit data type for the parameter using the <link linkend="pdo.constants"><constant>PDO::PARAM_<replaceable>*</replaceable></constant> constants</link>. </para> </listitem> diff --git a/reference/pdo/pdostatement/fetch.xml b/reference/pdo/pdostatement/fetch.xml index f56ee88eab51..b1448079d58c 100644 --- a/reference/pdo/pdostatement/fetch.xml +++ b/reference/pdo/pdostatement/fetch.xml @@ -32,26 +32,26 @@ <listitem> <para> Controls how the next row will be returned to the caller. This value - must be one of the <literal>PDO::FETCH_*</literal> constants, - defaulting to value of <literal>PDO::ATTR_DEFAULT_FETCH_MODE</literal> - (which defaults to <literal>PDO::FETCH_BOTH</literal>). + must be one of the <constant>PDO::FETCH_<replaceable>*</replaceable></constant> constants, + defaulting to value of <constant>PDO::ATTR_DEFAULT_FETCH_MODE</constant> + (which defaults to <constant>PDO::FETCH_BOTH</constant>). <itemizedlist> <listitem> <simpara> - <literal>PDO::FETCH_ASSOC</literal>: returns an array indexed by column + <constant>PDO::FETCH_ASSOC</constant>: returns an array indexed by column name as returned in your result set </simpara> </listitem> <listitem> <simpara> - <literal>PDO::FETCH_BOTH</literal> (default): returns an array indexed by + <constant>PDO::FETCH_BOTH</constant> (default): returns an array indexed by both column name and 0-indexed column number as returned in your result set </simpara> </listitem> <listitem> <simpara> - <literal>PDO::FETCH_BOUND</literal>: returns &true; and assigns the + <constant>PDO::FETCH_BOUND</constant>: returns &true; and assigns the values of the columns in your result set to the PHP variables to which they were bound with the <methodname>PDOStatement::bindColumn</methodname> method @@ -59,7 +59,7 @@ </listitem> <listitem> <simpara> - <literal>PDO::FETCH_CLASS</literal>: returns a new instance of the + <constant>PDO::FETCH_CLASS</constant>: returns a new instance of the requested class. The object is initialized by mapping the columns of the result set to properties in the class. This occurs before the constructor is called, allowing properties to be populated regardless @@ -76,23 +76,23 @@ </listitem> <listitem> <simpara> - <literal>PDO::FETCH_INTO</literal>: updates an existing instance + <constant>PDO::FETCH_INTO</constant>: updates an existing instance of the requested class, mapping the columns of the result set to named properties in the class </simpara> </listitem> <listitem> <simpara> - <literal>PDO::FETCH_LAZY</literal>: combines - <literal>PDO::FETCH_BOTH</literal> and <literal>PDO::FETCH_OBJ</literal>, + <constant>PDO::FETCH_LAZY</constant>: combines + <constant>PDO::FETCH_BOTH</constant> and <constant>PDO::FETCH_OBJ</constant>, and returns a <classname>PDORow</classname> object which creates the object property names as they are accessed. </simpara> </listitem> <listitem> <simpara> - <literal>PDO::FETCH_NAMED</literal>: returns an array with the same - form as <literal>PDO::FETCH_ASSOC</literal>, except that if there are + <constant>PDO::FETCH_NAMED</constant>: returns an array with the same + form as <constant>PDO::FETCH_ASSOC</constant>, except that if there are multiple columns with the same name, the value referred to by that key will be an array of all the values in the row that had that column name @@ -100,21 +100,21 @@ </listitem> <listitem> <simpara> - <literal>PDO::FETCH_NUM</literal>: returns an array indexed by column + <constant>PDO::FETCH_NUM</constant>: returns an array indexed by column number as returned in your result set, starting at column 0 </simpara> </listitem> <listitem> <simpara> - <literal>PDO::FETCH_OBJ</literal>: returns an anonymous object with + <constant>PDO::FETCH_OBJ</constant>: returns an anonymous object with property names that correspond to the column names returned in your result set </simpara> </listitem> <listitem> <simpara> - <literal>PDO::FETCH_PROPS_LATE</literal>: when used with - <literal>PDO::FETCH_CLASS</literal>, the constructor of the class is + <constant>PDO::FETCH_PROPS_LATE</constant>: when used with + <constant>PDO::FETCH_CLASS</constant>, the constructor of the class is called before the properties are assigned from the respective column values. </simpara> @@ -129,11 +129,11 @@ <para> For a PDOStatement object representing a scrollable cursor, this value determines which row will be returned to the caller. This value - must be one of the <literal>PDO::FETCH_ORI_*</literal> constants, - defaulting to <literal>PDO::FETCH_ORI_NEXT</literal>. To request a + must be one of the <constant>PDO::FETCH_ORI_<replaceable>*</replaceable></constant> constants, + defaulting to <constant>PDO::FETCH_ORI_NEXT</constant>. To request a scrollable cursor for your PDOStatement object, you must set the - <literal>PDO::ATTR_CURSOR</literal> attribute to - <literal>PDO::CURSOR_SCROLL</literal> when you prepare the SQL + <constant>PDO::ATTR_CURSOR</constant> attribute to + <constant>PDO::CURSOR_SCROLL</constant> when you prepare the SQL statement with <methodname>PDO::prepare</methodname>. </para> </listitem> @@ -144,13 +144,13 @@ <para> For a PDOStatement object representing a scrollable cursor for which the <parameter>cursorOrientation</parameter> parameter is set to - <literal>PDO::FETCH_ORI_ABS</literal>, this value specifies the + <constant>PDO::FETCH_ORI_ABS</constant>, this value specifies the absolute number of the row in the result set that shall be fetched. </para> <para> For a PDOStatement object representing a scrollable cursor for which the <parameter>cursorOrientation</parameter> parameter is set to - <literal>PDO::FETCH_ORI_REL</literal>, this value specifies the + <constant>PDO::FETCH_ORI_REL</constant>, this value specifies the row to fetch relative to the cursor position before <methodname>PDOStatement::fetch</methodname> was called. </para> diff --git a/reference/pdo/pdostatement/getattribute.xml b/reference/pdo/pdostatement/getattribute.xml index b875e6afbf20..12701b0536de 100644 --- a/reference/pdo/pdostatement/getattribute.xml +++ b/reference/pdo/pdostatement/getattribute.xml @@ -19,7 +19,7 @@ <itemizedlist> <listitem> <simpara> - <literal>PDO::ATTR_CURSOR_NAME</literal> + <constant>PDO::ATTR_CURSOR_NAME</constant> (Firebird and ODBC specific): Get the name of the cursor for <literal>UPDATE ... WHERE CURRENT OF</literal>. </simpara> diff --git a/reference/pdo/pdostatement/getcolumnmeta.xml b/reference/pdo/pdostatement/getcolumnmeta.xml index 99a0079b7a06..5252e070885a 100644 --- a/reference/pdo/pdostatement/getcolumnmeta.xml +++ b/reference/pdo/pdostatement/getcolumnmeta.xml @@ -100,7 +100,7 @@ <row> <entry><literal>pdo_type</literal></entry> <entry>The type of this column as represented by the - <link linkend="pdo.constants"><literal>PDO::PARAM_*</literal> + <link linkend="pdo.constants"><constant>PDO::PARAM_<replaceable>*</replaceable></constant> constants</link>.</entry> </row> </tbody> diff --git a/reference/pdo/pdostatement/setattribute.xml b/reference/pdo/pdostatement/setattribute.xml index 7b6af87dec71..674eabdd8c84 100644 --- a/reference/pdo/pdostatement/setattribute.xml +++ b/reference/pdo/pdostatement/setattribute.xml @@ -20,7 +20,7 @@ <itemizedlist> <listitem> <simpara> - <literal>PDO::ATTR_CURSOR_NAME</literal> + <constant>PDO::ATTR_CURSOR_NAME</constant> (Firebird and ODBC specific): Set the name of the cursor for <literal>UPDATE ... WHERE CURRENT OF</literal>. </simpara> diff --git a/reference/phar/Phar/canCompress.xml b/reference/phar/Phar/canCompress.xml index dce40c987894..b4bf2b155b0a 100644 --- a/reference/phar/Phar/canCompress.xml +++ b/reference/phar/Phar/canCompress.xml @@ -26,7 +26,7 @@ <term><parameter>compression</parameter></term> <listitem> <para> - Either <literal>Phar::GZ</literal> or <literal>Phar::BZ2</literal> can be + Either <constant>Phar::GZ</constant> or <constant>Phar::BZ2</constant> can be used to test whether compression is possible with a specific compression algorithm (zlib or bzip2). </para> diff --git a/reference/phar/Phar/compress.xml b/reference/phar/Phar/compress.xml index 4f0409d25855..2dfbad6e8734 100644 --- a/reference/phar/Phar/compress.xml +++ b/reference/phar/Phar/compress.xml @@ -32,7 +32,7 @@ </para> <para> In addition, this method automatically renames the archive, appending <literal>.gz</literal>, - <literal>.bz2</literal> or removing the extension if passed <literal>Phar::NONE</literal> to + <literal>.bz2</literal> or removing the extension if passed <constant>Phar::NONE</constant> to remove compression. Alternatively, a file extension may be specified with the second parameter. </para> @@ -46,8 +46,8 @@ <term><parameter>compression</parameter></term> <listitem> <para> - Compression must be one of <literal>Phar::GZ</literal>, - <literal>Phar::BZ2</literal> to add compression, or <literal>Phar::NONE</literal> + Compression must be one of <constant>Phar::GZ</constant>, + <constant>Phar::BZ2</constant> to add compression, or <constant>Phar::NONE</constant> to remove compression. </para> </listitem> diff --git a/reference/phar/Phar/compressFiles.xml b/reference/phar/Phar/compressFiles.xml index 9367d9c0d6be..8f2cc9b90324 100644 --- a/reference/phar/Phar/compressFiles.xml +++ b/reference/phar/Phar/compressFiles.xml @@ -41,8 +41,8 @@ <term><parameter>compression</parameter></term> <listitem> <para> - Compression must be one of <literal>Phar::GZ</literal>, - <literal>Phar::BZ2</literal> to add compression, or <literal>Phar::NONE</literal> + Compression must be one of <constant>Phar::GZ</constant>, + <constant>Phar::BZ2</constant> to add compression, or <constant>Phar::NONE</constant> to remove compression. </para> </listitem> diff --git a/reference/phar/Phar/convertToData.xml b/reference/phar/Phar/convertToData.xml index e127b011fa7e..a7c3e0471f85 100644 --- a/reference/phar/Phar/convertToData.xml +++ b/reference/phar/Phar/convertToData.xml @@ -41,8 +41,8 @@ <term><parameter>format</parameter></term> <listitem> <para> - This should be one of <literal>Phar::TAR</literal> - or <literal>Phar::ZIP</literal>. If set to &null;, the existing file format + This should be one of <constant>Phar::TAR</constant> + or <constant>Phar::ZIP</constant>. If set to &null;, the existing file format will be preserved. </para> </listitem> @@ -51,9 +51,9 @@ <term><parameter>compression</parameter></term> <listitem> <para> - This should be one of <literal>Phar::NONE</literal> for no whole-archive - compression, <literal>Phar::GZ</literal> for zlib-based compression, and - <literal>Phar::BZ2</literal> for bzip-based compression. + This should be one of <constant>Phar::NONE</constant> for no whole-archive + compression, <constant>Phar::GZ</constant> for zlib-based compression, and + <constant>Phar::BZ2</constant> for bzip-based compression. </para> </listitem> </varlistentry> diff --git a/reference/phar/Phar/convertToExecutable.xml b/reference/phar/Phar/convertToExecutable.xml index 5c1e67488b0b..88d5b2046c81 100644 --- a/reference/phar/Phar/convertToExecutable.xml +++ b/reference/phar/Phar/convertToExecutable.xml @@ -41,8 +41,8 @@ <term><parameter>format</parameter></term> <listitem> <para> - This should be one of <literal>Phar::PHAR</literal>, <literal>Phar::TAR</literal>, - or <literal>Phar::ZIP</literal>. If set to &null;, the existing file format + This should be one of <constant>Phar::PHAR</constant>, <constant>Phar::TAR</constant>, + or <constant>Phar::ZIP</constant>. If set to &null;, the existing file format will be preserved. </para> </listitem> @@ -51,9 +51,9 @@ <term><parameter>compression</parameter></term> <listitem> <para> - This should be one of <literal>Phar::NONE</literal> for no whole-archive - compression, <literal>Phar::GZ</literal> for zlib-based compression, and - <literal>Phar::BZ2</literal> for bzip-based compression. + This should be one of <constant>Phar::NONE</constant> for no whole-archive + compression, <constant>Phar::GZ</constant> for zlib-based compression, and + <constant>Phar::BZ2</constant> for bzip-based compression. </para> </listitem> </varlistentry> diff --git a/reference/phar/Phar/getSupportedCompression.xml b/reference/phar/Phar/getSupportedCompression.xml index 3248646ce075..cf8eb85c533b 100644 --- a/reference/phar/Phar/getSupportedCompression.xml +++ b/reference/phar/Phar/getSupportedCompression.xml @@ -26,8 +26,8 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns an array containing any of <literal>Phar::GZ</literal> or - <literal>Phar::BZ2</literal>, depending on the availability of + Returns an array containing any of <constant>Phar::GZ</constant> or + <constant>Phar::BZ2</constant>, depending on the availability of the <link linkend="book.zlib">zlib</link> extension or the <link linkend="book.bzip2">bz2</link> extension. </para> diff --git a/reference/phar/Phar/isCompressed.xml b/reference/phar/Phar/isCompressed.xml index 72d44fa11eeb..b6a84e39262e 100644 --- a/reference/phar/Phar/isCompressed.xml +++ b/reference/phar/Phar/isCompressed.xml @@ -31,7 +31,7 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - <literal>Phar::GZ</literal>, <literal>Phar::BZ2</literal> or &false;. + <constant>Phar::GZ</constant>, <constant>Phar::BZ2</constant> or &false;. </para> </refsect1> diff --git a/reference/phar/Phar/isFileFormat.xml b/reference/phar/Phar/isFileFormat.xml index 943c334c665b..f6b3ee546f9a 100644 --- a/reference/phar/Phar/isFileFormat.xml +++ b/reference/phar/Phar/isFileFormat.xml @@ -24,8 +24,8 @@ <term><parameter>format</parameter></term> <listitem> <para> - Either <literal>Phar::PHAR</literal>, <literal>Phar::TAR</literal>, or - <literal>Phar::ZIP</literal> to test for the format of the archive. + Either <constant>Phar::PHAR</constant>, <constant>Phar::TAR</constant>, or + <constant>Phar::ZIP</constant> to test for the format of the archive. </para> </listitem> </varlistentry> diff --git a/reference/phar/Phar/setSignatureAlgorithm.xml b/reference/phar/Phar/setSignatureAlgorithm.xml index d92187c6d3fe..d2dd12ef2ab8 100644 --- a/reference/phar/Phar/setSignatureAlgorithm.xml +++ b/reference/phar/Phar/setSignatureAlgorithm.xml @@ -17,9 +17,9 @@ <para> set the signature algorithm for a phar and apply it. The - signature algorithm must be one of <literal>Phar::MD5</literal>, - <literal>Phar::SHA1</literal>, <literal>Phar::SHA256</literal>, - <literal>Phar::SHA512</literal>, or <literal>Phar::OPENSSL</literal>. + signature algorithm must be one of <constant>Phar::MD5</constant>, + <constant>Phar::SHA1</constant>, <constant>Phar::SHA256</constant>, + <constant>Phar::SHA512</constant>, or <constant>Phar::OPENSSL</constant>. </para> <para> Note that all executable phar archives have a signature created @@ -38,9 +38,9 @@ <term><parameter>algo</parameter></term> <listitem> <para> - One of <literal>Phar::MD5</literal>, - <literal>Phar::SHA1</literal>, <literal>Phar::SHA256</literal>, - <literal>Phar::SHA512</literal>, or <literal>Phar::OPENSSL</literal> + One of <constant>Phar::MD5</constant>, + <constant>Phar::SHA1</constant>, <constant>Phar::SHA256</constant>, + <constant>Phar::SHA512</constant>, or <constant>Phar::OPENSSL</constant> </para> </listitem> </varlistentry> diff --git a/reference/phar/PharData/compress.xml b/reference/phar/PharData/compress.xml index 3be7fa707e55..17398f8dc2a5 100644 --- a/reference/phar/PharData/compress.xml +++ b/reference/phar/PharData/compress.xml @@ -28,7 +28,7 @@ </para> <para> In addition, this method automatically renames the archive, appending <literal>.gz</literal>, - <literal>.bz2</literal> or removing the extension if passed <literal>Phar::NONE</literal> to + <literal>.bz2</literal> or removing the extension if passed <constant>Phar::NONE</constant> to remove compression. Alternatively, a file extension may be specified with the second parameter. </para> @@ -42,8 +42,8 @@ <term><parameter>compression</parameter></term> <listitem> <para> - Compression must be one of <literal>Phar::GZ</literal>, - <literal>Phar::BZ2</literal> to add compression, or <literal>Phar::NONE</literal> + Compression must be one of <constant>Phar::GZ</constant>, + <constant>Phar::BZ2</constant> to add compression, or <constant>Phar::NONE</constant> to remove compression. </para> </listitem> diff --git a/reference/phar/PharData/compressFiles.xml b/reference/phar/PharData/compressFiles.xml index 363fbce92994..17a8b82290c3 100644 --- a/reference/phar/PharData/compressFiles.xml +++ b/reference/phar/PharData/compressFiles.xml @@ -37,8 +37,8 @@ <term><parameter>compression</parameter></term> <listitem> <para> - Compression must be one of <literal>Phar::GZ</literal>, - <literal>Phar::BZ2</literal> to add compression, or <literal>Phar::NONE</literal> + Compression must be one of <constant>Phar::GZ</constant>, + <constant>Phar::BZ2</constant> to add compression, or <constant>Phar::NONE</constant> to remove compression. </para> </listitem> diff --git a/reference/phar/PharData/convertToData.xml b/reference/phar/PharData/convertToData.xml index 1f4d12dde571..0a6edd3d32d1 100644 --- a/reference/phar/PharData/convertToData.xml +++ b/reference/phar/PharData/convertToData.xml @@ -42,8 +42,8 @@ <term><parameter>format</parameter></term> <listitem> <para> - This should be one of <literal>Phar::TAR</literal> - or <literal>Phar::ZIP</literal>. If set to &null;, the existing file format + This should be one of <constant>Phar::TAR</constant> + or <constant>Phar::ZIP</constant>. If set to &null;, the existing file format will be preserved. </para> </listitem> @@ -52,9 +52,9 @@ <term><parameter>compression</parameter></term> <listitem> <para> - This should be one of <literal>Phar::NONE</literal> for no whole-archive - compression, <literal>Phar::GZ</literal> for zlib-based compression, and - <literal>Phar::BZ2</literal> for bzip-based compression. + This should be one of <constant>Phar::NONE</constant> for no whole-archive + compression, <constant>Phar::GZ</constant> for zlib-based compression, and + <constant>Phar::BZ2</constant> for bzip-based compression. </para> </listitem> </varlistentry> diff --git a/reference/phar/PharData/convertToExecutable.xml b/reference/phar/PharData/convertToExecutable.xml index 64b0baf8f2cf..b09fae4903ac 100644 --- a/reference/phar/PharData/convertToExecutable.xml +++ b/reference/phar/PharData/convertToExecutable.xml @@ -39,8 +39,8 @@ <term><parameter>format</parameter></term> <listitem> <para> - This should be one of <literal>Phar::PHAR</literal>, <literal>Phar::TAR</literal>, - or <literal>Phar::ZIP</literal>. If set to &null;, the existing file format + This should be one of <constant>Phar::PHAR</constant>, <constant>Phar::TAR</constant>, + or <constant>Phar::ZIP</constant>. If set to &null;, the existing file format will be preserved. </para> </listitem> @@ -49,9 +49,9 @@ <term><parameter>compression</parameter></term> <listitem> <para> - This should be one of <literal>Phar::NONE</literal> for no whole-archive - compression, <literal>Phar::GZ</literal> for zlib-based compression, and - <literal>Phar::BZ2</literal> for bzip-based compression. + This should be one of <constant>Phar::NONE</constant> for no whole-archive + compression, <constant>Phar::GZ</constant> for zlib-based compression, and + <constant>Phar::BZ2</constant> for bzip-based compression. </para> </listitem> </varlistentry> diff --git a/reference/phar/PharData/setSignatureAlgorithm.xml b/reference/phar/PharData/setSignatureAlgorithm.xml index b759b4b6e87c..4014e69a9191 100644 --- a/reference/phar/PharData/setSignatureAlgorithm.xml +++ b/reference/phar/PharData/setSignatureAlgorithm.xml @@ -17,9 +17,9 @@ <para> Set the signature algorithm for a phar and apply it. The - signature algorithm must be one of <literal>Phar::MD5</literal>, - <literal>Phar::SHA1</literal>, <literal>Phar::SHA256</literal>, - <literal>Phar::SHA512</literal>, or <literal>Phar::OPENSSL</literal>. + signature algorithm must be one of <constant>Phar::MD5</constant>, + <constant>Phar::SHA1</constant>, <constant>Phar::SHA256</constant>, + <constant>Phar::SHA512</constant>, or <constant>Phar::OPENSSL</constant>. </para> </refsect1> @@ -31,9 +31,9 @@ <term><parameter>algo</parameter></term> <listitem> <para> - One of <literal>Phar::MD5</literal>, - <literal>Phar::SHA1</literal>, <literal>Phar::SHA256</literal>, - <literal>Phar::SHA512</literal>, or <literal>Phar::OPENSSL</literal> + One of <constant>Phar::MD5</constant>, + <constant>Phar::SHA1</constant>, <constant>Phar::SHA256</constant>, + <constant>Phar::SHA512</constant>, or <constant>Phar::OPENSSL</constant> </para> </listitem> </varlistentry>