[PHP-doc 946] マルチバイト文字列の一部で説明部分が実際と合わない

classic Classic list List threaded Threaded
4 messages Options
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

[PHP-doc 946] マルチバイト文字列の一部で説明部分が実際と合わない

komura-2
komura です。

マルチバイト文字列のマニュアルを見ていていくつか気になる点がありました。
英語のマニュアルも同様です。

時間がありましたら、修正を検討していただければ幸いです。


1. mb_convert_case(): http://php.net/mb_convert_case

 mb_convert_case()の第2引数にデフォルト値が設定されていますが、第2引数は
 省略不可なので、デフォルト値は意味がありません。
 以下のように修正した方が良いのではないでしょうか。

    string mb_convert_case ( string $str , int $mode = MB_CASE_UPPER [, string $encoding = mb_internal_encoding() ] )
 ⇒ string mb_convert_case ( string $str , int $mode [, string $encoding = mb_internal_encoding() ] )

2. mb_decode_numericentity(): http://php.net/mb_decode_numericentity

 mb_decode_numericentity()の第3引数はオプションです。また、PHP 5.4.0 からは、
 第4引数が指定可能になりました。

    string mb_decode_numericentity ( string $str , array $convmap , string $encoding )
 ⇒ string mb_decode_numericentity ( string $str , array $convmap [, string $encoding [, bool $is_hex ]] )

3. mb_encode_numericentity(): http://php.net/mb_encode_numericentity

 2と同様に、mb_encode_numericentity()の第3引数はオプションです。
 また、PHP 5.4.0 からは、第4引数が指定可能になりました。

    string mb_encode_numericentity ( string $str , array $convmap , string $encoding )
 ⇒ string mb_encode_numericentity ( string $str , array $convmap [, string $encoding [, bool $is_hex ]] )

4. mb_regex_set_options(): http://php.net/mb_regex_set_options

 マニュアルの返り値の説明に、引数が省略された場合、「現在のデフォルトの
 オプションを返します」とあります。引数のデフォルト値はない方が良いので
 はないでしょうか。

    string mb_regex_set_options ([ string $options = "msr" ] )
 ⇒ string mb_regex_set_options ([ string $options ] )

--
komura <[hidden email]>
_______________________________________________
PHP-doc mailing list
[hidden email]
http://ml.php.gr.jp/mailman/listinfo/php-doc
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

[PHP-doc 948] Re: マルチバイト文字列の一部で説明部分が実際と合わない

TAKAGI Masahiro-4
高木です。

2013/1/12 KOMURA Takaaki <[hidden email]>:
> komura です。
>
> マルチバイト文字列のマニュアルを見ていていくつか気になる点がありました。
> 英語のマニュアルも同様です。
>
> 時間がありましたら、修正を検討していただければ幸いです。
ご丁寧な指摘をいただきながら放置してしまっていて申し訳ありませんでした。
今晩か明朝に改めて読ませていただきます。

--
TAKAGI Masahiro mailto:[hidden email]
_______________________________________________
PHP-doc mailing list
[hidden email]
http://ml.php.gr.jp/mailman/listinfo/php-doc
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

[PHP-doc 958] Re: マルチバイト文字列の一部で説明部分が実際と合わない

TAKAGI Masahiro-3
In reply to this post by komura-2
高木です。

先ほど対応を済ませました。

http://news.php.net/php.doc.cvs/10987
http://news.php.net/php.doc.ja/3689

2013/1/12 KOMURA Takaaki <[hidden email]>:
> 1. mb_convert_case(): http://php.net/mb_convert_case
>
>  mb_convert_case()の第2引数にデフォルト値が設定されていますが、第2引数は
>  省略不可なので、デフォルト値は意味がありません。
>  以下のように修正した方が良いのではないでしょうか。
>
>     string mb_convert_case ( string $str , int $mode = MB_CASE_UPPER [, string $encoding = mb_internal_encoding() ] )
>  ⇒ string mb_convert_case ( string $str , int $mode [, string $encoding = mb_internal_encoding() ] )

そのままいただきました。

>
> 2. mb_decode_numericentity(): http://php.net/mb_decode_numericentity
>
>  mb_decode_numericentity()の第3引数はオプションです。また、PHP 5.4.0 からは、
>  第4引数が指定可能になりました。
>
>     string mb_decode_numericentity ( string $str , array $convmap , string $encoding )
>  ⇒ string mb_decode_numericentity ( string $str , array $convmap [, string $encoding [, bool $is_hex ]] )

手元で5.4と5.5のソースを見た限りでは、第4引数が追加されているのはmb_encode_numericentity()のほうだけに見えます。
なので、今回は第3引数の変更だけにとどめました。もし私が何か見落としているようでしたら、お手数ですがあらためてご指摘ください。

>
> 3. mb_encode_numericentity(): http://php.net/mb_encode_numericentity
>
>  2と同様に、mb_encode_numericentity()の第3引数はオプションです。
>  また、PHP 5.4.0 からは、第4引数が指定可能になりました。
>
>     string mb_encode_numericentity ( string $str , array $convmap , string $encoding )
>  ⇒ string mb_encode_numericentity ( string $str , array $convmap [, string $encoding [, bool $is_hex ]] )

そのままいただきました。

> 4. mb_regex_set_options(): http://php.net/mb_regex_set_options
>
>  マニュアルの返り値の説明に、引数が省略された場合、「現在のデフォルトの
>  オプションを返します」とあります。引数のデフォルト値はない方が良いので
>  はないでしょうか。
>
>     string mb_regex_set_options ([ string $options = "msr" ] )
>  ⇒ string mb_regex_set_options ([ string $options ] )

そのままいただきました。
あと、日本語訳の「現在の*デフォルトの*オプション…」は、誤訳ですね。

   options を省略した場合は、
   現在設定されているオプションを返します。

としておきました。

--
TAKAGI Masahiro mailto:[hidden email]
_______________________________________________
PHP-doc mailing list
[hidden email]
http://ml.php.gr.jp/mailman/listinfo/php-doc
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

[PHP-doc 959] Re: マルチバイト文字列の一部で説明部分が実際と合わない

komura-2
komura です。
修正を確認しました。ご対応、どうもありがとうございました。


On Thu, 31 Jan 2013 06:17:39 +0900
TAKAGI Masahiro <[hidden email]> wrote:

> > 2. mb_decode_numericentity(): http://php.net/mb_decode_numericentity
> >
> >  mb_decode_numericentity()の第3引数はオプションです。また、PHP 5.4.0 からは、
> >  第4引数が指定可能になりました。
> >
> >     string mb_decode_numericentity ( string $str , array $convmap , string $encoding )
> >  ⇒ string mb_decode_numericentity ( string $str , array $convmap [, string $encoding [, bool $is_hex ]] )
>
> 手元で5.4と5.5のソースを見た限りでは、第4引数が追加されているのはmb_encode_numericentity()のほうだけに見えます。
> なので、今回は第3引数の変更だけにとどめました。もし私が何か見落としているようでしたら、お手数ですがあらためてご指摘ください。

この件は私の勘違いです。
mb_decode_numericentity() は第4引数を設定しても引数間違いの警告は
発生しないため、ソースコードのコメント修正ミスだと考えていました。
確認したところ、機能的には何も意味はありませんね。

この第4引数はマニュアルに追加する必要はないと思います。今回の修正で
十分です。

お忙しい中、どうもありがとうございました。

--
komura <[hidden email]>
_______________________________________________
PHP-doc mailing list
[hidden email]
http://ml.php.gr.jp/mailman/listinfo/php-doc
Loading...