str-increment.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 57c83578be2f0ebf3528f1296040fe738dac37de Maintainer: mumumu Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.str-increment">
 <refnamediv>
  <refname>str_increment</refname>
  <refpurpose>英数字からなる文字列をインクリメントする</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>str_increment</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
  </methodsynopsis>
  <para>
   英数字からなる <acronym>ASCII</acronym> 文字列 <parameter>string</parameter> をインクリメントし、結果の文字列を返します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       入力文字列。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   インクリメント済みの、英数字からなる <acronym>ASCII</acronym> 文字列を返します。
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   <parameter>string</parameter> が空の場合、
   <classname>ValueError</classname> がスローされます。
  </para>
  <para>
   <parameter>string</parameter> が、英数字からなる <acronym>ASCII</acronym> 文字列でない場合、<classname>ValueError</classname> がスローされます。
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>str_increment</function> の基本的な使い方</title>
    <programlisting role="php">
<![CDATA[
<?php
$str = 'ABC';
var_dump(str_increment($str));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
string(3) "ABD"
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title>繰り上げがある、<function>str_increment</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$str = 'DZ';
var_dump(str_increment($str));

$str = 'ZZ';
var_dump(str_increment($str));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
string(2) "EA"
string(3) "AAA"
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>str_decrement</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->