この記事は pepabo Advent Calendar 2016 17日目の記事です。
昨日は genkiroid さんの PHPのrequire系ステートメントと断捨離について でした。コードを断捨離していきましょう!!!
ご存知でしょうか？
珍しい組み込み関数があることで有名な PHP[要出典] ですが、 date_sunrise という関数をご存知でしょうか。
date_sunrise — 指定した日付と場所についての日の出時刻を返す
試しに、ペパボ本社がある東京都渋谷区セルリアンタワーの元旦の 日の出時刻 を出力してみます。
$ php -d date.timezone='Asia/Tokyo' -r 'echo date_sunrise(mktime(0, 0, 0, 1, 1, 2017), SUNFUNCS_RET_STRING, 35.39, 139.41);'
06:51
素晴らしい…。
これを使ってアレをソレすれば 2017 年の初日の出を寝過ごすことなくしっかり拝み、充実した1年をスタートさせることができます。必要なのは PHP とその他の (恐らくごくわずかな) 手間だけです。
ただ、 この時間が本当にあってるのかちょっと不安 です。
ソースコード探索
ということで date_sunrise の実装を覗いてみましょう。 (PHP7.1.0)
php/php-src: The PHP Interpreter
関数は PHP_FUNCTION マクロを使って定義されているので PHP_FUNCTION(date_sunrise) で検索すればすぐに目的のコードにたどり着けます。
https://github.com/php/php-src/blob/PHP-7.1.0/ext/date/php_date.c#L4834
内部的には日の入り時間を返す date_sunset とかなり共通していて、php_do_date_sunrise_sunset の第2引数に渡すフラグで処理を分けているようです。
INTERNAL_FUNCTION_PARAM_PASSTHRU マクロは、その名の通り引数を利用しない場合のアテの役割で、 execute_data, return_value に展開されます。
なぜアテが必要かというと、 PHP_FUNCTION(date_sunrise) はコンパイラによって最終的に zif_date_sunrise(zend_execute_data *execute_data, zval *return_value) に展開されるので、この第1, 2引数を埋めるために INTERNAL_FUNCTION_PARAM_PASSTHRU マクロを使っています。
つづいて php_do_date_sunrise_sunset の中を順番に見ていきます。
変数の初期化と引数を解析しています。
zend_parse_parameters は第1引数で実行時に渡された引数の数、第2引数で引数の情報を受取り、解析した結果を第3引数以降に代入します。
また、第2引数 "l|ldddd" は、各引数の型と必須・オプションを表していて、パイプ | で区切られた後ろの2つめ以降がオプショナルであることがわかります。
つづいて、実行時に渡された引数の数によって、デフォルト値を設定しています。switch 文のフォールスルーがうまく使われていて勉強になります。
INI_FLT は php.ini の設定値を取得するための double 型用のマクロです。マニュアルを見ると、たしかに ini_get("date.default_latitude") 等がデフォルトで使われると書かれています。
第2引数で渡す format が、予め定義されているどれにも該当しない場合に警告を出力しています。PHP で開発しているとよく見るあの警告は php_error_docref で出力されているようです。
ようやく時間を計算してそうなコードまでたどり着きました !!
肝心の計算をしているであろう timelib_astro_rise_set_altitude の中を見てみます。
フムフム…
…
…
ちゃんと計算されていることがわかりました… !
充実した1年のスタートを ― PHPで
緻密に計算された日の出時刻を返してくれる date_sunrise 関数。
一字一句違わず正確に繰り返しますが、
これを使ってアレをソレすれば 2017 年の初日の出を寝過ごすことなくしっかり拝み、充実した1年をスタートさせることができます。必要なのは PHP とその他の (恐らくごくわずかな) 手間だけです。
新年の目標や計画を立て始めている方も多いのではないでしょうか。
何事も出だしが肝心といわれています。ぜひみなさんの 2017年 スタートダッシュのお供に PHP を。
( いまいちネタ記事なのかはっきりしない感じですが、以上です。)
明日は、我らがEC事業部プロダクトチームの女神 ayami さんです !