[PHP-doc 1078] mb_convert_variables の引数リスト

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

[PHP-doc 1078] mb_convert_variables の引数リスト

大西愼一-2
大西@元木型屋です。
久しぶりですがよろしくお願い致します。

さて、
http://php.net/manual/ja/function.mb-convert-variables.php
の説明の項には
string mb_convert_variables ( string $to_encoding , mixed $from_encoding  
, mixed &$vars [, mixed &$... ] )
のように書かれていて、第3引数まで省略できないような書き方ですが
パラメータの説明では
「from_encoding が省略された場合、detect_order を使用します。」
のように from_encoding は省略できるような説明です。

この場合、第2引数 from_encoding を省略するにはどうするのでしょう?
null でも与えるのでしょうか?

もしそうなら、マニュアルとしては明記が必要だと思います。
それとも省略できるような記述が間違いでしょうか?

_______________________________________________
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 1079] Re: mb_convert_variables の引数リスト

TAKAGI Masahiro-4
高木です。

2016-11-07 1:28 GMT+09:00 大西愼一 <[hidden email]>:
> 大西@元木型屋です。
> 久しぶりですがよろしくお願い致します。
>
> さて、
> http://php.net/manual/ja/function.mb-convert-variables.php
> の説明の項には
> string mb_convert_variables ( string $to_encoding , mixed $from_encoding ,
> mixed &$vars [, mixed &$... ] )
> のように書かれていて、第3引数まで省略できないような書き方ですが

挙動としてはこちらのほうが正解(なので、引数をふたつだけしか指定せずに呼び出すと
Warningが発生する)です。

> パラメータの説明では
> 「from_encoding が省略された場合、detect_order を使用します。」
> のように from_encoding は省略できるような説明です。

なので、こちらの説明のほうがちょっと紛らわしいということになりますね。
# そもそも、直前の文に唐突に登場する「from-coding」とは何者……
# というところからして怪しいですけど。

> この場合、第2引数 from_encoding を省略するにはどうするのでしょう?
> null でも与えるのでしょうか?

mbstringのソースをざっと眺めた限りでは、
 第二引数をparseしてエンコーディングを取得してみる
 …が、できなかった場合はデフォルトを使う
ように見えますが、ちょっと不安なので、改めて時間を取って
読み直してみます。

>
> もしそうなら、マニュアルとしては明記が必要だと思います。
> それとも省略できるような記述が間違いでしょうか?

というわけで、パラメータの説明のほうを手直しするという方向で
考えてみます。ご指摘いただきありがとうございました。

--
TAKAGI Masahiro mailto:[hidden email]
_______________________________________________
PHP-doc mailing list
[hidden email]
http://ml.php.gr.jp/mailman/listinfo/php-doc
Loading...