cvs: phpdoc /en/reference/strings/functions md5.xml money-format.xml nl-langinfo.xml nl2br.xml ord.xml print.xml setlocale.xml str-replace.xml
str-shuffle.xml stripcslashes.xml strpbrk.xml strrev.xml ucfirst.xml wordwrap.xml

From:	Mehdi Achour	Date:	Mon, 11 Jun 2007 22:13:26 +0000
Subject:	cvs: phpdoc /en/reference/strings/functions md5.xml money-format.xml nl-langinfo.xml nl2br.xml ord.xml print.xml setlocale.xml str-replace.xml str-shuffle.xml stripcslashes.xml strpbrk.xml strrev.xml ucfirst.xml wordwrap.xml
Groups:	php.doc
Request:	Send a blank email to phpdoc+get-969376644@lists.php.net to get a copy of this message

didou Mon Jun 11 22:13:26 2007 UTC Modified files: /phpdoc/en/reference/strings/functions md5.xml money-format.xml nl-langinfo.xml nl2br.xml ord.xml print.xml setlocale.xml str-replace.xml str-shuffle.xml stripcslashes.xml strpbrk.xml strrev.xml ucfirst.xml wordwrap.xml Log: WS, prepare for new doc style

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/strings/functions/md5.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/strings/functions/md5.xml diff -u phpdoc/en/reference/strings/functions/md5.xml:1.7 phpdoc/en/reference/strings/functions/md5.xml:1.8 --- phpdoc/en/reference/strings/functions/md5.xml:1.7 Thu Jul 24 09:13:45 2003 +++ phpdoc/en/reference/strings/functions/md5.xml Mon Jun 11 22:13:26 2007 @@ -1,36 +1,36 @@ <?xml version="1.0" encoding="iso-8859-1"?> - +  - <refentry id="function.md5"> - <refnamediv> - <refname>md5</refname> - <refpurpose>Calculate the md5 hash of a string</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>md5</methodname> - <methodparam><type>string</type><parameter>str</parameter></methodparam> - <methodparam choice='opt'><type>bool</type><parameter>raw_output</parameter></methodparam> - </methodsynopsis> - <para> - Calculates the MD5 hash of <parameter>str</parameter> using the - <ulink url="&url.rfc;1321">RSA Data Security, Inc. - MD5 Message-Digest Algorithm</ulink>, and returns that hash. - The hash is a 32-character hexadecimal number. If the optional - <parameter>raw_output</parameter> is set to &true;, then the md5 digest - is instead returned in raw binary format with a length of 16. - </para> - <note> - <simpara> - The optional <parameter>raw_output</parameter> parameter was added in - PHP 5.0.0 and defaults to &false; - </simpara> - </note> - <para> - <example> - <title>A <function>md5</function> example</title> - <programlisting role="php"> +<refentry id="function.md5"> + <refnamediv> + <refname>md5</refname> + <refpurpose>Calculate the md5 hash of a string</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>md5</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + <methodparam choice='opt'><type>bool</type><parameter>raw_output</parameter></methodparam> + </methodsynopsis> + <para> + Calculates the MD5 hash of <parameter>str</parameter> using the + <ulink url="&url.rfc;1321">RSA Data Security, Inc. + MD5 Message-Digest Algorithm</ulink>, and returns that hash. + The hash is a 32-character hexadecimal number. If the optional + <parameter>raw_output</parameter> is set to &true;, then the md5 digest + is instead returned in raw binary format with a length of 16. + </para> + <note> + <simpara> + The optional <parameter>raw_output</parameter> parameter was added in + PHP 5.0.0 and defaults to &false; + </simpara> + </note> + <para> + <example> + <title>A <function>md5</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $str = 'apple'; @@ -41,15 +41,15 @@ } ?> ]]> - </programlisting> - </example> - </para> - <para> - See also <function>crc32</function>, <function>md5_file</function>, - and <function>sha1</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also <function>crc32</function>, <function>md5_file</function>, + and <function>sha1</function>. + </para> + </refsect1> +</refentry>  - <refentry id="function.money-format"> - <refnamediv> - <refname>money_format</refname> - <refpurpose>Formats a number as a currency string</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>money_format</methodname> - <methodparam><type>string</type><parameter>format</parameter></methodparam> - <methodparam><type>float</type><parameter>number</parameter></methodparam> - </methodsynopsis> - <para> - <function>money_format</function> returns a formatted version of - <parameter>number</parameter>. This function wraps the C library - function <function>strfmon</function>, with the difference that - this implementation converts only one number at a time. - </para> - <note> - <para> - The function <function>money_format</function> is only defined if - the system has strfmon capabilities. For example, Windows does - not, so <function>money_format</function> is undefined in Windows. - </para> - </note> - <para> - The format specification consists of the following sequence: - <itemizedlist> - <listitem><para>a <literal>%</literal> character</para></listitem> - <listitem><para>optional flags</para></listitem> - <listitem><para>optional field width</para></listitem> - <listitem><para>optional left precision</para></listitem> - <listitem><para>optional right precision</para></listitem> - <listitem><para>a required conversion character</para></listitem> - </itemizedlist> - </para> - <formalpara> - <title>Flags</title> - <para> - One or more of the optional flags below can be used: - <variablelist> - <varlistentry> - <term><literal>=</literal><replaceable>f</replaceable></term> - <listitem> - <para> - The character <literal>=</literal> followed by a (single byte) - character <replaceable>f</replaceable> to be used as the numeric fill - character. The default fill character is space. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>^</literal></term> - <listitem> - <para> - Disable the use of grouping characters (as defined - by the current locale). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>+</literal> or <literal>(</literal></term> - <listitem> - <para> - Specify the formatting style for positive and negative numbers. - If <literal>+</literal> is used, the locale's equivalent for - <literal>+</literal> and <literal>-</literal> will be used. If - <literal>(</literal> is used, negative amounts are enclosed in - parenthesis. If no specification is given, the default is - <literal>+</literal>. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>!</literal></term> - <listitem> - <para> - Suppress the currency symbol from the output string. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>-</literal></term> - <listitem> - <para> - If present, it will make all fields left-justified (padded to the - right), as opposed to the default which is for the fields to be - right-justified (padded to the left). - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </formalpara> - <formalpara> - <title>Field width</title> - <para> - <variablelist> - <varlistentry> - <term><replaceable>w</replaceable></term> - <listitem> - <para> - A decimal digit string specifying a minimum field width. Field will - be right-justified unless the flag <literal>-</literal> is used. - Default value is 0 (zero). - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </formalpara> - <formalpara> - <title>Left precision</title> - <para> - <variablelist> - <varlistentry> - <term><literal>#</literal><replaceable>n</replaceable></term> - <listitem> - <para> - The maximum number of digits (<replaceable>n</replaceable>) expected - to the left of the decimal character (e.g. the decimal point). It is - used usually to keep formatted output aligned in the same columns, - using the fill character if the number of digits is less than - <replaceable>n</replaceable>. If the number of actual digits is - bigger than <replaceable>n</replaceable>, then this specification is - ignored. - </para> - <para> - If grouping has not been suppressed using the <literal>^</literal> - flag, grouping separators will be inserted before the fill - characters (if any) are added. Grouping separators will not be - applied to fill characters, even if the fill character is a digit. - </para> - <para> - To ensure alignment, any characters appearing before or after the - number in the formatted output such as currency or sign symbols are - padded as necessary with space characters to make their positive and - negative formats an equal length. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </formalpara> - <formalpara> - <title> - Right precision - </title> - <para> - <variablelist> - <varlistentry> - <term><literal>.</literal><replaceable>p</replaceable></term> - <listitem> - <para> - A period followed by the number of digits - (<replaceable>p</replaceable>) after the decimal character. If the - value of <replaceable>p</replaceable> is 0 (zero), the decimal - character and the digits to its right will be omitted. If no right - precision is included, the default will dictated by the current - local in use. The amount being formatted is rounded to the specified - number of digits prior to formatting. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </formalpara> - <formalpara> - <title> - Conversion characters - </title> - <para> - <variablelist> - <varlistentry> - <term><literal>i</literal></term> - <listitem> - <para> - The number is formatted according to the locale's international - currency format (e.g. for the USA locale: USD 1,234.56). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>n</literal></term> - <listitem> - <para> - The number is formatted according to the locale's national - currency format (e.g. for the de_DE locale: DM1.234,56). - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>%</literal></term> - <listitem> - <para> - Returns the <literal>%</literal> character. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </formalpara> - <note> - <para> - The <constant>LC_MONETARY</constant> category of the locale settings, - affects the behavior of this function. Use - <function>setlocale</function> to set to the appropriate default locale - before using this function. - </para> - <para> - Characters before and after the formatting string will be returned - unchanged. - </para> - </note> - <para> - <example> - <title><function>money_format</function> Example</title> - <para> - We will use different locales and format specifications to - illustrate the use of this function. - </para> - <programlisting role="php"> + +<refentry id="function.money-format"> + <refnamediv> + <refname>money_format</refname> + <refpurpose>Formats a number as a currency string</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>money_format</methodname> + <methodparam><type>string</type><parameter>format</parameter></methodparam> + <methodparam><type>float</type><parameter>number</parameter></methodparam> + </methodsynopsis> + <para> + <function>money_format</function> returns a formatted version of + <parameter>number</parameter>. This function wraps the C library + function <function>strfmon</function>, with the difference that + this implementation converts only one number at a time. + </para> + <note> + <para> + The function <function>money_format</function> is only defined if + the system has strfmon capabilities. For example, Windows does + not, so <function>money_format</function> is undefined in Windows. + </para> + </note> + <para> + The format specification consists of the following sequence: + <itemizedlist> + <listitem><para>a <literal>%</literal> character</para></listitem> + <listitem><para>optional flags</para></listitem> + <listitem><para>optional field width</para></listitem> + <listitem><para>optional left precision</para></listitem> + <listitem><para>optional right precision</para></listitem> + <listitem><para>a required conversion character</para></listitem> + </itemizedlist> + </para> + <formalpara> + <title>Flags</title> + <para> + One or more of the optional flags below can be used: + <variablelist> + <varlistentry> + <term><literal>=</literal><replaceable>f</replaceable></term> + <listitem> + <para> + The character <literal>=</literal> followed by a (single byte) + character <replaceable>f</replaceable> to be used as the numeric fill + character. The default fill character is space. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>^</literal></term> + <listitem> + <para> + Disable the use of grouping characters (as defined + by the current locale). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>+</literal> or <literal>(</literal></term> + <listitem> + <para> + Specify the formatting style for positive and negative numbers. + If <literal>+</literal> is used, the locale's equivalent for + <literal>+</literal> and <literal>-</literal> will be used. If + <literal>(</literal> is used, negative amounts are enclosed in + parenthesis. If no specification is given, the default is + <literal>+</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>!</literal></term> + <listitem> + <para> + Suppress the currency symbol from the output string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>-</literal></term> + <listitem> + <para> + If present, it will make all fields left-justified (padded to the + right), as opposed to the default which is for the fields to be + right-justified (padded to the left). + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </formalpara> + <formalpara> + <title>Field width</title> + <para> + <variablelist> + <varlistentry> + <term><replaceable>w</replaceable></term> + <listitem> + <para> + A decimal digit string specifying a minimum field width. Field will + be right-justified unless the flag <literal>-</literal> is used. + Default value is 0 (zero). + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </formalpara> + <formalpara> + <title>Left precision</title> + <para> + <variablelist> + <varlistentry> + <term><literal>#</literal><replaceable>n</replaceable></term> + <listitem> + <para> + The maximum number of digits (<replaceable>n</replaceable>) expected + to the left of the decimal character (e.g. the decimal point). It is + used usually to keep formatted output aligned in the same columns, + using the fill character if the number of digits is less than + <replaceable>n</replaceable>. If the number of actual digits is + bigger than <replaceable>n</replaceable>, then this specification is + ignored. + </para> + <para> + If grouping has not been suppressed using the <literal>^</literal> + flag, grouping separators will be inserted before the fill + characters (if any) are added. Grouping separators will not be + applied to fill characters, even if the fill character is a digit. + </para> + <para> + To ensure alignment, any characters appearing before or after the + number in the formatted output such as currency or sign symbols are + padded as necessary with space characters to make their positive and + negative formats an equal length. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </formalpara> + <formalpara> + <title> + Right precision + </title> + <para> + <variablelist> + <varlistentry> + <term><literal>.</literal><replaceable>p</replaceable></term> + <listitem> + <para> + A period followed by the number of digits + (<replaceable>p</replaceable>) after the decimal character. If the + value of <replaceable>p</replaceable> is 0 (zero), the decimal + character and the digits to its right will be omitted. If no right + precision is included, the default will dictated by the current + local in use. The amount being formatted is rounded to the specified + number of digits prior to formatting. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </formalpara> + <formalpara> + <title> + Conversion characters + </title> + <para> + <variablelist> + <varlistentry> + <term><literal>i</literal></term> + <listitem> + <para> + The number is formatted according to the locale's international + currency format (e.g. for the USA locale: USD 1,234.56). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>n</literal></term> + <listitem> + <para> + The number is formatted according to the locale's national + currency format (e.g. for the de_DE locale: DM1.234,56). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>%</literal></term> + <listitem> + <para> + Returns the <literal>%</literal> character. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </formalpara> + <note> + <para> + The <constant>LC_MONETARY</constant> category of the locale settings, + affects the behavior of this function. Use + <function>setlocale</function> to set to the appropriate default locale + before using this function. + </para> + <para> + Characters before and after the formatting string will be returned + unchanged. + </para> + </note> + <para> + <example> + <title><function>money_format</function> Example</title> + <para> + We will use different locales and format specifications to + illustrate the use of this function. + </para> + <programlisting role="php"> <![CDATA[ <?php @@ -229,7 +229,7 @@ // let's print the international format for the en_US locale setlocale(LC_MONETARY, 'en_US'); -echo money_format('%i', $number) . "\n"; +echo money_format('%i', $number) . "\n"; // USD 1,234.56 // Italian national format with 2 decimals` @@ -246,11 +246,11 @@ echo money_format('%(#10n', $number) . "\n"; // ($ 1,234.57) -// Similar format as above, adding the use of 2 digits of right +// Similar format as above, adding the use of 2 digits of right // precision and '*' as a fill character echo money_format('%=*(#10.2n', $number) . "\n"; // ($********1,234.57) - + // Let's justify to the left, with 14 positions of width, 8 digits of // left precision, 2 of right precision, withouth grouping character // and using the international format for the de_DE locale. @@ -266,16 +266,16 @@ ?> ]]> - </programlisting> - </example> - </para> - <para> - See also: <function>setlocale</function>, - <function>number_format</function>, <function>sprintf</function>, - <function>printf</function> and <function>sscanf</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also: <function>setlocale</function>, + <function>number_format</function>, <function>sprintf</function>, + <function>printf</function> and <function>sscanf</function>. + </para> + </refsect1> +</refentry>  +  - <refentry id="function.nl-langinfo"> - <refnamediv> - <refname>nl_langinfo</refname> - <refpurpose> - Query language and locale information - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>nl_langinfo</methodname> - <methodparam><type>int</type><parameter>item</parameter></methodparam> - </methodsynopsis> - <para> - <function>nl_langinfo</function> is used to access individual elements of - the locale categories. Unlike <function>localeconv</function>, which - returns all of the elements, <function>nl_langinfo</function> allows you - to select any specific element. - </para> - <para> - If <parameter>item</parameter> is not valid, &false; will be returned. - </para> - <para> - <parameter>item</parameter> may be an integer value of the element or the - constant name of the element. The following is a list of constant names - for <parameter>item</parameter> that may be used and their description. - Some of these constants may not be defined or hold no value for certain - locales. - <table> - <title>nl_langinfo Constants</title> - <tgroup cols="2"> - <colspec colname="c1" /> - <colspec colname="c2" /> - <thead> - <row> - <entry>Constant</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry namest="c1" nameend="c2" align="center"><emphasis>LC_TIME Category Constants</emphasis></entry> - </row> - <row> - <entry>ABDAY_(1-7)</entry> - <entry>Abbreviated name of n-th day of the week.</entry> - </row> - <row> - <entry>DAY_(1-7)</entry> - <entry>Name of the n-th day of the week (DAY_1 = Sunday).</entry> - </row> - <row> - <entry>ABMON_(1-12)</entry> - <entry>Abbreviated name of the n-th month of the year.</entry> - </row> - <row> - <entry>MON_(1-12)</entry> - <entry>Name of the n-th month of the year.</entry> - </row> - <row> - <entry>AM_STR</entry> - <entry>String for Ante meridian.</entry> - </row> - <row> - <entry>PM_STR</entry> - <entry>String for Post meridian.</entry> - </row> - <row> - <entry>D_T_FMT</entry> - <entry>String that can be used as the format string for <function>strftime</function> to represent time and date.</entry> - </row> - <row> - <entry>D_FMT</entry> - <entry>String that can be used as the format string for <function>strftime</function> to represent date.</entry> - </row> - <row> - <entry>T_FMT</entry> - <entry>String that can be used as the format string for <function>strftime</function> to represent time.</entry> - </row> - <row> - <entry>T_FMT_AMPM</entry> - <entry>String that can be used as the format string for <function>strftime</function> to represent time in 12-hour format with ante/post meridian.</entry> - </row> - <row> - <entry>ERA</entry> - <entry>Alternate era.</entry> - </row> - <row> - <entry>ERA_YEAR</entry> - <entry>Year in alternate era format.</entry> - </row> - <row> - <entry>ERA_D_T_FMT</entry> - <entry>Date and time in alternate era format (string can be used in <function>strftime</function>).</entry> - </row> - <row> - <entry>ERA_D_FMT</entry> - <entry>Date in alternate era format (string can be used in <function>strftime</function>).</entry> - </row> - <row> - <entry>ERA_T_FMT</entry> - <entry>Time in alternate era format (string can be used in <function>strftime</function>).</entry> - </row> - <row> - <entry namest="c1" nameend="c2" align="center"><emphasis>LC_MONETARY Category Constants</emphasis></entry> - </row> - <row> - <entry>INT_CURR_SYMBOL</entry> - <entry>International currency symbol.</entry> - </row> - <row> - <entry>CURRENCY_SYMBOL</entry> - <entry>Local currency symbol.</entry> - </row> - <row> - <entry>CRNCYSTR</entry> - <entry>Same value as CURRENCY_SYMBOL.</entry> - </row> - <row> - <entry>MON_DECIMAL_POINT</entry> - <entry>Decimal point character.</entry> - </row> - <row> - <entry>MON_THOUSANDS_SEP</entry> - <entry>Thousands separator (groups of three digits).</entry> - </row> - <row> - <entry>MON_GROUPING</entry> - <entry>Like 'grouping' element.</entry> - </row> - <row> - <entry>POSITIVE_SIGN</entry> - <entry>Sign for positive values.</entry> - </row> - <row> - <entry>NEGATIVE_SIGN</entry> - <entry>Sign for negative values.</entry> - </row> - <row> - <entry>INT_FRAC_DIGITS</entry> - <entry>International fractional digits.</entry> - </row> - <row> - <entry>FRAC_DIGITS</entry> - <entry>Local fractional digits.</entry> - </row> - <row> - <entry>P_CS_PRECEDES</entry> - <entry>Returns 1 if CURRENCY_SYMBOL precedes a positive value.</entry> - </row> - <row> - <entry>P_SEP_BY_SPACE</entry> - <entry>Returns 1 if a space separates CURRENCY_SYMBOL from a positive value.</entry> - </row> - <row> - <entry>N_CS_PRECEDES</entry> - <entry>Returns 1 if CURRENCY_SYMBOL precedes a negative value.</entry> - </row> - <row> - <entry>N_SEP_BY_SPACE</entry> - <entry>Returns 1 if a space separates CURRENCY_SYMBOL from a negative value.</entry> - </row> - <row> - <entry>P_SIGN_POSN</entry> - <entry morerows="1" valign="middle"> - <itemizedlist> - <listitem> - <simpara> - Returns 0 if parentheses surround the quantity and currency_symbol. - </simpara> - </listitem> - <listitem> - <simpara> - Returns 1 if the sign string precedes the quantity and currency_symbol. - </simpara> - </listitem> - <listitem> - <simpara> - Returns 2 if the sign string follows the quantity and currency_symbol. - </simpara> - </listitem> - <listitem> - <simpara> - Returns 3 if the sign string immediately precedes the currency_symbol. - </simpara> - </listitem> - <listitem> - <simpara> - Returns 4 if the sign string immediately follows the currency_symbol. - </simpara> - </listitem> - </itemizedlist> - </entry> - </row> - <row> - <entry>N_SIGN_POSN</entry> - </row> - <row> - <entry namest="c1" nameend="c2" align="center"><emphasis>LC_NUMERIC Category Constants</emphasis></entry> - </row> - <row> - <entry>DECIMAL_POINT</entry> - <entry>Decimal point character.</entry> - </row> - <row> - <entry>RADIXCHAR</entry> - <entry>Same value as DECIMAL_POINT.</entry> - </row> - <row> - <entry>THOUSANDS_SEP</entry> - <entry>Separator character for thousands (groups of three digits).</entry> - </row> - <row> - <entry>THOUSEP</entry> - <entry>Same value as THOUSANDS_SEP.</entry> - </row> - <row> - <entry>GROUPING</entry> - <entry></entry> - </row> - <row> - <entry namest="c1" nameend="c2" align="center"><emphasis>LC_MESSAGES Category Constants</emphasis></entry> - </row> - <row> - <entry>YESEXPR</entry> - <entry>Regex string for matching 'yes' input.</entry> - </row> - <row> - <entry>NOEXPR</entry> - <entry>Regex string for matching 'no' input.</entry> - </row> - <row> - <entry>YESSTR</entry> - <entry>Output string for 'yes'.</entry> - </row> - <row> - <entry>NOSTR</entry> - <entry>Output string for 'no'.</entry> - </row> - <row> - <entry namest="c1" nameend="c2" align="center"><emphasis>LC_CTYPE Category Constants</emphasis></entry> - </row> - <row> - <entry>CODESET</entry> - <entry>Return a string with the name of the character encoding.</entry> - </row> - </tbody> - </tgroup> - </table> - </para> - &note.no-windows; - <para> - See also <function>setlocale</function> and - <function>localeconv</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.nl-langinfo"> + <refnamediv> + <refname>nl_langinfo</refname> + <refpurpose>Query language and locale information</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>nl_langinfo</methodname> + <methodparam><type>int</type><parameter>item</parameter></methodparam> + </methodsynopsis> + <para> + <function>nl_langinfo</function> is used to access individual elements of + the locale categories. Unlike <function>localeconv</function>, which + returns all of the elements, <function>nl_langinfo</function> allows you + to select any specific element. + </para> + <para> + If <parameter>item</parameter> is not valid, &false; will be returned. + </para> + <para> + <parameter>item</parameter> may be an integer value of the element or the + constant name of the element. The following is a list of constant names + for <parameter>item</parameter> that may be used and their description. + Some of these constants may not be defined or hold no value for certain + locales. + <table> + <title>nl_langinfo Constants</title> + <tgroup cols="2"> + <colspec colname="c1" /> + <colspec colname="c2" /> + <thead> + <row> + <entry>Constant</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry namest="c1" nameend="c2" align="center"><emphasis>LC_TIME Category Constants</emphasis></entry> + </row> + <row> + <entry>ABDAY_(1-7)</entry> + <entry>Abbreviated name of n-th day of the week.</entry> + </row> + <row> + <entry>DAY_(1-7)</entry> + <entry>Name of the n-th day of the week (DAY_1 = Sunday).</entry> + </row> + <row> + <entry>ABMON_(1-12)</entry> + <entry>Abbreviated name of the n-th month of the year.</entry> + </row> + <row> + <entry>MON_(1-12)</entry> + <entry>Name of the n-th month of the year.</entry> + </row> + <row> + <entry>AM_STR</entry> + <entry>String for Ante meridian.</entry> + </row> + <row> + <entry>PM_STR</entry> + <entry>String for Post meridian.</entry> + </row> + <row> + <entry>D_T_FMT</entry> + <entry>String that can be used as the format string for <function>strftime</function> to represent time and date.</entry> + </row> + <row> + <entry>D_FMT</entry> + <entry>String that can be used as the format string for <function>strftime</function> to represent date.</entry> + </row> + <row> + <entry>T_FMT</entry> + <entry>String that can be used as the format string for <function>strftime</function> to represent time.</entry> + </row> + <row> + <entry>T_FMT_AMPM</entry> + <entry>String that can be used as the format string for <function>strftime</function> to represent time in 12-hour format with ante/post meridian.</entry> + </row> + <row> + <entry>ERA</entry> + <entry>Alternate era.</entry> + </row> + <row> + <entry>ERA_YEAR</entry> + <entry>Year in alternate era format.</entry> + </row> + <row> + <entry>ERA_D_T_FMT</entry> + <entry>Date and time in alternate era format (string can be used in <function>strftime</function>).</entry> + </row> + <row> + <entry>ERA_D_FMT</entry> + <entry>Date in alternate era format (string can be used in <function>strftime</function>).</entry> + </row> + <row> + <entry>ERA_T_FMT</entry> + <entry>Time in alternate era format (string can be used in <function>strftime</function>).</entry> + </row> + <row> + <entry namest="c1" nameend="c2" align="center"><emphasis>LC_MONETARY Category Constants</emphasis></entry> + </row> + <row> + <entry>INT_CURR_SYMBOL</entry> + <entry>International currency symbol.</entry> + </row> + <row> + <entry>CURRENCY_SYMBOL</entry> + <entry>Local currency symbol.</entry> + </row> + <row> + <entry>CRNCYSTR</entry> + <entry>Same value as CURRENCY_SYMBOL.</entry> + </row> + <row> + <entry>MON_DECIMAL_POINT</entry> + <entry>Decimal point character.</entry> + </row> + <row> + <entry>MON_THOUSANDS_SEP</entry> + <entry>Thousands separator (groups of three digits).</entry> + </row> + <row> + <entry>MON_GROUPING</entry> + <entry>Like 'grouping' element.</entry> + </row> + <row> + <entry>POSITIVE_SIGN</entry> + <entry>Sign for positive values.</entry> + </row> + <row> + <entry>NEGATIVE_SIGN</entry> + <entry>Sign for negative values.</entry> + </row> + <row> + <entry>INT_FRAC_DIGITS</entry> + <entry>International fractional digits.</entry> + </row> + <row> + <entry>FRAC_DIGITS</entry> + <entry>Local fractional digits.</entry> + </row> + <row> + <entry>P_CS_PRECEDES</entry> + <entry>Returns 1 if CURRENCY_SYMBOL precedes a positive value.</entry> + </row> + <row> + <entry>P_SEP_BY_SPACE</entry> + <entry>Returns 1 if a space separates CURRENCY_SYMBOL from a positive value.</entry> + </row> + <row> + <entry>N_CS_PRECEDES</entry> + <entry>Returns 1 if CURRENCY_SYMBOL precedes a negative value.</entry> + </row> + <row> + <entry>N_SEP_BY_SPACE</entry> + <entry>Returns 1 if a space separates CURRENCY_SYMBOL from a negative value.</entry> + </row> + <row> + <entry>P_SIGN_POSN</entry> + <entry morerows="1" valign="middle"> + <itemizedlist> + <listitem> + <simpara> + Returns 0 if parentheses surround the quantity and currency_symbol. + </simpara> + </listitem> + <listitem> + <simpara> + Returns 1 if the sign string precedes the quantity and currency_symbol. + </simpara> + </listitem> + <listitem> + <simpara> + Returns 2 if the sign string follows the quantity and currency_symbol. + </simpara> + </listitem> + <listitem> + <simpara> + Returns 3 if the sign string immediately precedes the currency_symbol. + </simpara> + </listitem> + <listitem> + <simpara> + Returns 4 if the sign string immediately follows the currency_symbol. + </simpara> + </listitem> + </itemizedlist> + </entry> + </row> + <row> + <entry>N_SIGN_POSN</entry> + </row> + <row> + <entry namest="c1" nameend="c2" align="center"><emphasis>LC_NUMERIC Category Constants</emphasis></entry> + </row> + <row> + <entry>DECIMAL_POINT</entry> + <entry>Decimal point character.</entry> + </row> + <row> + <entry>RADIXCHAR</entry> + <entry>Same value as DECIMAL_POINT.</entry> + </row> + <row> + <entry>THOUSANDS_SEP</entry> + <entry>Separator character for thousands (groups of three digits).</entry> + </row> + <row> + <entry>THOUSEP</entry> + <entry>Same value as THOUSANDS_SEP.</entry> + </row> + <row> + <entry>GROUPING</entry> + <entry></entry> + </row> + <row> + <entry namest="c1" nameend="c2" align="center"><emphasis>LC_MESSAGES Category Constants</emphasis></entry> + </row> + <row> + <entry>YESEXPR</entry> + <entry>Regex string for matching 'yes' input.</entry> + </row> + <row> + <entry>NOEXPR</entry> + <entry>Regex string for matching 'no' input.</entry> + </row> + <row> + <entry>YESSTR</entry> + <entry>Output string for 'yes'.</entry> + </row> + <row> + <entry>NOSTR</entry> + <entry>Output string for 'no'.</entry> + </row> + <row> + <entry namest="c1" nameend="c2" align="center"><emphasis>LC_CTYPE Category Constants</emphasis></entry> + </row> + <row> + <entry>CODESET</entry> + <entry>Return a string with the name of the character encoding.</entry> + </row> + </tbody> + </tgroup> + </table> + </para> + &note.no-windows; + <para> + See also <function>setlocale</function> and + <function>localeconv</function>. + </para> + </refsect1> +</refentry>  +  - <refentry id="function.nl2br"> - <refnamediv> - <refname>nl2br</refname> - <refpurpose> - Inserts HTML line breaks before all newlines in a string - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>nl2br</methodname> - <methodparam><type>string</type><parameter>string</parameter></methodparam> - </methodsynopsis> - <para> - Returns <parameter>string</parameter> with '<br />' inserted - before all newlines. - </para> - <note> - <para> - Starting with PHP 4.0.5, <function>nl2br</function> is now XHTML - compliant. All versions before 4.0.5 will return - <parameter>string</parameter> with '<br>' inserted before - newlines instead of '<br />'. - </para> - </note> - <para> - <example> - <title>using <function>nl2br</function></title> - <programlisting role="php"> +<refentry id="function.nl2br"> + <refnamediv> + <refname>nl2br</refname> + <refpurpose>Inserts HTML line breaks before all newlines in a string</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>nl2br</methodname> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + </methodsynopsis> + <para> + Returns <parameter>string</parameter> with '<br />' inserted + before all newlines. + </para> + <note> + <para> + Starting with PHP 4.0.5, <function>nl2br</function> is now XHTML + compliant. All versions before 4.0.5 will return + <parameter>string</parameter> with '<br>' inserted before + newlines instead of '<br />'. + </para> + </note> + <para> + <example> + <title>using <function>nl2br</function></title> + <programlisting role="php"> <![CDATA[ <?php echo nl2br("foo isn't\n bar"); ?> ]]> - </programlisting> - <para> - this will output : - </para> - <screen> + </programlisting> + <para> + this will output : + </para> + <screen> <![CDATA[ foo isn't<br /> bar ]]> - </screen> - </example> - </para> - <para> - See also <function>htmlspecialchars</function>, - <function>htmlentities</function>, - <function>wordwrap</function>, and - <function>str_replace</function>. - </para> - </refsect1> - </refentry> + </screen> + </example> + </para> + <para> + See also <function>htmlspecialchars</function>, + <function>htmlentities</function>, + <function>wordwrap</function>, and + <function>str_replace</function>. + </para> + </refsect1> +</refentry>  +  - <refentry id="function.ord"> - <refnamediv> - <refname>ord</refname> - <refpurpose>Return ASCII value of character</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>ord</methodname> - <methodparam><type>string</type><parameter>string</parameter></methodparam> - </methodsynopsis> - <para> - Returns the ASCII value of the first character of - <parameter>string</parameter>. This function complements - <function>chr</function>. - <example> - <title><function>ord</function> example</title> - <programlisting role="php"> +<refentry id="function.ord"> + <refnamediv> + <refname>ord</refname> + <refpurpose>Return ASCII value of character</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>ord</methodname> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + </methodsynopsis> + <para> + Returns the ASCII value of the first character of + <parameter>string</parameter>. This function complements + <function>chr</function>. + <example> + <title><function>ord</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $str = "\n"; @@ -27,18 +27,18 @@ } ?> ]]> - </programlisting> - </example> - </para> - <para> - You can find an ASCII-table over here: <ulink url="&url.asciitable;" - >&url.asciitable;</ulink>. - </para> - <simpara> - See also <function>chr</function>. - </simpara> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + You can find an ASCII-table over here: <ulink url="&url.asciitable;" + >&url.asciitable;</ulink>. + </para> + <simpara> + See also <function>chr</function>. + </simpara> + </refsect1> +</refentry>  +  - <refentry id="function.print"> - <refnamediv> - <refname>print</refname> - <refpurpose>Output a string</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>print</methodname> - <methodparam><type>string</type><parameter>arg</parameter></methodparam> - </methodsynopsis> - <simpara> - Outputs <parameter>arg</parameter>. Returns <literal>1</literal>, - always. - </simpara> - <para> - <function>print</function> is not actually a real function (it is a - language construct) so you are not required to use parentheses - with its argument list. - </para> - <para> - <example> - <title><function>print</function> examples</title> - <programlisting role="php"> +<refentry id="function.print"> + <refnamediv> + <refname>print</refname> + <refpurpose>Output a string</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>print</methodname> + <methodparam><type>string</type><parameter>arg</parameter></methodparam> + </methodsynopsis> + <simpara> + Outputs <parameter>arg</parameter>. Returns <literal>1</literal>, + always. + </simpara> + <para> + <function>print</function> is not actually a real function (it is a + language construct) so you are not required to use parentheses + with its argument list. + </para> + <para> + <example> + <title><function>print</function> examples</title> + <programlisting role="php"> <![CDATA[ <?php print("Hello World"); @@ -32,7 +32,7 @@ print "print() also works without parentheses."; print "This spans -multiple lines. The newlines will be +multiple lines. The newlines will be output as well"; print "This spans\nmultiple lines. The newlines will be\noutput as well."; @@ -64,24 +64,24 @@ END; ?> ]]> - </programlisting> - </example> - </para> - <simpara> - For a short discussion about the differences between - <function>print</function> and <function>echo</function>, see this FAQTs - Knowledge Base Article: <ulink url="&url.echo-print;">&url.echo-print; - </ulink> - </simpara> - - &note.language-construct; - - <simpara> - See also <function>echo</function>, <function>printf</function>, - and <function>flush</function>. - </simpara> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <simpara> + For a short discussion about the differences between + <function>print</function> and <function>echo</function>, see this FAQTs + Knowledge Base Article: <ulink url="&url.echo-print;">&url.echo-print; + </ulink> + </simpara> + + &note.language-construct; + + <simpara> + See also <function>echo</function>, <function>printf</function>, + and <function>flush</function>. + </simpara> + </refsect1> +</refentry>  +  - <refentry id="function.setlocale"> - <refnamediv> - <refname>setlocale</refname> - <refpurpose>Set locale information</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>setlocale</methodname> - <methodparam><type>int</type><parameter>category</parameter></methodparam> - <methodparam><type>string</type><parameter>locale</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>...</parameter></methodparam> - </methodsynopsis> - <methodsynopsis> - <type>string</type><methodname>setlocale</methodname> - <methodparam><type>int</type><parameter>category</parameter></methodparam> - <methodparam><type>array</type><parameter>locale</parameter></methodparam> - </methodsynopsis> - <para> - <parameter>category</parameter> is a named constant (or string) - specifying the category of the functions affected by the locale - setting: - <itemizedlist> - <listitem> - <simpara> - LC_ALL for all of the below - </simpara> - </listitem> - <listitem> - <simpara> - LC_COLLATE for string comparison, see - <function>strcoll</function> - </simpara> - </listitem> - <listitem> - <simpara> - LC_CTYPE for character classification and conversion, for - example <function>strtoupper</function> - </simpara> - </listitem> - <listitem> - <simpara> - LC_MONETARY for <function>localeconv</function> - </simpara> - </listitem> - <listitem> - <simpara> LC_NUMERIC for decimal separator (See also - <function>localeconv</function>) - </simpara> - </listitem> - <listitem> - <simpara> - LC_TIME for date and time formatting with - <function>strftime</function> - </simpara> - </listitem> - <listitem> - <simpara> - LC_MESSAGES for system responses (available if PHP was compiled with - <literal>libintl</literal>) - </simpara> - </listitem> - </itemizedlist> - </para> - <note> - <simpara> - As of PHP 4.2.0, passing <parameter>category</parameter> as a string is - deprecated, use the above constants instead. Passing them as a string - (within quotes) will result in a warning message. - </simpara> - </note> - <para> - If <parameter>locale</parameter> is &null; or the empty string - <literal>""</literal>, the locale names will be set from the - values of environment variables with the same names as the above - categories, or from "LANG". - </para> - <para> - If <parameter>locale</parameter> is <literal>"0"</literal>, - the locale setting is not affected, only the current setting is returned. - </para> - <para> - If <parameter>locale</parameter> is an array or followed by additional - parameters then each array element or parameter is tried to be set as - new locale until success. This is useful if a locale is known under - different names on different systems or for providing a fallback - for a possibly not available locale. - </para> - <note> - <simpara> - Passing multiple locales is not available before PHP 4.3.0 - </simpara> - </note> - <para> - Setlocale returns the new current locale, or &false; if the locale - functionality is not implemented on your platform, the specified - locale does not exist or the category name is invalid. - An invalid category name also causes a warning message. Category/locale - names can be found in <ulink url="&url.rfc;1766">RFC 1766</ulink> - and <ulink url="&url.iso-639;">ISO 639</ulink>. - Different systems have different naming schemes for locales. - </para> - <note> - <para> - The return value of <function>setlocale</function> depends - on the system that PHP is running. It returns exactly - what the system setlocale function returns. - </para> - </note> - <warning> - <para> - The locale information is maintained per process, not per - thread. If you are running PHP on a multithreaded server - api like IIS or Apache on Windows you may experience - sudden changes of locale settings while a script is - running although the script itself never called <function>setlocale</function> - itself. This happens due to other scripts running in different - threads of the same process at the same time changing the - processwide locale using <function>setlocale</function>. - </para> - </warning> - <tip> - <para> - Windows users will find useful information about - <parameter>locale</parameter> strings at Microsoft's - <acronym>MSDN</acronym> website. Supported language strings can be found - at <ulink url="&url.setlocale.lang.win32;">&url.setlocale.lang.win32;</ulink> and supported - country/region strings at - <ulink url="&url.setlocale.country.win32;">&url.setlocale.country.win32;</ulink>. - Windows systems support the three letter codes for - country/region specified by <literal>ISO 3166-Alpha-3</literal>, which - can be found at this <ulink url="&url.iso-3166-3;">Unicode website</ulink>. - </para> - </tip> - <para> - <example> - <title><function>setlocale</function> Examples</title> - <programlisting role="php"> +<refentry id="function.setlocale"> + <refnamediv> + <refname>setlocale</refname> + <refpurpose>Set locale information</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>setlocale</methodname> + <methodparam><type>int</type><parameter>category</parameter></methodparam> + <methodparam><type>string</type><parameter>locale</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>...</parameter></methodparam> + </methodsynopsis> + <methodsynopsis> + <type>string</type><methodname>setlocale</methodname> + <methodparam><type>int</type><parameter>category</parameter></methodparam> + <methodparam><type>array</type><parameter>locale</parameter></methodparam> + </methodsynopsis> + <para> + <parameter>category</parameter> is a named constant (or string) + specifying the category of the functions affected by the locale + setting: + <itemizedlist> + <listitem> + <simpara> + LC_ALL for all of the below + </simpara> + </listitem> + <listitem> + <simpara> + LC_COLLATE for string comparison, see + <function>strcoll</function> + </simpara> + </listitem> + <listitem> + <simpara> + LC_CTYPE for character classification and conversion, for + example <function>strtoupper</function> + </simpara> + </listitem> + <listitem> + <simpara> + LC_MONETARY for <function>localeconv</function> + </simpara> + </listitem> + <listitem> + <simpara> LC_NUMERIC for decimal separator (See also + <function>localeconv</function>) + </simpara> + </listitem> + <listitem> + <simpara> + LC_TIME for date and time formatting with + <function>strftime</function> + </simpara> + </listitem> + <listitem> + <simpara> + LC_MESSAGES for system responses (available if PHP was compiled with + <literal>libintl</literal>) + </simpara> + </listitem> + </itemizedlist> + </para> + <note> + <simpara> + As of PHP 4.2.0, passing <parameter>category</parameter> as a string is + deprecated, use the above constants instead. Passing them as a string + (within quotes) will result in a warning message. + </simpara> + </note> + <para> + If <parameter>locale</parameter> is &null; or the empty string + <literal>""</literal>, the locale names will be set from the + values of environment variables with the same names as the above + categories, or from "LANG". + </para> + <para> + If <parameter>locale</parameter> is <literal>"0"</literal>, + the locale setting is not affected, only the current setting is returned. + </para> + <para> + If <parameter>locale</parameter> is an array or followed by additional + parameters then each array element or parameter is tried to be set as + new locale until success. This is useful if a locale is known under + different names on different systems or for providing a fallback + for a possibly not available locale. + </para> + <note> + <simpara> + Passing multiple locales is not available before PHP 4.3.0 + </simpara> + </note> + <para> + Setlocale returns the new current locale, or &false; if the locale + functionality is not implemented on your platform, the specified + locale does not exist or the category name is invalid. + An invalid category name also causes a warning message. Category/locale + names can be found in <ulink url="&url.rfc;1766">RFC 1766</ulink> + and <ulink url="&url.iso-639;">ISO 639</ulink>. + Different systems have different naming schemes for locales. + </para> + <note> + <para> + The return value of <function>setlocale</function> depends + on the system that PHP is running. It returns exactly + what the system setlocale function returns. + </para> + </note> + <warning> + <para> + The locale information is maintained per process, not per + thread. If you are running PHP on a multithreaded server + api like IIS or Apache on Windows you may experience + sudden changes of locale settings while a script is + running although the script itself never called <function>setlocale</function> + itself. This happens due to other scripts running in different + threads of the same process at the same time changing the + processwide locale using <function>setlocale</function>. + </para> + </warning> + <tip> + <para> + Windows users will find useful information about + <parameter>locale</parameter> strings at Microsoft's + <acronym>MSDN</acronym> website. Supported language strings can be found + at <ulink url="&url.setlocale.lang.win32;">&url.setlocale.lang.win32;</ulink> and supported + country/region strings at + <ulink url="&url.setlocale.country.win32;">&url.setlocale.country.win32;</ulink>. + Windows systems support the three letter codes for + country/region specified by <literal>ISO 3166-Alpha-3</literal>, which + can be found at this <ulink url="&url.iso-3166-3;">Unicode website</ulink>. + </para> + </tip> + <para> + <example> + <title><function>setlocale</function> Examples</title> + <programlisting role="php"> <![CDATA[ <?php /* Set locale to Dutch */ @@ -152,13 +152,13 @@ echo "Preferred locale for german on this system is '$loc_de'"; ?> ]]> - </programlisting> - </example> - </para> - <para> - <example> - <title><function>setlocale</function> Examples for Windows</title> - <programlisting role="php"> + </programlisting> + </example> + </para> + <para> + <example> + <title><function>setlocale</function> Examples for Windows</title> + <programlisting role="php"> <![CDATA[ <?php /* Set locale to Dutch */ @@ -172,11 +172,11 @@ echo "Preferred locale for german on this system is '$loc_de'"; ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry>  +  - <refentry id="function.str-replace"> - <refnamediv> - <refname>str_replace</refname> - <refpurpose> - Replace all occurrences of the search string with the replacement string - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>mixed</type><methodname>str_replace</methodname> - <methodparam><type>mixed</type><parameter>search</parameter></methodparam> - <methodparam><type>mixed</type><parameter>replace</parameter></methodparam> - <methodparam><type>mixed</type><parameter>subject</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter role="reference">count</parameter></methodparam> - </methodsynopsis> - <para> - This function returns a string or an array with all occurrences of - <parameter>search</parameter> in <parameter>subject</parameter> - replaced with the given <parameter>replace</parameter> value. If you - don't need fancy replacing rules (like regular expressions), you should - always use this function instead of <function>ereg_replace</function> or - <function>preg_replace</function>. - </para> - <para> - As of PHP 4.0.5, every parameter in <function>str_replace</function> - can be an <type>array</type>. - </para> - <warning> - <simpara> - In PHP versions prior to 4.3.3 a bug existed when using arrays as - both <parameter>search</parameter> and <parameter>replace</parameter> - parameters which caused empty <parameter>search</parameter> indexes - to be skipped without advancing the internal pointer on the - <parameter>replace</parameter> array. This has been corrected in - PHP 4.3.3, any scripts which relied on this bug - should remove empty search values prior to calling this function in - order to mimick the original behavior. - </simpara> - </warning> - <para> - If <parameter>subject</parameter> is an array, then the search - and replace is performed with every entry of - <parameter>subject</parameter>, and the return value is an array - as well. - </para> - <para> - If <parameter>search</parameter> and - <parameter>replace</parameter> are arrays, then - <function>str_replace</function> takes a value from each array - and uses them to do search and replace on - <parameter>subject</parameter>. If - <parameter>replace</parameter> has fewer values than - <parameter>search</parameter>, then an empty string is used for - the rest of replacement values. If <parameter>search</parameter> - is an array and <parameter>replace</parameter> is a string, then - this replacement string is used for every value of - <parameter>search</parameter>. The converse would not make sense, - though. - </para> - <para> - If <parameter>search</parameter> or <parameter>replace</parameter> - are arrays, their elements are processed first to last. - </para> - <para> - <example> - <title><function>str_replace</function> examples</title> - <programlisting role="php"> +<refentry id="function.str-replace"> + <refnamediv> + <refname>str_replace</refname> + <refpurpose>Replace all occurrences of the search string with the replacement string</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>mixed</type><methodname>str_replace</methodname> + <methodparam><type>mixed</type><parameter>search</parameter></methodparam> + <methodparam><type>mixed</type><parameter>replace</parameter></methodparam> + <methodparam><type>mixed</type><parameter>subject</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter role="reference">count</parameter></methodparam> + </methodsynopsis> + <para> + This function returns a string or an array with all occurrences of + <parameter>search</parameter> in <parameter>subject</parameter> + replaced with the given <parameter>replace</parameter> value. If you + don't need fancy replacing rules (like regular expressions), you should + always use this function instead of <function>ereg_replace</function> or + <function>preg_replace</function>. + </para> + <para> + As of PHP 4.0.5, every parameter in <function>str_replace</function> + can be an <type>array</type>. + </para> + <warning> + <simpara> + In PHP versions prior to 4.3.3 a bug existed when using arrays as + both <parameter>search</parameter> and <parameter>replace</parameter> + parameters which caused empty <parameter>search</parameter> indexes + to be skipped without advancing the internal pointer on the + <parameter>replace</parameter> array. This has been corrected in + PHP 4.3.3, any scripts which relied on this bug + should remove empty search values prior to calling this function in + order to mimick the original behavior. + </simpara> + </warning> + <para> + If <parameter>subject</parameter> is an array, then the search + and replace is performed with every entry of + <parameter>subject</parameter>, and the return value is an array + as well. + </para> + <para> + If <parameter>search</parameter> and + <parameter>replace</parameter> are arrays, then + <function>str_replace</function> takes a value from each array + and uses them to do search and replace on + <parameter>subject</parameter>. If + <parameter>replace</parameter> has fewer values than + <parameter>search</parameter>, then an empty string is used for + the rest of replacement values. If <parameter>search</parameter> + is an array and <parameter>replace</parameter> is a string, then + this replacement string is used for every value of + <parameter>search</parameter>. The converse would not make sense, + though. + </para> + <para> + If <parameter>search</parameter> or <parameter>replace</parameter> + are arrays, their elements are processed first to last. + </para> + <para> + <example> + <title><function>str_replace</function> examples</title> + <programlisting role="php"> <![CDATA[ <?php // Provides: <body text='black'> @@ -89,11 +87,11 @@ $str = str_replace("ll", "", "good golly miss molly!", $count); echo $count; // 2 -// Order of replacement +// Order of replacement $str = "Line 1\nLine 2\rLine 3\r\nLine 4\n"; $order = array("\r\n", "\n", "\r"); $replace = '<br />'; -// Processes \r\n's first so they aren't converted twice. +// Processes \r\n's first so they aren't converted twice. $newstr = str_replace($order, $replace, $str); // Outputs: apearpearle pear @@ -101,39 +99,39 @@ $fruit = array('apple', 'pear'); $text = 'a p'; $output = str_replace($letters, $fruit, $text); -echo $output; +echo $output; ?> ]]> - </programlisting> - </example> - </para> - - &note.bin-safe; - - <note> - <para> - This function is case-sensitive. Use <function>str_ireplace</function> - for case-insensitive replace. - </para> - </note> - - <note> - <simpara> - As of PHP 5.0.0 the number of matched and replaced - needles (<parameter>search</parameter>) will be returned in - <parameter>count</parameter> which is passed by reference. - Prior to PHP 5.0.0 this parameter is not available. - </simpara> - </note> - <para> - See also - <function>str_ireplace</function>, - <function>substr_replace</function>, - <function>preg_replace</function>, and - <function>strtr</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + + &note.bin-safe; + + <note> + <para> + This function is case-sensitive. Use <function>str_ireplace</function> + for case-insensitive replace. + </para> + </note> + + <note> + <simpara> + As of PHP 5.0.0 the number of matched and replaced + needles (<parameter>search</parameter>) will be returned in + <parameter>count</parameter> which is passed by reference. + Prior to PHP 5.0.0 this parameter is not available. + </simpara> + </note> + <para> + See also + <function>str_ireplace</function>, + <function>substr_replace</function>, + <function>preg_replace</function>, and + <function>strtr</function>. + </para> + </refsect1> +</refentry>  - <refentry id="function.str-shuffle"> - <refnamediv> - <refname>str_shuffle</refname> - <refpurpose>Randomly shuffles a string</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>str_shuffle</methodname> - <methodparam><type>string</type><parameter>str</parameter></methodparam> - </methodsynopsis> - <simpara> - <function>str_shuffle</function> shuffles a string. One permutation - of all possible is created. - </simpara> - <para> - <example> - <title><function>str_shuffle</function> example</title> - <programlisting role="php"> + +<refentry id="function.str-shuffle"> + <refnamediv> + <refname>str_shuffle</refname> + <refpurpose>Randomly shuffles a string</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>str_shuffle</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + </methodsynopsis> + <simpara> + <function>str_shuffle</function> shuffles a string. One permutation + of all possible is created. + </simpara> + <para> + <example> + <title><function>str_shuffle</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $str = 'abcdef'; @@ -28,14 +28,14 @@ echo $shuffled; ?> ]]> - </programlisting> - </example> - </para> - <simpara> - See also <function>shuffle</function> and <function>rand</function>. - </simpara> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <simpara> + See also <function>shuffle</function> and <function>rand</function>. + </simpara> + </refsect1> +</refentry>  +  - <refentry id="function.stripcslashes"> - <refnamediv> - <refname>stripcslashes</refname> - <refpurpose> - Un-quote string quoted with <function>addcslashes</function> - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>stripcslashes</methodname> - <methodparam><type>string</type><parameter>str</parameter></methodparam> - </methodsynopsis> - <para> - Returns a string with backslashes stripped off. Recognizes - C-like <literal>\n</literal>, <literal>\r</literal> ..., octal - and hexadecimal representation. - </para> - <simpara> - See also <function>addcslashes</function>. - </simpara> - </refsect1> - </refentry> +<refentry id="function.stripcslashes"> + <refnamediv> + <refname>stripcslashes</refname> + <refpurpose>Un-quote string quoted with <function>addcslashes</function></refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>stripcslashes</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + </methodsynopsis> + <para> + Returns a string with backslashes stripped off. Recognizes + C-like <literal>\n</literal>, <literal>\r</literal> ..., octal + and hexadecimal representation. + </para> + <simpara> + See also <function>addcslashes</function>. + </simpara> + </refsect1> +</refentry>  - <refentry id="function.strpbrk"> - <refnamediv> - <refname>strpbrk</refname> - <refpurpose> - Search a string for any of a set of characters - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>strpbrk</methodname> - <methodparam><type>string</type><parameter>haystack</parameter></methodparam> - <methodparam><type>string</type><parameter>char_list</parameter></methodparam> - </methodsynopsis> - <para> - <function>strpbrk</function> searches the <parameter>haystack</parameter> - string for a <parameter>char_list</parameter>, and returns a string - starting from the character found (or &false; if it is not found). - </para> - <note> - <para> - The <parameter>char_list</parameter> parameter is case sensitive. - </para> - </note> - <para> - <example> - <title><function>strpbrk</function> example</title> - <programlisting role="php"> + +<refentry id="function.strpbrk"> + <refnamediv> + <refname>strpbrk</refname> + <refpurpose>Search a string for any of a set of characters</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>strpbrk</methodname> + <methodparam><type>string</type><parameter>haystack</parameter></methodparam> + <methodparam><type>string</type><parameter>char_list</parameter></methodparam> + </methodsynopsis> + <para> + <function>strpbrk</function> searches the <parameter>haystack</parameter> + string for a <parameter>char_list</parameter>, and returns a string + starting from the character found (or &false; if it is not found). + </para> + <note> + <para> + The <parameter>char_list</parameter> parameter is case sensitive. + </para> + </note> + <para> + <example> + <title><function>strpbrk</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -40,11 +38,11 @@ echo strpbrk($text, 'S'); ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry>  +  - <refentry id="function.strrev"> - <refnamediv> - <refname>strrev</refname> - <refpurpose>Reverse a string</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>strrev</methodname> - <methodparam><type>string</type><parameter>string</parameter></methodparam> - </methodsynopsis> - <para> - Returns <parameter>string</parameter>, reversed. - <example> - <title>Reversing a string with <function>strrev</function></title> - <programlisting role="php"> +<refentry id="function.strrev"> + <refnamediv> + <refname>strrev</refname> + <refpurpose>Reverse a string</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>strrev</methodname> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + </methodsynopsis> + <para> + Returns <parameter>string</parameter>, reversed. + <example> + <title>Reversing a string with <function>strrev</function></title> + <programlisting role="php"> <![CDATA[ <?php echo strrev("Hello world!"); // outputs "!dlrow olleH" ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry>  +  - <refentry id="function.ucfirst"> - <refnamediv> - <refname>ucfirst</refname> - <refpurpose>Make a string's first character uppercase</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>ucfirst</methodname> - <methodparam><type>string</type><parameter>str</parameter></methodparam> - </methodsynopsis> - <para> - Returns a string with the first character of - <parameter>str</parameter> capitalized, if that character is - alphabetic. - </para> - <para> - Note that 'alphabetic' is determined by the current locale. For - instance, in the default "C" locale characters such as umlaut-a - (ä) will not be converted. - <example> - <title><function>ucfirst</function> example</title> - <programlisting role="php"> +<refentry id="function.ucfirst"> + <refnamediv> + <refname>ucfirst</refname> + <refpurpose>Make a string's first character uppercase</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>ucfirst</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + </methodsynopsis> + <para> + Returns a string with the first character of + <parameter>str</parameter> capitalized, if that character is + alphabetic. + </para> + <para> + Note that 'alphabetic' is determined by the current locale. For + instance, in the default "C" locale characters such as umlaut-a + (ä) will not be converted. + <example> + <title><function>ucfirst</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $foo = 'hello world!'; @@ -34,15 +34,15 @@ $bar = ucfirst(strtolower($bar)); // Hello world! ?> ]]> - </programlisting> - </example> - </para> - <para> - See also <function>strtolower</function>, <function>strtoupper</function>, - and <function>ucwords</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also <function>strtolower</function>, <function>strtoupper</function>, + and <function>ucwords</function>. + </para> + </refsect1> +</refentry>  +  - <refentry id="function.wordwrap"> - <refnamediv> - <refname>wordwrap</refname> - <refpurpose> - Wraps a string to a given number of characters using a string - break character - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>wordwrap</methodname> - <methodparam><type>string</type><parameter>str</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>width</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>break</parameter></methodparam> - <methodparam choice="opt"><type>bool</type><parameter>cut</parameter></methodparam> - </methodsynopsis> - <para> - Returns a string with <parameter>str</parameter> wrapped - at the column number specified by the optional - <parameter>width</parameter> parameter. The line is broken - using the (optional) <parameter>break</parameter> parameter. - </para> - <para> - <function>wordwrap</function> will automatically wrap at column - 75 and break using '<literal>\n</literal>' (newline) if - <parameter>width</parameter> or <parameter>break</parameter> - are not given. - </para> - <para> - If the <parameter>cut</parameter> is set to &true;, the string is - always wrapped at the specified width. So if you have a word - that is larger than the given width, it is broken apart. - (See second example). - <note> - <para> - The optional <parameter>cut</parameter> parameter was added in PHP - 4.0.3 - </para> - </note> - </para> - <example> - <title><function>wordwrap</function> example</title> - <programlisting role="php"> +<refentry id="function.wordwrap"> + <refnamediv> + <refname>wordwrap</refname> + <refpurpose>Wraps a string to a given number of characters using a string break character</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>wordwrap</methodname> + <methodparam><type>string</type><parameter>str</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>width</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>break</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>cut</parameter></methodparam> + </methodsynopsis> + <para> + Returns a string with <parameter>str</parameter> wrapped + at the column number specified by the optional + <parameter>width</parameter> parameter. The line is broken + using the (optional) <parameter>break</parameter> parameter. + </para> + <para> + <function>wordwrap</function> will automatically wrap at column + 75 and break using '<literal>\n</literal>' (newline) if + <parameter>width</parameter> or <parameter>break</parameter> + are not given. + </para> + <para> + If the <parameter>cut</parameter> is set to &true;, the string is + always wrapped at the specified width. So if you have a word + that is larger than the given width, it is broken apart. + (See second example). + <note> + <para> + The optional <parameter>cut</parameter> parameter was added in PHP + 4.0.3 + </para> + </note> + </para> + <example> + <title><function>wordwrap</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $text = "The quick brown fox jumped over the lazy dog."; @@ -53,21 +50,21 @@ echo $newtext; ?> ]]> - </programlisting> - <para> - This example would display: - </para> - <screen> + </programlisting> + <para> + This example would display: + </para> + <screen> <![CDATA[ The quick brown fox<br /> jumped over the lazy<br /> dog. ]]> - </screen> - </example> - <example> - <title><function>wordwrap</function> example</title> - <programlisting role="php"> + </screen> + </example> + <example> + <title><function>wordwrap</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $text = "A very long woooooooooooord."; @@ -76,25 +73,25 @@ echo "$newtext\n"; ?> ]]> - </programlisting> - <para> - This example would display: - </para> - <screen> + </programlisting> + <para> + This example would display: + </para> + <screen> <![CDATA[ A very long wooooooo ooooord. ]]> - </screen> - </example> - <para> - See also <function>nl2br</function> and - <function>chunk_split</function>. - </para> - </refsect1> - </refentry> + </screen> + </example> + <para> + See also <function>nl2br</function> and + <function>chunk_split</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables:

cvs: phpdoc /en/reference/strings/functions md5.xml money-format.xml nl-langinfo.xml nl2br.xml ord.xml print.xml setlocale.xml str-replace.xml str-shuffle.xml stripcslashes.xml strpbrk.xml strrev.xml ucfirst.xml wordwrap.xml

cvs: phpdoc /en/reference/strings/functions md5.xml money-format.xml nl-langinfo.xml nl2br.xml ord.xml print.xml setlocale.xml str-replace.xml
str-shuffle.xml stripcslashes.xml strpbrk.xml strrev.xml ucfirst.xml wordwrap.xml