PHPファイルを保存する時の改行コードの違いによる問題を教えてください。

Question

こんにちは。お世話になっております。
今回は、PHPファイルの改行コードの違いについてお聞きしたくて投稿させて頂きました。

まず前提として、
私はMacを使っており、vimをエディタとして使っております。
そして現在他のwindows系マシンで編集されたPHPファイルをいじっているところです。
では以下のことをご質問させて頂きます。

上で話させて頂きました今扱っているPHPファイルの改行コードが、「 CR+LF」のwindows系のものなので、私がMacで編集しそのまま保存すると「LF」のUNIX系の改行コードに変更されてしまいます。
これはOSが違う環境では普通のことなのでしょうか？
それともこれは元の「CR+LF」のwindows系の改行コードに合わせて保存しないと、PHPの動作自体に影響を与えるものなのでしょうか？

実際の動作環境で改行コードの違いで問題を起こしうるものなのかどうかをお聞きしたいと思います。
できれば具体的な対策も教えて頂けますと幸いです。
初歩的な質問ではありますが、どうぞよろしくお願い致します。

Answer 1

これはOSが違う環境では普通のことなのでしょうか？
チーム内で取り決めがなければそうなりますね。

ただし、ソース管理やフォーマッターを使っていたりすると最終更新者が書き換わってしまったりする問題が起きるので、以下のようにコーディング規約に基づいて開発するのが基本です。

PHPコーディング規約まとめ

IDEなどでは、どちらの改行コードを使用するか設定できるので、チーム内で統一しておきましょう。

Comments

[退会済みユーザー]

ご回答ありがとうございます！
なるほど、今回はチームではなく個人でこのプロジェクトのファイルの編集を行っているので、元ファイル主との取り決めが共有できていませんでした。
PHPコーディング規約まとめ、読ませて頂きます。
貴重なアドバイスありがとうございました！

Answer 2

例えば次のように文字列中に改行が含まれている場合、その値に \r を含むかどうかという違いがあります。

<?php
$str = "
";
var_dump(bin2hex($str));

このようなものが実行時に実際に問題になることはほとんどないと思いますが。。。

---

これはOSが違う環境では普通のことなのでしょうか？

OS が、というよりエディタが、だと思います。それは vim の機能だと思います。

例えば、Windows でもエディタの設定によっては改行コードを LF にすることはできます。
（というか、大抵の Web 系の開発の人はそうしています）

PHPの動作自体に影響を与えるものなのでしょうか？

前述の通り、ほとんど影響はないと思いますが、絶対にないとは言い切れません。

できれば具体的な対策も教えて頂けますと幸いです。

あらかじめコーディングルールなどで改行を LF にするように規定しておくのが理想です。
PSR-2 でもそのように規定されています。

既存のコードの改修であれば、わたしは次のようにしています。

改行コードを変更しても問題がないことに確信が持てない場合

1. 改行コードが CR+LF になるようにエディタの設定を変更する

改行コードを変更しても問題がないことに確信が持てる場合

1. メンバーに改行コードを LF にするように周知する
2. 改行コードを変更するためだけの修正を行なう
3. git などで「Fix line break code」のようなメッセージでコミットする
4. 本来修正したかった箇所を修正してコミットする

ポイントは 2 と 3 でコミットを分けることです。これは、後述のようにバージョン管理ツールを使っている場合に、本来変更したかった場所がどこだったのかを少しでもわかりやすくするためです。

---

また、動作以前の問題として、git などのバージョン管理ツールを使っていると、

私がMacで編集しそのまま保存すると「LF」のUNIX系の改行コードに変更されてしまいます。

によって、すべての行が変更されているかのような差分になってしまい、ほんとうに変更した箇所がわからなくなってしまう、という問題があります（差分ツールの方で改行コードの違いを吸収できることもありますが）。

世間一般で「改行コードは揃えるべき」と強く言われているのは、これが理由だと思います。

Comments

[退会済みユーザー]

ご回答ありがとうございます！
それぞれの質問にご丁寧に回答頂きまして、ありがとうございます。
対策につきましても、私が今まで試していなかったものばかりだったので参考にさせて頂きたいと思います。
もう１つご質問をさせて頂きたいので、もし宜しければご回答頂けますと有り難いです。
１　今あるサイトの改修作業を、直接サーバー上ではなくてファイルのみダウンロードしてローカルで改修を行っているのですが、そのサイトはおそらくwindows環境で開発されたもののようで、私がMacのvimでそれらのphpファイルを開くと、「^M」という制御文字が行末に表示されることがあります。
これは改行コードがCR+LF(windows)のファイルをLF(unix)で開こうとしているときに起きる、ということは調べてわかったのですが、一方で、あるphpファイルは開いたときにCR+LF(windows)の改行コードのまま開けているものがあります（^Mは表示されず、vimの改行コードを確認するコマンド:set ffを打つとdos(windows)と出ます）。
この２つのケースの違いはなんなのでしょうか？
そしてあるファイルは開いた時からLFのものもあるので、windows系とunix系の改行コードが元から混在しているのではないかとも思っています。
今までphpファイルを編集するときに改行コードを意識したことがなかったので、どのように対処すればよいか分かりかねています。
最初の質問とかぶる部分があるかもしれませんが、お答えできる範囲で結構ですので、ご教授頂けますと幸いです。
お手数ですが、どうぞよろしくお願い致します。

[ngyuki]

わたしは vimmer ではないので vim のことはわかりかねますが・・
おそらく vim にも改行コードを自動認識する機能があり、どちらの改行コードもサポートしているのだと思います。
「^M」と表示されるファイルは、一つのファイルのなかで CRLF と LF が混在しているのではないでしょうか？

[退会済みユーザー]

なるほど。自動認識で判別しているためファイルによって違いがでてくるのですね。
確認もせずvimのことばかり聞いてすみません。。
ありがとうございました！
最初のご回答でも、改行コードの違いに関しては問題が起こることはほとんどないとのことですので、今回はそれほど心配しないでも大丈夫なのかもしれませんね。
最終は実際の環境に合うように改行コードも決めて行きたいと思います。
長々となりましたが、おつきあい頂きありがとうございました。
またご質問させて頂くかもしれませんが、その時はよろしくお願い致します。

Answer 3

私はMacを使っており、vimをエディタとして使っております。
すばらしいです。Vim最高です。

そして現在他のwindows系マシンで編集されたPHPファイルをいじっているところです。
そのアプリケーションが「CR+LF」でそろえた物なら「CR+LF」で開発される事をお勧めします。

それともこれは元の「CR+LF」のwindows系の改行コードに合わせて保存しないと、PHPの動作自体に影響を与えるものなのでしょうか？
実際の動作環境で改行コードの違いで問題を起こしうるものなのかどうかをお聞きしたいと思います。
かなりの確率で問題が発生します。
また、文字コードもUTF-8のBOM付きやShift-JISで保存されている可能性があります。
こちらも確認を行い開発される事をオススメ致します。

できれば具体的な対策も教えて頂けますと幸いです。
実働環境に合わせた改行コードや文字コードにしましょう。
vimの設定については下記のサイト等が参考になるのではないでしょうか？
http://advweb.seesaa.net/article/3074705.html

Comments

[退会済みユーザー]

ご回答ありがとうございます。
なるほど、やはり改行コードは合わせて開発するのが普通なのですね。
URLを教えて頂きありがとうございます。実際に見て勉強してみたいと思います！