[PHP 8.4] mbstring関数の追加

language-snippets.ent

@@ -4234,6 +4234,14 @@ local: {
 </para>
 '>
 
+<!ENTITY strings.parameter.unicode.optional '
+ <simpara xmlns="http://docbook.org/ns/docbook">
+  <parameter>characters</parameter> パラメータにより、
+  削除する文字を指定することも可能です。
+  削除したい全ての文字をリストにしてください。
+ </simpara>
+'>
+
 <!-- strings snippets -->
 <!ENTITY strings.parameter.encoding '
  <para xmlns="http://docbook.org/ns/docbook">

reference/mbstring/functions/mb-lcfirst.xml

@@ -0,0 +1,78 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry xml:id="function.mb-lcfirst" xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+  <refname>mb_lcfirst</refname>
+  <refpurpose>文字列の最初の文字を小文字にする</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>string</type><methodname>mb_lcfirst</methodname>
+   <methodparam><type>string</type><parameter>string</parameter></methodparam>
+   <methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
+  </methodsynopsis>
+  <simpara>
+   マルチバイト対応の <function>lcfirst</function> 処理を行い、
+   <parameter>string</parameter> の最初の文字を小文字に変換して返します。.
+  </simpara>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>string</parameter></term>
+    <listitem>
+     <simpara>
+      入力文字列。
+     </simpara>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>encoding</parameter></term>
+    <listitem>
+     <simpara>
+      文字エンコーディングを指定します。省略した場合、もしくは<type>null</type>の場合は、内部文字エンコーディングを使用します。
+     </simpara>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <simpara>
+   変換後の文字列を返します。
+  </simpara>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <simplelist>
+   <member><function>mb_ucfirst</function></member>
+   <member><function>lcfirst</function></member>
+  </simplelist>
+ </refsect1>
+
+</refentry>
+ <!-- Keep this comment at the end of the file
+ Local variables:
+ mode: sgml
+ sgml-omittag:t
+ sgml-shorttag:t
+ sgml-minimize-attributes:nil
+ sgml-always-quote-attributes:t
+ sgml-indent-step:1
+ sgml-indent-data:t
+ indent-tabs-mode:nil
+ sgml-parent-document:nil
+ sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+ sgml-exposed-tags:nil
+ sgml-local-catalogs:nil
+ sgml-local-ecat-files:nil
+ End:
+ vim600: syn=xml fen fdm=syntax fdl=2 si
+ vim: et tw=78 syn=sgml
+ vi: ts=1 sw=1
+ -->

reference/mbstring/functions/mb-ltrim.xml

@@ -0,0 +1,92 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry xml:id="function.mb-ltrim" xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+  <refname>mb_ltrim</refname>
+  <refpurpose>文字列の先頭にあるホワイトスペースを取り除く</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>string</type><methodname>mb_ltrim</methodname>
+   <methodparam><type>string</type><parameter>string</parameter></methodparam>
+   <methodparam choice="opt"><type>string</type><parameter>characters</parameter><initializer>&null;</initializer></methodparam>
+   <methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
+  </methodsynopsis>
+  <simpara>
+   マルチバイト対応の <function>ltrim</function> 処理を行い、
+   <parameter>string</parameter>の最初から空白文字を取り除き、
+   取り除かれた文字列を返します。
+  </simpara>
+  <simpara>
+   2番目のパラメータを指定しない場合、
+   <function>mb_ltrim</function> は以下の文字を削除します。
+  </simpara>
+  &strings.stripped.unicode;
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>string</parameter></term>
+    <listitem>
+     <simpara>
+      ホワイトスペースを取り除く<type>string</type>
+     </simpara>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>characters</parameter></term>
+    <listitem>
+     &strings.parameter.unicode.optional;
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>encoding</parameter></term>
+    <listitem>
+     <simpara>
+      文字エンコーディングを指定します。省略した場合、もしくは<type>null</type>の場合は、内部文字エンコーディングを使用します。
+     </simpara>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <simpara>
+   トリム処理を行った文字列を返します。
+  </simpara>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <simplelist>
+   <member><function>mb_trim</function></member>
+   <member><function>mb_rtrim</function></member>
+   <member><function>ltrim</function></member>
+  </simplelist>
+ </refsect1>
+
+</refentry>
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->

reference/mbstring/functions/mb-rtrim.xml

@@ -0,0 +1,92 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry xml:id="function.mb-rtrim" xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+  <refname>mb_rtrim</refname>
+  <refpurpose>文字列の末尾にあるホワイトスペースを取り除く</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>string</type><methodname>mb_rtrim</methodname>
+   <methodparam><type>string</type><parameter>string</parameter></methodparam>
+   <methodparam choice="opt"><type>string</type><parameter>characters</parameter><initializer>&null;</initializer></methodparam>
+   <methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
+  </methodsynopsis>
+  <simpara>
+   マルチバイト対応の <function>rtrim</function> 処理を行い,
+   <parameter>string</parameter>の最後から空白文字を取り除き、
+   取り除かれた文字列を返します。
+  </simpara>
+  <simpara>
+   2番目のパラメータを指定しない場合、
+   <function>mb_rtrim</function> は以下の文字を削除します。
+  </simpara>
+  &strings.stripped.unicode;
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>string</parameter></term>
+    <listitem>
+     <simpara>
+      ホワイトスペースを取り除く<type>string></type>
+     </simpara>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>characters</parameter></term>
+    <listitem>
+     &strings.parameter.unicode.optional;
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>encoding</parameter></term>
+    <listitem>
+     <simpara>
+      文字エンコーディングを指定します。省略した場合、もしくは<type>null</type>の場合は、内部文字エンコーディングを使用します。
+     </simpara>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <simpara>
+   トリム処理を行った文字列を返します。
+  </simpara>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <simplelist>
+   <member><function>mb_trim</function></member>
+   <member><function>mb_ltrim</function></member>
+   <member><function>rtrim</function></member>
+  </simplelist>
+ </refsect1>
+
+</refentry>
+ <!-- Keep this comment at the end of the file
+ Local variables:
+ mode: sgml
+ sgml-omittag:t
+ sgml-shorttag:t
+ sgml-minimize-attributes:nil
+ sgml-always-quote-attributes:t
+ sgml-indent-step:1
+ sgml-indent-data:t
+ indent-tabs-mode:nil
+ sgml-parent-document:nil
+ sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+ sgml-exposed-tags:nil
+ sgml-local-catalogs:nil
+ sgml-local-ecat-files:nil
+ End:
+ vim600: syn=xml fen fdm=syntax fdl=2 si
+ vim: et tw=78 syn=sgml
+ vi: ts=1 sw=1
+ -->

reference/mbstring/functions/mb-trim.xml

@@ -0,0 +1,89 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry xml:id="function.mb-trim" xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+  <refname>mb_trim</refname>
+  <refpurpose>文字列の先頭および末尾にあるホワイトスペースを取り除く</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>string</type><methodname>mb_trim</methodname>
+   <methodparam><type>string</type><parameter>string</parameter></methodparam>
+   <methodparam choice="opt"><type>string</type><parameter>characters</parameter><initializer>&null;</initializer></methodparam>
+   <methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
+  </methodsynopsis>
+  <simpara>
+   マルチバイト対応の <function>trim</function> 処理を行い、
+   <parameter>string</parameter>の最初および最後から空白文字を取り除き、
+   取り除かれた文字列を返します。
+   2番目のパラメータを指定しない場合、
+   <function>mb_trim</function> は以下の文字を削除します。
+  </simpara>
+  &strings.stripped.unicode;
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>string</parameter></term>
+    <listitem>
+     <simpara>
+      ホワイトスペースを取り除く<type>string</type>。
+     </simpara>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>characters</parameter></term>
+    <listitem>
+     &strings.parameter.unicode.optional;
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>encoding</parameter></term>
+    <listitem>
+     <simpara>
+      文字エンコーディングを指定します。省略した場合、もしくは<type>null</type>の場合は、内部文字エンコーディングを使用します。
+     </simpara>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <simpara>
+   トリム処理を行った文字列を返します。
+  </simpara>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <simplelist>
+   <member><function>mb_ltrim</function></member>
+   <member><function>mb_rtrim</function></member>
+   <member><function>trim</function></member>
+  </simplelist>
+ </refsect1>
+</refentry>
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->