PHPのお勉強！ – ”Atelier 慶”

PHP TOP

文字列

string は、文字が連結されたものです。PHP では、文字は 1 バイトと同じです。つまり、256 個の異なる文字を使用可能です。これは、PHP が Unicode をネイティブにサポートしていないことも意味します。文字列型の詳細を参照ください。

注意: 32bit ビルドでは、文字列の最大長は 2GB (2147483647 バイト) です。

構文

文字列リテラルは、4 つの異なる方法で指定することが可能です。

引用符

文字列を指定する最も簡単な方法は、引用符 (文字 ') で括ることです。

引用符をリテラルとして指定するには、バックスラッシュ (\) でエスケープする必要があります。バックスラッシュをリテラルとして指定するには、二重 (\\) にします。それ以外の場面で登場するバックスラッシュは、すべてバックスラッシュそのものとして扱われます。つまり、\r や \n といったおなじみのエスケープシーケンスを書いても特別な効果は得られず、書いたままの形式で出力されます。

注意: ダブルクォート構文やヒアドキュメント構文とは異なり、変数と特殊文字のエスケープシーケンスは、引用符 (シングルクオート) で括られた文字列にある場合には展開されません。

<?php
echo 'this is a simple string';

echo 'You can also have embedded newlines in 
strings this way as it is
okay to do';

// 出力: Arnold once said: "I'll be back"
echo 'Arnold once said: "I\'ll be back"';

// 出力: You deleted C:\*.*?
echo 'You deleted C:\\*.*?';

// 出力: You deleted C:\*.*?
echo 'You deleted C:\*.*?';

// 出力: This will not expand: \n a newline
echo 'This will not expand: \n a newline';

// 出力: Variables do not $expand $either
echo 'Variables do not $expand $either';
?>

二重引用符

文字列が二重引用符 (") で括られた場合、 PHP は、以下のエスケープシーケンスを特殊な文字として解釈します。

**エスケープされた文字**
記述	意味
`\n`	ラインフィード (LF またはアスキーの 0x0A (10))
`\r`	キャリッジリターン (CR またはアスキーの 0x0D (13))
`\t`	水平タブ (HT またはアスキーの 0x09 (9))
`\v`	垂直タブ (VT またはアスキーの 0x0B (11))
`\e`	エスケープ (ESC あるいはアスキーの 0x1B (27))
`\f`	フォームフィード (FF またはアスキーの 0x0C (12))
`\\`	バックスラッシュ
`\$`	ドル記号
`\"`	二重引用符
`\[0-7]{1,3}`	8進数: 正規表現 `[0-7]{1,3}` にマッチする文字シーケンスは、8 進数表記の 1 文字 (例:. `"\101" === "A"`) です。正規表現にマッチする文字シーケンスは、8 進数表記の 1 文字です。 1 バイトに収まらない部分は、何もメッセージを出さずにオーバーフローします (例: `"\400" === "\000"`) 。
`\x[0-9A-Fa-f]{1,2}`	16進数: 正規表現 `[0-9A-Fa-f]{1,2}` にマッチする文字シーケンスは、16 進数表記の 1 文字(例: `"\x41" === "A"`)です。
`\u{[0-9A-Fa-f]+}`	Unicode: 正規表現 `[0-9A-Fa-f]+` にマッチする文字シーケンスは、Unicode のコードポイントです。そのコードポイントの UTF-8 表現を文字列として出力します。シーケンスを波括弧で囲む必要があります。例 `"\u{41}" === "A"`

繰り返しますが、この他の文字をエスケープしようとした場合には、バックスラッシュも出力されます!

しかし、二重引用符で括られた文字列で最も重要なのは、変数名が展開されるところです。詳細は、文字列のパースを参照ください。

ヒアドキュメント

文字列を区切る別の方法としてヒアドキュメント構文 ("<<<") があります。この場合、ある ID (と、それに続けて改行文字) を <<< の後に指定し、文字列を置いた後で、同じ ID (終端ID) を括りを閉じるために置きます。

終端ID は、スペースまたはタブでインデントできます。その場合、インデントされた部分は文字列の全ての行から取り除かれます。 PHP 7.3.0 より前のバージョンでは、終端ID はその行の最初のカラムから始めなければ いけませんでした。

また、終端ID は、PHP の他のラベルと同様の命名規則に従う必要があります。つまり、英数字およびアンダースコアのみを含み、数字でない文字またはアンダースコアで始まる必要があります。

例1 PHP 7.3.0 以降での、基本的なヒアドキュメントの使い方

<?php
// 終端IDをインデントしない場合
echo <<<END
      a
     b
    c
\n
END;
// 終端IDを4つのスペースでインデントする場合
echo <<<END
      a
     b
    c
    END;

上の例の PHP 7.3 での出力は、このようになります。

      a
     b
    c
  a
 b
c

終端ID が、文字列のいずれかの行より奥にインデントされている場合、 ParseError がスローされます。

例2 終端ID は文字列本体よりも奥にインデントしてはいけない

<?php
echo <<<END
  a
 b
c
   END;

上の例の PHP 7.3 での出力は、このようになります。

PHP Parse error:  Invalid body indentation level (expecting an indentation level of at least 3) in example.php on line 4

終端ID をインデントする場合、インデントに使う文字として、タブまたはスペースが使えます。しかし、終端ID、および (終端ID までの)文字列の本体どちらであっても、インデントする際にタブとスペースを混ぜては いけません。混ぜた場合、 ParseError がスローされます。インデントに使う文字に制限があるのは、タブとスペースを混ぜてしまうと可読性が損なわれるためです。

例3 文字列本体や終端ID のインデントに違う文字を使う

<?php
// 以下のコードはいずれも動作しません。
// 文字列本体(スペース) と 終端ID(タブ) とで、異なる文字でインデントする
{
    echo <<<END
     a
        END;
}
// 文字列本体に、タブとスペースを混ぜてインデントする
{
    echo <<<END
        a
     END;
}
// 終端IDのインデントに、スペースとタブを混ぜる
{
    echo <<<END
          a
         END;
}

上の例の PHP 7.3 での出力は、このようになります。

PHP Parse error:  Invalid indentation - tabs and spaces cannot be mixed in example.php line 8

文字列本体の後に置かれる終端ID の後に、セミコロンや改行を続ける必要はありません。たとえば、次のようなコードが PHP 7.3.0 以降で動作します:

例4 終端ID の後に式を継続する

<?php
$values = [<<<END
a
  b
    c
END, 'd e f'];
var_dump($values);

上の例の PHP 7.3 での出力は、このようになります。

array(2) {
  [0] =>
  string(11) "a
  b
    c"
  [1] =>
  string(5) "d e f"
}

警告

終端ID が行のはじめに見つかった場合、それが別の単語の一部かどうかにかかわらず、それが終端IDと見なされ、 ParseError が起きる可能性があります。

例5 文字列本体に終端ID が含まれると、ParseError が起きがち

<?php
$values = [<<<END
a
b
END ING
END, 'd e f'];

上の例の PHP 7.3 での出力は、このようになります。

PHP Parse error:  syntax error, unexpected identifier "ING", expecting "]" in example.php on line 6

この問題を避けるために、次のようなシンプルなルールに従っておくと安全です: 文字列本体に出現するテキストを、終端ID として採用しない

警告

PHP 7.3.0 より前のバージョンで注意すべき非常に重要な点は、終端ID がある行には、セミコロン (;) 以外の他の文字が含まれていてはいけなかったことです。これは、特に ID はインデントしてはならないということ、セミコロンの前に空白やタブを付けてはいけないことを意味していました。終端ID の前の最初の文字は、使用するオペレーティングシステムで定義された改行である必要があることにも注意を要します。これは、UNIX システムでは macOS を含め \n となります。最後の区切り文字の後にもまた、改行を入れる必要があります。

この規則が破られて終端ID が "clean" でない場合、終端ID と認識されず、PHP はさらに終端 ID を探し続けます。適当な終端ID がみつからない場合、スクリプトの最終行でパースエラーが発生します。

例6 PHP 7.3.0 より前のバージョンでの間違った例

<?php
class foo {
    public $bar = <<<EOT
bar
    EOT;
}
// 識別子はインデントしてはいけません
?>

例7 PHP 7.3.0 より前のバージョンでも有効な例

<?php
class foo {
    public $bar = <<<EOT
bar
EOT;
}
?>

変数を含んでいるヒアドキュメントは、クラスのプロパティの初期化に用いることはできません。

ヒアドキュメントは二重引用符を使用しませんが、二重引用符で括られた文字列と全く同様に動作します。しかし、この場合でも上記のリストでエスケープされたコードを使用することも可能です。変数は展開されますが、文字列の場合と同様にヒアドキュメントの内部で複雑な変数を表わす場合には注意が必要です。

例8 ヒアドキュメントで文字列を括る例

<?php
$str = <<<EOD
Example of string
spanning multiple lines
using heredoc syntax.
EOD;

/* 変数を使用するより複雑な例 */
class foo
{
    var $foo;
    var $bar;

    function __construct()
    {
        $this->foo = 'Foo';
        $this->bar = array('Bar1', 'Bar2', 'Bar3');
    }
}

$foo = new foo();
$name = 'MyName';

echo <<<EOT
My name is "$name". I am printing some $foo->foo.
Now, I am printing some {$foo->bar[1]}.
This should print a capital 'A': \x41
EOT;
?>

上の例の出力は以下となります。

My name is "MyName". I am printing some Foo.
Now, I am printing some Bar2.
This should print a capital 'A': A

ヒアドキュメント構文を用いて、関数の引数にデータを渡すこともできます。

例9 ヒアドキュメントを引数に使用する例

<?php
var_dump(array(<<<EOD
foobar!
EOD
));
?>

static変数やクラスのプロパティ/定数は、ヒアドキュメント構文で初期化することができます。

例10 ヒアドキュメントを用いた静的な値の初期化

<?php
// static 変数
function foo()
{
    static $bar = <<<LABEL
Nothing in here...
LABEL;
}

// クラスのプロパティ/定数
class foo
{
    const BAR = <<<FOOBAR
Constant example
FOOBAR;

    public $baz = <<<FOOBAR
Property example
FOOBAR;
}
?>

ヒアドキュメントの宣言をダブルクォートで囲むこともできます。

例11 ヒアドキュメントでのダブルクォート

<?php
echo <<<"FOOBAR"
Hello World!
FOOBAR;
?>

Nowdoc

Nowdoc はヒアドキュメントと似ていますが、ヒアドキュメントがダブルクォートで囲んだ文字列として扱われるのに対して、 Nowdoc はシングルクォートで囲んだ文字列として扱われます。 Nowdoc の使用方法はヒアドキュメントとほぼ同じですが、その中身について パース処理を行いません。 PHP のコードや大量のテキストを埋め込む際に、エスケープが不要になるので便利です。この機能は、SGML の <![CDATA[ ]]> (ブロック内のテキストをパースしないことを宣言する) と同じようなものです。

Nowdoc の書き方は、ヒアドキュメントと同じように <<< を使用します。しかし、その後に続く識別子をシングルクォートで囲んで <<<'EOT' のようにします。ヒアドキュメントの識別子に関する決まりがすべて Nowdoc の識別子にも当てはまります。特に終端ID の書き方に関する決まりに注意しましょう。

例12 Nowdoc による文字列のクォートの例

<?php
echo <<<'EOD'
Example of string spanning multiple lines
using nowdoc syntax. Backslashes are always treated literally,
e.g. \\ and \'.
EOD;

上の例の出力は以下となります。

Example of string spanning multiple lines
using nowdoc syntax. Backslashes are always treated literally,
e.g. \\ and \'.

例13 変数がある場合の、Nowdoc による文字列のクォートの例

<?php
/* 変数を使った、より複雑な例 */
class foo
{
    public $foo;
    public $bar;

    function __construct()
    {
        $this->foo = 'Foo';
        $this->bar = array('Bar1', 'Bar2', 'Bar3');
    }
}

$foo = new foo();
$name = 'MyName';

echo <<<'EOT'
My name is "$name". I am printing some $foo->foo.
Now, I am printing some {$foo->bar[1]}.
This should not print a capital 'A': \x41
EOT;
?>

上の例の出力は以下となります。

My name is "$name". I am printing some $foo->foo.
Now, I am printing some {$foo->bar[1]}.
This should not print a capital 'A': \x41

例14 静的なデータの例

<?php
class foo {
    public $bar = <<<'EOT'
bar
EOT;
}
?>

変数のパース

文字列が二重引用符で括られるかヒアドキュメントで指定された場合、その中の変数はパースされます。

構文の型には、単純な構文と複雑な構文の 2 種類があります。簡単な構文は、最も一般的で便利です。この構文では、変数や配列の値、オブジェクトのプロパティを、簡単に文字列に埋め込むことができます。

複雑な構文は、式を波括弧で括ることにより認識されます。

簡単な構文

ドル記号 ($) を見付けると、パーサは、有効な変数名を形成することが可能な最長のトークンを取得します。変数名の終りを明示的に指定したい場合は、変数名を波括弧で括ってください。

<?php
$juice = "apple";

echo "He drank some $juice juice." . PHP_EOL;

// 意図しない動作をします。"s" は、変数名として有効な文字です。よって、変数は $juices を参照しています。$juice ではありません。
echo "He drank some juice made of $juices." . PHP_EOL;

// 参照する変数名を波括弧で囲むことで、変数名の終端を明示的に指定しています。
echo "He drank some juice made of {$juice}s.";

?>

上の例の出力は以下となります。

He drank some apple juice.
He drank some juice made of .
He drank some juice made of apples.

同様に、配列添字とオブジェクトのプロパティをパースすることも可能です。配列添字の場合、閉じ角括弧 (]) は添字の終りを意味します。シンプルな変数の場合と同じ規則が、オブジェクトのプロパティに対しても適用されます。

例15 簡単な構文の例

<?php
$juices = array("apple", "orange", "koolaid1" => "purple");

echo "He drank some $juices[0] juice.".PHP_EOL;
echo "He drank some $juices[1] juice.".PHP_EOL;
echo "He drank some $juices[koolaid1] juice.".PHP_EOL;

class people {
    public $john = "John Smith";
    public $jane = "Jane Smith";
    public $robert = "Robert Paulsen";
    
    public $smith = "Smith";
}

$people = new people();

echo "$people->john drank some $juices[0] juice.".PHP_EOL;
echo "$people->john then said hello to $people->jane.".PHP_EOL;
echo "$people->john's wife greeted $people->robert.".PHP_EOL;
echo "$people->robert greeted the two $people->smiths."; // 動作しません
?>

上の例の出力は以下となります。

He drank some apple juice.
He drank some orange juice.
He drank some purple juice.
John Smith drank some apple juice.
John Smith then said hello to Jane Smith.
John Smith's wife greeted Robert Paulsen.
Robert Paulsen greeted the two .

PHP 7.1.0 以降では、負の数値インデックスもサポートされました。

例16 負の数値インデックス

<?php
$string = 'string';
echo "The character at index -2 is $string[-2].", PHP_EOL;
$string[-3] = 'o';
echo "Changing the character at index -3 to o gives $string.", PHP_EOL;
?>

上の例の出力は以下となります。

The character at index -2 is n.
Changing the character at index -3 to o gives strong.

より複雑な場合は、複雑な構文を使用する必要があります。

複雑な (波括弧) 構文

この構文が「複雑(complex)な構文」と呼ばれているのは、構文が複雑であるからではなく、この方法では複雑な式を含めることができるからです。

どんなスカラー変数、配列の要素あるいはオブジェクトのプロパティの文字列表現であってもこの構文で含めることができます。文字列の外側に置く場合と同様に式を書き、これを { と } の間に含めてください。'{' はエスケープすることができないため、この構文は $ が { のすぐ後に続く場合にのみ認識されます (リテラル "{$" を指定するには、"{\$" を使用してください)。以下のいくつかの例を見ると理解しやすくなるでしょう。

<?php
// すべてのエラーを表示します
error_reporting(E_ALL);

$great = 'fantastic';

// うまく動作しません。出力: This is { fantastic}
echo "This is { $great}";

// うまく動作します。出力: This is fantastic
echo "This is {$great}";

// 動作します
echo "This square is {$square->width}00 centimeters broad."; 


// 動作します。クォートしたキーを使う場合は、波括弧構文を使わなければなりません
echo "This works: {$arr['key']}";


// 動作します
echo "This works: {$arr[4][3]}";

// これが動作しない理由は、文字列の外で $foo[bar]
// が動作しない理由と同じです。
// PHP はまず最初に foo という名前の定数を探し、
// 見つからない場合はエラーをスローします。
// 定数が見つかった場合は、その値('foo' そのものではない)
// を配列のインデックスとして使います。
echo "This is wrong: {$arr[foo][3]}"; 

// 動作します。多次元配列を使用する際は、
// 文字列の中では必ず配列を波括弧で囲むようにします。
echo "This works: {$arr['foo'][3]}";

// 動作します
echo "This works: " . $arr['foo'][3];

echo "You can even write {$obj->values[3]->name}";

echo "This is the value of the var named $name: {${$name}}";

echo "This is the value of the var named by the return value of getName(): {${getName()}}";

echo "This is the value of the var named by the return value of \$object->getName(): {${$object->getName()}}";

// 動作しません。出力: This is the return value of getName(): {getName()}
echo "This is the return value of getName(): {getName()}";

// 動作しません。出力: C:\folder\{fantastic}.txt
echo "C:\folder\{$great}.txt"
// 動作します。出力: C:\folder\fantastic.txt
echo "C:\\folder\\{$great}.txt"
?>

文字列内で、変数を使ってクラスのプロパティにアクセスすることもできます。