PHP ビット和を使ったイディオムなのか知りたい

Question

概要

下記コードが秘伝のタレになっており、周りになぜこうなっているのかを知っている人間が誰もいないので質問させていただきます。

DateTimeを継承したクラスのメソッド中にformatをした結果と0のビット和を取っているところが複数見られるのですが、なんらかのイディオムであったりするのでしょうか。

コード

class MyDateTime extends \DateTime
{
~~中略~~
    public function get_year()
    {
        return $this->format('Y') | 0;
    }

    public function get_month()
    {
        return $this->format('m') | 0;
    }
~~中略~~
}

Answer 1

既に解決済みではありますが、、

おそらく、
「DateTime::format の結果を int型にキャストする目的がある」
と推測します。

class MyDateTime extends \DateTime
{
    public function get_year()
    {
        return $this->format('Y') | 0;
    }

    public function get_month()
    {
        return $this->format('m') | 0;
    }
}

$datetime = new MyDatetime();

var_dump($datetime->format('Y'));
var_dump($datetime->get_year());

echo PHP_EOL;

var_dump($datetime->format('m'));
var_dump($datetime->get_month());

実行結果

string(4) "2017"
int(2017)

string(2) "02"
int(2)

要するに、

return (int) $this->format('Y');

と同じことです。

おそらく、
「キャストよりビット演算の方が速い」
という都市伝説(笑)にもとづいた実装なのではないでしょうか？

---

もちろん、Y.H.様の回答の通り

format()に失敗したときに Integerの0を返

す、という効果もあります。

Comments

[Y.H.]

あ、そうですね。format()で失敗しなくてもIntegerになりますね。

[HRS_O]

なるほどー、型までは（自分が）評価してなかったです！
参考になりましたm(_ _)m

Answer 2

format()に失敗したときに Integerの0を返したいのでしょう。
※追記：失敗したときだけではなく正常時もIntegerになります。

http://php.net/manual/ja/language.operators.bitwise.php

&、| そして ^ 演算子の左右のオペランドが文字列の場合、その演算は、 文字列を構成する文字の ASCII 値を使って行います。その結果は文字列になります。
それ以外の場合は、左右のオペランドを integer に変換 し、結果も integer になります。

http://php.net/manual/ja/datetime.format.php

成功した場合にフォーマット済みの日付文字列、失敗した場合に FALSE を返します。

Comments

[HRS_O]

回答ありがとうございます。
なるほど、確かにそんな感じはしますね。
ただDateTIme::formatって失敗することがあるのかよくわからなかったです……

dateの第二引数に文字列を入れた場合にはfalseが返るようですが、リファクタされてかつ遺産が残った感じですかねぇ
謎です／(^o^)＼

>> フォーマット文字列中の認識されない文字は、そのまま表示されます。
http://php.net/manual/ja/function.date.php

[Y.H.]

>失敗することがあるのかよくわからなかったです
多分失敗することはないでしょうね。
おまじない的に付けてるだけのような気がします

[HRS_O]

なるほど、追加でありがとうございますm(_ _)m