PHP – 雛形 – MySQLのクォート

2021-01-04 / tau / コメントする

概要

SQLでは一般にシングルクォート(')やダブルクォート(")で文字列を囲う。

INSERT INTO table(text) VALUES ('text contents');

1	INSERT INTO table(text) VALUES ('text contents');

テキストの内容としてクォートを含む場合、そのまま記述したりテキストボックスの入力内容をそのまま使ってしまうと文字列境界との区別がつかず、エラーが発生してしまう。

そこでSQLデータの書き込み時に、SQLとして適切に解釈可能なようにエスケープする必要がある。

シングルクォートのエスケープ

SQLエスケープ

SQL標準では、シングルクォートを文字として扱う場合にクォートを2つ連続させる('')。

PHPからSQLを操作する際にシングルクォートを含む文字列をリテラルとして扱う場合、以下のような方法がある。

query文字列をダブルクォート(")で囲う
テキストリテラルをシングルクォート(')で囲う
テキストリテラル中のシングルクォートはこれを2回続けて('')SQL標準でエスケープする

$query = "INSERT INTO test_text_table(text) VALUES ('I''m fine.')";
mysqli_query($dblink, $query);

// I'm fine.

$query = "INSERT INTO test_text_table(text) VALUES ('I''m fine.')";

mysqli_query($dblink, $query);

// I'm fine.

定義済み関数によるエスケープ

PHPの文字列として扱う場合、シングルクォートをバックスラッシュでエスケープすることができる(\')。この場合、リテラルの解釈後には1文字のシングルクォートとして扱われる。また、テキストボックスに入力された文字列にクォートが入っているケースも考えられる。

ところで、このような文字列をそのままquery構文に渡してしまうとSQLが文字列境界として扱うので不都合が生じる。そこで、PHPに準備されたエスケープ用の関数を使う。この関数の手続き型の構文は以下の通り。

$escaped_string = mysqli_real_escape_string($dblink, $original_string);

第1引数にmysqli_connect()で得られるデータベースリンクが必要な点に注意。

たとえばターゲットの文字列をPHPの変数として扱う場合、以下の手順が考えられる。

クォートを含む可能性がある文字列をmysqli_real_escape_string()関数でエスケープする
- リテラルとして文字列を準備する場合は、シングルクォートで囲い、文字列中のシングルクォートをバックスラッシュでエスケープする
queryに文字列変数を渡す際に
1. 文字列変数の内容がシングルクォートで囲われるようにする
2. そのため、文字列前後の構文をダブルクォートで囲う

$string = mysqli_real_escape_string($dblink, 'I\'m fine.');
$query = "INSERT INTO test_text_table(text) VALUES ('" . $string . "')";
mysqli_query($dblink, $query);

// I'm fine.

$string = mysqli_real_escape_string($dblink, 'I\'m fine.');

$query = "INSERT INTO test_text_table(text) VALUES ('" . $string . "')";

mysqli_query($dblink, $query);

// I'm fine.

ダブルクォートのエスケープ

ダブルクォートもSQLでは文字列境界として扱われるので、queryの構文中にリテラルで書くとエラーとなる。

テキストボックスなどからの入力の場合はそのままmysqli_real_escape_string()でエスケープするといいが、リテラルの場合は全体をシングルクォートで囲ってやるとよい。

$string = mysqli_real_escape_string($dblink, 'He said "I\'m fine."');
$query = "INSERT INTO test_text_table(text) VALUES ('" . $string . "')";
mysqli_query($dblink, $query);

// He said "I'm fine."

$string = mysqli_real_escape_string($dblink, 'He said "I\'m fine."');

$query = "INSERT INTO test_text_table(text) VALUES ('" . $string . "')";

mysqli_query($dblink, $query);

// He said "I'm fine."

読み込み時

エスケープされた文字列がSQLで保存されると、クォートが1つずつの文字列として記録されている。それらを含むテキストをフェッチして変数に代入すると、適正に表示される。

$query = 'SELECT id, text FROM test_text_table';
$query_result = mysqli_query($dblink, $query);
while ($record = mysqli_fetch_assoc($query_result)) {
  echo $record['id'] . '-' . $record['text'] . '<br>';
}
mysqli_free_result($query_result);

// 1-I'm fine.
// 2-I'm fine.
// 3-He said "I'm fine."

$query = 'SELECT id, text FROM test_text_table';

$query_result = mysqli_query($dblink, $query);

while ($record = mysqli_fetch_assoc($query_result)) {

echo $record['id'] . '-' . $record['text'] . '<br>';

}

mysqli_free_result($query_result);

// 1-I'm fine.

// 2-I'm fine.

// 3-He said "I'm fine."

PHP – 雛形 – MySQL操作(mysqli)

2021-01-03 / tau / コメントする

概要

PHPからデータベースを操作する手続きの大枠は以下の通り。

DBサーバー・DBに接続してDBリンクを取得
→$db_link =mysql_connect()
→if($db_link)で接続成功／失敗処理
- DBサーバーに接続してからDBに接続／変更
  →mysql_select_db()
文字コードを設定する
→mysqli_set_charset()
query文字列によりDBから絞り込んだデータを取得
→mysqli_query()
→処理内容によって戻り値に注意
DBから1レコードずつ取り出す
→mysqli_fetch_array()/mysqli_fetch_assoc()
レコード内のカラムデータをキーを介して利用
→カラム名をキーとした連想配列など
SELECTなど結果セットがある場合はメモリーを解放（INSERTの場合は不要）
→mysqli_free_result()
データベースリンクをクローズ
→mysqli_close()

データベースを最初に指定する場合

// データベースを指定してMySQLに接続
$db_link = mysql_connect( 'host', 'user_name', 'password', 'db_name');

if ($db_link) { // DB接続成功の場合
  // クライアントの文字コードセット
  mysqli_set_charset($link, 'utf8');

  // データベースのクエリー結果取得
  $result = mysqli_query($link, 'Query文字列');

  // クエリーをレコード単位で処理
  while ($row = mysqli_fetch_array($result)) {
    // DBデータ利用処理
    // echo $row['カラム名'];　など
  }

  // クエリー結果を解放
  mysqli_free_result($result);

  // MySQLをクローズ
  mysqli_close($db_link);
} else { // DB接続失敗の場合
  // DB接続失敗時処理;
}

// データベースを指定してMySQLに接続

$db_link = mysql_connect( 'host', 'user_name', 'password', 'db_name');

if ($db_link) { // DB接続成功の場合

// クライアントの文字コードセット

mysqli_set_charset($link, 'utf8');

// データベースのクエリー結果取得

$result = mysqli_query($link, 'Query文字列');

// クエリーをレコード単位で処理

while ($row = mysqli_fetch_array($result)) {

// DBデータ利用処理

// echo $row['カラム名'];　など

}

// クエリー結果を解放

mysqli_free_result($result);

// MySQLをクローズ

mysqli_close($db_link);

} else { // DB接続失敗の場合

// DB接続失敗時処理;

}

MySQLに接続後にDBを選択／変更する場合

// DBサーバーに接続
$db_link = mysql_connect('host', 'user_name', 'password');

// DBに接続
mysql_select_db('database_name', $db_link);

// DBサーバーに接続

$db_link = mysql_connect('host', 'user_name', 'password');

// DBに接続

mysql_select_db('database_name', $db_link);

PHP – str_replace～文字列の置換

2021-01-03 / tau / コメントする

概要

str_replace()は文字列中の対象文字列を指定した文字列に置き換える。

str_replace($search, $replace, $string);

$searchは置き換えられる文字列、$replaceは置き換える文字列、$stringは対象文字列。

基本形

文字列の変換

以下の例は、対象文字列中の’ab’を’AB’に変換している。

<pre>
<?php
$s = 'abcdabcdab';

echo $s, "\n";
// abcdabcdab

echo str_replace('ab', 'AB', $s);
// ABcdABcdAB
?>
</pre>

<pre>

<?php

$s = 'abcdabcdab';

echo $s, "\n";

// abcdabcdab

echo str_replace('ab', 'AB', $s);

// ABcdABcdAB

</pre>

半角スペースの削除

以下の例では、文字列中の半角スペースを全て削除している。trimと異なり、文字列中のすべてのスペースを削除。

<pre>
<?php
$s = ' a b c ';

echo '|', $s, '|', "\n";
// | a b c |

echo '|', str_replace(' ', '', $s), '|';
// |abc|
?>
</pre>

<pre>

<?php

$s = ' a b c ';

echo '|', $s, '|', "\n";

// | a b c |

echo '|', str_replace(' ', '', $s), '|';

// |abc|

</pre>

全角スペースの削除

全角スペースを削除する例。

<pre>
<?php
$s = '　a　b　c　';

echo '|', $s, '|', "\n";
// |　a　b　c　|

echo '|', str_replace('　', '', $s), '|';
// |abc|
?>
</pre>

<pre>

<?php

$s = '　a　b　c　';

echo '|', $s, '|', "\n";

// |　a　b　c　|

echo '|', str_replace('　', '', $s), '|';

// |abc|

</pre>

全角文字の置換

全角文字も問題なく検索・置換できる。

<pre>
<?php
$s = "いろはにいろはにいろ";

echo $s, "\n";
// いろはにいろはにいろ

echo str_replace('いろ', 'ほへ', $s);
// ほへはにほへはにほへ
?>
</pre>

<pre>

<?php

$s = "いろはにいろはにいろ";

echo $s, "\n";

// いろはにいろはにいろ

echo str_replace('いろ', 'ほへ', $s);

// ほへはにほへはにほへ

</pre>

複数文字列の置換

複数の文字列の同一文字列への置換

第1引数を文字列の配列にすると、各要素文字列の何れかに該当すれば第2引数に置き換えられる。

<pre>
<?php
$s = "ABCDABCDABCD";
echo $s, "\n";
// ABCDABCDABCD

echo str_replace(['A', 'C'], '-', $s);
//-B-D-B-D-B-D
?>
</pre>

<pre>

<?php

$s = "ABCDABCDABCD";

echo $s, "\n";

// ABCDABCDABCD

echo str_replace(['A', 'C'], '-', $s);

//-B-D-B-D-B-D

</pre>

これを利用して、文字列が半角スペースと全角スペースだけで構成されていないかチェックができる。

if (str_replace([' ', '　'], "") === '') {}

複数の文字列セットの置換

第1引数と第2引数を配列にすると、対応する要素によって置換される。

<pre>
<?php
$s = "いろはにほへといろはにほへと";
echo $s, "\n";
// いろはにほへといろはにほへと

$searches = ['いろは', 'にほへと'];
$replaces = ['色は', '匂へど'];
echo str_replace($searches, $replaces, $s);
// 色は匂へど色は匂へど
?>
</pre>

<pre>

<?php

$s = "いろはにほへといろはにほへと";

echo $s, "\n";

// いろはにほへといろはにほへと

$searches = ['いろは', 'にほへと'];

$replaces = ['色は', '匂へど'];

echo str_replace($searches, $replaces, $s);

// 色は匂へど色は匂へど

</pre>

PHP – trim/ltrim/rtrim

2021-01-03 / tau / コメントする

概要

trim系の関数は、指定した文字列の先頭・末尾のスペースや区切り文字など以下の文字を取り除く。

" " (ASCII 32 (0x20)), 通常の空白
"\t" (ASCII 9 (0x09)), タブ
"\n" (ASCII 10 (0x0A)), リターン
"\r" (ASCII 13 (0x0D)), 改行
"\0" (ASCII 0 (0x00)), NULバイト
"\v" (ASCII 11 (0x0B)), 垂直タブ

全角のスペースが削除されない、全角文字の場合うまく機能しないなどの制約がある。半角・全角のスペース削除や全角文字列の削除はうまく機能しない。

基本形

trim()は先頭と末尾を、ltrim()は先頭、rtrim()は末尾をトリムする。

先頭／末尾に連続した対象文字は全て削除される
他の文字に挟まれた先頭／末尾以外の対象文字は削除されない

<pre>
<?php
$s = "\n a b c \n";

echo '|', $s, '|', "\n";
// |
//  a b c 
// |

echo '|', trim($s), '|', "\n";
// |a b c|

echo '|', ltrim($s), '|', "\n";
// |a b c 
// |

echo '|', rtrim($s), '|', "\n";
// |
//  a b c|

?>
</pre>

<pre>

<?php

$s = "\n a b c \n";

echo '|', $s, '|', "\n";

// |

// a b c

// |

echo '|', trim($s), '|', "\n";

// |a b c|

echo '|', ltrim($s), '|', "\n";

// |a b c

// |

echo '|', rtrim($s), '|', "\n";

// |

// a b c|

</pre>

全角スペースは削除されない

<pre>
<?php
$s = '　a　b　c　';

echo '|', $s, '|', "\n";
// |　a　b　c　|

echo '|', trim($s), '|', "\n";
// |　a　b　c　|

echo '|', ltrim($s), '|', "\n";
// |　a　b　c　|

echo '|', rtrim($s), '|', "\n";
// |　a　b　c　|
?>
</pre>

<pre>

<?php

$s = '　a　b　c　';

echo '|', $s, '|', "\n";

// |　a　b　c　|

echo '|', trim($s), '|', "\n";

// |　a　b　c　|

echo '|', ltrim($s), '|', "\n";

// |　a　b　c　|

echo '|', rtrim($s), '|', "\n";

// |　a　b　c　|

</pre>

指定した文字列でトリム

第2引数でトリムする文字列を指定できる。1文字である必要はない。

<pre>
<?php
$s = 'abcdabcdab';

echo $s, "\n";
// abcdabcdab

echo trim($s, 'ab'), "\n";
// cdabcd

echo ltrim($s, 'ab'), "\n";
// cdabcdab

echo rtrim($s, 'ab'), "\n";
// abcdabcd
?>
</pre>

<pre>

<?php

$s = 'abcdabcdab';

echo $s, "\n";

// abcdabcdab

echo trim($s, 'ab'), "\n";

// cdabcd

echo ltrim($s, 'ab'), "\n";

// cdabcdab

echo rtrim($s, 'ab'), "\n";

// abcdabcd

</pre>

全角文字はうまく動作しない

以下の例では、末尾文字列は削除されているが、先頭文字列はうまく削除されていない。

<pre>
<?php
$s = 'いろはにいろはにいろ';

echo $s, "\n";
// いろはにいろはにいろ

echo trim($s, 'いろ'), "\n";
// �にいろはに

echo ltrim($s, 'いろ'), "\n";
// �にいろはにいろ

echo rtrim($s, 'いろ'), "\n";
// いろはにいろはに
?>
</pre>

<pre>

<?php

$s = 'いろはにいろはにいろ';

echo $s, "\n";

// いろはにいろはにいろ

echo trim($s, 'いろ'), "\n";

// �にいろはに

echo ltrim($s, 'いろ'), "\n";

// �にいろはにいろ

echo rtrim($s, 'いろ'), "\n";

// いろはにいろはに

</pre>

PHP – explode～文字列の分解

2021-01-02 / tau / コメントする

概要

explode()は指定した区切り文字列で文字列を分解する。

書式

explode ( string $separator , string $string [, int $limit = PHP_INT_MAX ] ) : array

引数

$separator: 区切り文字列
$string: 区切り文字列で分解される文字列

戻り値

分解された文字列が配列に入れられる。

実行例

','を区切り文字として指定して分解した例。分解後の文字列が空文字列となる場合に注意。

$s = ',abc,defg,,hijk,';

$a = explode(',', $s);
var_dump($a);

// array (size=6)
//   0 => string '' (length=0)
//   1 => string 'abc' (length=3)
//   2 => string 'defg' (length=4)
//   3 => string '' (length=0)
//   4 => string 'hijk' (length=4)
//   5 => string '' (length=0)

$s = ',abc,defg,,hijk,';

$a = explode(',', $s);

var_dump($a);

// array (size=6)

// 0 => string '' (length=0)

// 1 => string 'abc' (length=3)

// 2 => string 'defg' (length=4)

// 3 => string '' (length=0)

// 4 => string 'hijk' (length=4)

// 5 => string '' (length=0)

区切りは1文字でなくてもよい。以下の例は'ef'が区切り文字列となり、それを除いて分解された文字列が配列に入れられている。

$b = explode('ef', $s);
var_dump($b);

// array (size=2)
//   0 => string ',abc,d' (length=6)
//   1 => string 'g,,hijk,' (length=8)

$b = explode('ef', $s);

var_dump($b);

// array (size=2)

// 0 => string ',abc,d' (length=6)

// 1 => string 'g,,hijk,' (length=8)

該当する文字列がない場合は、分解されずに元の文字列を要素とする配列が返される。

$c = explode('eh', $s);
var_dump($c);

// array (size=1)
//   0 => string ',abc,defg,,hijk,' (length=16)

$c = explode('eh', $s);

var_dump($c);

// array (size=1)

// 0 => string ',abc,defg,,hijk,' (length=16)

区切り文字列が空の場合戻り値がfalseとなるが、警告が発せられる。

$d = explode('', $s);
var_dump($d);

// Warning: explode(): Empty delimiter
// false

$d = explode('', $s);

var_dump($d);

// Warning: explode(): Empty delimiter

// false

PHP – 雛形 – ファイル操作

2020-12-31 / tau / コメントする

ファイルの確認

file_exists～ファイルの存在確認

基本形

file_exists()は引数で指定したファイル名のファイルが存在するかどうかを確認する。(PHP-manual)

file($filename)

戻り値はファイルの存在／不存在に従ってtrue/false。

is_readable～ファイルの読み込み可能性確認

is_readable()はファイル名を指定したファイルが存在し読み込み可能かどうかを確認する。(PHP-manual)

is_readable($failename)

戻り値は指定したファイルが存在し読み込み可能な場合はtrue、それ以外の場合にfalse。

ファイルのオープン／クローズ

fopen～ファイルのオープン

基本形

多くのファイル操作では、最初にファイルをオープンしてファイルポインターリソースを取得する。ファイルの書き込みや読み込みはファイルリソースを通して行う。

fopen()は第1引数にファイル名、第2引数にモードを指定する。モードは書き込み／読み込み、ファイルポインターの位置などに応じて所定の文字列で指定。(PHP-manual)

fopen($filename, $mode)

エラー処理

fopen()の戻り値はresource型だが、オープンに失敗した場合の戻り値はfalse。このため、fopen()のエラーチェックは明示的にfalseであるかどうかを比較する。

if (fopen($filename, $mode) === false) {
  エラー時の処理;
} else {
  成功時の処理;
}

if (fopen($filename, $mode) === false) {

エラー時の処理;

} else {

成功時の処理;

}

flose～ファイルのクローズ

基本形

fopen()得られたファイルポインターリソースを引数に指定してファイルを閉じる。

flose($file)

エラー処理

fclose()の戻り値はbool型で、処理の成功／失敗に応じてtrue/falseが返される。しかし、明示的にfclose()に対するエラーチェックを行うのが一般的なのか（あるいはそうすべきなのか）どうか不明。

行単位の書き込み・読み込み

fwrite～行単位の書き込み

基本形

テキストを行単位で書き込むにはfwrite()を使う。エラー処理を全て除いた基本的な流れは以下の通り。

fopen(ファイル名)でファイルをオープンしてファイルハンドラーを取得
- モードの指定は新規書き込み('w')、追加書き込み('a')など
- PHP-manual
fwrite(ファイルハンドラー, 行データ)で行データを順次書き込み
- 改行文字\nは付けられないので、必要に応じて追加書き込み
- PHP-manual
flcose(ファイルハンドラー)でファイルをクローズ
- PHP-manual

<?php
echo 'ファイル書き込み～基本';

// 書き込み用データ
$data = [
  'シェパード',
  'ゴールデンレトリバー',
  'セントバーナード',
  'ボーダーコリー',
];
// 書き込みファイル名
$filename = 'file.txt';

// 書き込み用でファイルをオープン
$file = fopen($filename, 'w');
// 行単位で書き込み／行末には\nを加える
foreach ($data as $item) {
  fwrite($file, $item."\n");
}
// ファイルをクローズ
fclose($file);
?>

<?php

echo 'ファイル書き込み～基本';

// 書き込み用データ

$data = [

'シェパード',

'ゴールデンレトリバー',

'セントバーナード',

'ボーダーコリー',

];

// 書き込みファイル名

$filename = 'file.txt';

// 書き込み用でファイルをオープン

$file = fopen($filename, 'w');

// 行単位で書き込み／行末には\nを加える

foreach ($data as $item) {

fwrite($file, $item."\n");

}

// ファイルをクローズ

fclose($file);

上の例では\nを付加しており、出力ファイルの内容は以下のようになる。

シェパード
ゴールデンレトリバー
セントバーナード
ボーダーコリー

シェパード

ゴールデンレトリバー

セントバーナード

ボーダーコリー

エラー処理

fwrite()の戻り値はint型で書き込んだバイト数を返すが、書き込みに失敗した場合の戻り値はfalse。このため、fwrite()のエラーチェックは明示的にfalseであるかどうかを比較する。

if (fwrite($file, $string) === false) {
  エラー時の処理;
} else {
  成功時の処理;
}

if (fwrite($file, $string) === false) {

エラー時の処理;

} else {

成功時の処理;

}

fgets～行単位の読み込み

基本形

fgets()は\nで区切られた行単位でデータを読み込む。エラー処理を除いた基本的な流れは以下の通り。

fopen(ファイル名)でファイルをオープンしてファイルハンドラーを取得
- モードの指定は読込('r')など
- PHP-manual
fgets(ファイルハンドラー)で行データを順次読み込み
- 通常while文でファイルの最後に行きつくまで順次読み込む
- PHP-manual
flcose(ファイルハンドラー)でファイルをクローズ
- PHP-manual

<?php
// 読み込みファイル名
$filename = 'file.txt';

// ファイルが存在していて読込可能なことを確認
if (is_readable($filename)) {
  // 読込用でファイルをオープン
  $file = fopen($filename, 'r');

  // 行単位で読み込み
  while ($line = fgets($file)) {
    echo $line, '<br>';
  }

  // ファイルをクローズ
  fclose($file);
}
?>

<?php

// 読み込みファイル名

$filename = 'file.txt';

// ファイルが存在していて読込可能なことを確認

if (is_readable($filename)) {

// 読込用でファイルをオープン

$file = fopen($filename, 'r');

// 行単位で読み込み

while ($line = fgets($file)) {

echo $line, '<br>';

}

// ファイルをクローズ

fclose($file);

}

このコードでは、最低限ファイルが存在して読み込み可能なことをis_readble()でチェックしている。

また行データを読み込んだ後、ブラウザーで改行させるため<br>を付加している。その表示結果は以下の通り。

シェパード
ゴールデンレトリバー
セントバーナード
ボーダーコリー

シェパード

ゴールデンレトリバー

セントバーナード

ボーダーコリー

読み込み終了処理

fgets()の戻り値はstring型で読み込んだテキストを返すが、読み込むデータがない場合はfalse。このため、fgets()はのエラーチェックは明示的にfalseであるかどうかを比較する。

while ($string = fgets($file) {
  読み込みに付随した処理;
}

while ($string = fgets($file) {

読み込みに付随した処理;

}

一括書き込み・読み込み

file_put_contents

基本形

file_put_contents()は、ファイル名を直接指定してデータを一括して書き込む。(PHP-manual)

<?php
echo 'file_put_content～基本';

$data = [
  'シェパード',
  'ゴールデンレトリバー',
  'セントバーナード',
  'ボーダーコリー',
];

$filename = 'file.txt';

file_put_contents($filename, $data);
?>

<?php

echo 'file_put_content～基本';

$data = [

'シェパード',

'ゴールデンレトリバー',

'セントバーナード',

'ボーダーコリー',

];

$filename = 'file.txt';

file_put_contents($filename, $data);

この例では配列を直接渡して全要素を書き出しているが、要素間に改行文字は挿入されず、連続して書き込まれる。

シェパードゴールデンレトリバーセントバーナードボーダーコリー

1	シェパードゴールデンレトリバーセントバーナードボーダーコリー

要素ごとに行を区切る場合には、foreachで要素を取り出して改行文字\nを付加して書き込む。ただしこのときは前のデータを上書きしないようにFILE_APPENDフラグを立てる必要があるが、そうすると既にファイルが存在している際に追加書き込みになってしまう。

foreach ($data as $line) {
  file_put_contents($filename, $line."\n", FILE_APPEND);
}

foreach ($data as $line) {

file_put_contents($filename, $line."\n", FILE_APPEND);

}

ファイルが存在しない（あるいは空のファイルが存在する）場合のファイルの内容は以下のようになる。

シェパード
ゴールデンレトリバー
セントバーナード
ボーダーコリーエラー処理

シェパード

ゴールデンレトリバー

セントバーナード

ボーダーコリーエラー処理

エラー処理

file_put_contents()の戻り値はint型で書き込んだバイト数を返すが、書き込みに失敗した場合の戻り値はfalse。このため、file_put_contents()のエラーチェックは明示的にfalseであるかどうかを比較する。

if (file_put_contents($file, $data) === false) {
  エラー時の処理;
} else {
  成功時の処理;
}

if (file_put_contents($file, $data) === false) {

エラー時の処理;

} else {

成功時の処理;

}

file_get_contents

基本形

file_get_contents()はファイル名を指定してその内容を一つの変数に読み込む。(PHP-manual)

<?php
$filename = 'file.txt';

$content = file_get_contents($filename);

echo $content;
?>

<?php

$filename = 'file.txt';

$content = file_get_contents($filename);

echo $content;

改行文字\nもそのまま読み込まれるが、ブラウザーでは反映されないため、上のコードの表示結果は以下のようになる。

シェパード ゴールデンレトリバー セントバーナード ボーダーコリー

1	シェパードゴールデンレトリバーセントバーナードボーダーコリー

一括取得されたテキストをブラウザー上で改行させたい場合には、以下のように\nを<br>に置き換えるとよい。

echo str_replace("\n", '<br>', $content);

1	echo str_replace("\n", '<br>', $content);

エラー処理

file_get_contents()の戻り値はstring型で読み込んだデータを返すが、読み込みに失敗した場合の戻り値はfalse。このため、file_get_contents()のエラーチェックは明示的にfalseであるかどうかを比較する。

if (($string = file_get_contents($file)) === false) {
  エラー時の処理;
} else {
  成功時の処理;
}

if (($string = file_get_contents($file)) === false) {

エラー時の処理;

} else {

成功時の処理;

}

readfile

基本形

readfile()はファイルの内容を一括して読み込み、それを直接表示する。(PHP-manual)

<?php
$filename = 'file.txt';

readfile($filename);
?>

<?php

$filename = 'file.txt';

readfile($filename);

改行文字はブラウザーでは反映されないため、行単位で区切られたファイルでも表示は以下のようになる。

シェパード ゴールデンレトリバー セントバーナード ボーダーコリー

1	シェパードゴールデンレトリバーセントバーナードボーダーコリー

エラー処理

readfile()の戻り値はint型で読み込んだデータのバイト数を返すが、読み込みに失敗した場合の戻り値はfalse。このため、file_get_contents()のエラーチェックは明示的にfalseであるかどうかを比較する。

if (readfile($file) === false) {
  エラー時の処理;
} else {
  成功時の処理;
}

if (readfile($file) === false) {

エラー時の処理;

} else {

成功時の処理;

}

CSVファイルの書き込み・読み込み

fputcsv

基本形

fputcsv()は配列データをCSVファイルとして書き込む。基本の流れはfwrite()と同じ。(PHP-mannual)

<?php
// fputcsvへのデータは2次元配列で与える
$data = [
  ['名前', '血液型', '身長'],
  ['伊藤', 'A', '172'],
  ['後藤', 'O', '162'],
  ['斉藤', 'B', '180'],
  ['内藤', 'AB', '168'],
];

$filename = 'file.csv';

$file = fopen($filename, 'w');

// 2次元配列から行配列を取り出してfputcsv
foreach ($data as $field) {
  fputcsv($file, $field);
}

fclose($file);
?>

<?php

// fputcsvへのデータは2次元配列で与える

$data = [

['名前', '血液型', '身長'],

['伊藤', 'A', '172'],

['後藤', 'O', '162'],

['斉藤', 'B', '180'],

['内藤', 'AB', '168'],

];

$filename = 'file.csv';

$file = fopen($filename, 'w');

// 2次元配列から行配列を取り出してfputcsv

foreach ($data as $field) {

fputcsv($file, $field);

}

fclose($file);

上記のコードで配列をCSVとして書き込んだファイルの内容は以下の通り。

名前,血液型,身長
伊藤,A,172
後藤,O,162
斉藤,B,180
内藤,AB,168

名前,血液型,身長

伊藤,A,172

後藤,O,162

斉藤,B,180

内藤,AB,168

エラー処理

fputcsv()の戻り値はint型で書き込んだ文字数を返すが、書き込みに失敗した場合の戻り値はfalse。このため、file_put_contents()のエラーチェックは明示的にfalseであるかどうかを比較する。

if (fputcsv($file, $data) === false) {
  エラー時の処理;
} else {
  成功時の処理;
}

if (fputcsv($file, $data) === false) {

エラー時の処理;

} else {

成功時の処理;

}

fgetcsv

基本形

fgetcsv()はCSVからデータを読み込む。読み込みは行ごとに行われ、1つの行（フィールドは）カンマ（あるいは指定した文字）で区切られたデータごとに分けられ、1次元の配列として返される。(PHP-manual)

<?php
$filename = 'file.csv';

$file = fopen($filename, 'r');

// fgetcsvは行単位のフィールドで読み込む
while ($field = fgetcsv($file)) {
  // フィールドデータは1次元配列として読み込まれる
  foreach ($field as $item) {
    echo $item, ' ';
  }
  echo '<br>';
}

fclose($file);
?>

<?php

$filename = 'file.csv';

$file = fopen($filename, 'r');

// fgetcsvは行単位のフィールドで読み込む

while ($field = fgetcsv($file)) {

// フィールドデータは1次元配列として読み込まれる

foreach ($field as $item) {

echo $item, ' ';

}

echo '<br>';

}

fclose($file);

上記コードの表示結果は以下の通り。

名前 血液型 身長
伊藤 A 172
後藤 O 162
斉藤 B 180
内藤 AB 168

名前血液型身長

伊藤 A 172

後藤 O 162

斉藤 B 180

内藤 AB 168

エラー処理

rgetcsv()の戻り値は読み込んだ行のデータの数値展示配列だが、無効なハンドルを受け取った場合はnull、ファイル終端に達したときやその他のエラーの場合はfalseを返す。このため、fgetcsv()のエラーチェックは明示的にfalseであるかどうかを比較する。

if (readfile($file) === false) {
  エラー時の処理;
} else {
  成功時の処理;
}

if (readfile($file) === false) {

エラー時の処理;

} else {

成功時の処理;

}

PHP – 雛形 – GET/POST

2020-12-31 / tau / コメントする

画面遷移するGET

以下の例は、入力画面のformでテキストを入力し別ページにGETでデータを渡す。遷移後のページでスーパーグローバル変数$_GETを介してデータを受け取り、それを表示している。GETメソッドをPOSTに変更しても動作する。

入力ページ

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>GETの例～入力ページ</title>
  </head>
  <body>
    <h1>入力ページ</h1>
    <form method="get" action="get_display.php">
      <label>
        名前を入力：
        <input type="text" name="user_name">
        <input type="submit" value="送信">
      </label>
    </form>
  </body>
</html>

<!DOCTYPE html>

<head>

<title>GETの例～入力ページ</title>

</head>

<body>

<h1>入力ページ</h1>

<label>

名前を入力：

</label>

</form>

</body>

</html>

遷移後の表示ページ

<?php
$message = '';

if ($_SERVER['REQUEST_METHOD'] === 'GET') {
  if (!isset($_GET['user_name'])) {
    $message = '何らかのトラブルです';
  } else if ($_GET['user_name'] === '') {
    $message = '名前を入力してください';
  } else {
    $message = 'ようこそ';
    $message .= htmlspecialchars($_GET['user_name'], ENT_QUOTES, 'UTF-8');
    $message .= 'さん';
  }
}
?>

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>GETの例～表示ページ</title>
  </head>
  <body>
    <h1>遷移後の表示ページ</h1>
    <p><?php echo $message; ?></p>
  </body>
</html>

<?php

$message = '';

if ($_SERVER['REQUEST_METHOD'] === 'GET') {

if (!isset($_GET['user_name'])) {

$message = '何らかのトラブルです';

} else if ($_GET['user_name'] === '') {

$message = '名前を入力してください';

} else {

$message = 'ようこそ';

$message .= htmlspecialchars($_GET['user_name'], ENT_QUOTES, 'UTF-8');

$message .= 'さん';

}

<!DOCTYPE html>

<head>

<title>GETの例～表示ページ</title>

</head>

<body>

<h1>遷移後の表示ページ</h1>

</body>

</html>

入力ページの要点

htmlファイルでもいいが、将来の変更可能性を見据えてphpファイル
form要素でmethod属性をgetに、action属性で遷移先のページを指定
テキスト入力はinput要素でtype属性をtextに、name属性の値は受信側の変数で使われる
送信ボタンはinput要素のtype属性をsubmitにして配置

遷移後のページの要点

スーパーグローバル変数$_SERVER['REQUEST_METHOD']で送信側のメソッドが'GET'であることを確認（'POST'の場合は以降が無視されて$messageは空のまま）
スーパーグローバル変数$_GETは連想配列で、送信側のname属性で指定した値をキーとして値を取り出す
isset()で$_GETがundefinedの場合はエラー処理
テキストボックスが空のままGETされると空文字列になるため、必要に応じてその処理
テキストが有効な場合表示処理
ユーザー入力を表示する場合は必ずhtmlspecialchar()で特殊文字を変換

画面遷移しないPOST

次の例ではページ遷移をせず、formからPOSTで送信されたデータを同一ページに反映させている。POSTメソッドをGETに変更しても動作する。

要点は1つ前の画面遷移する場合と同じ。

<?php
$message = '';

if ($_SERVER['REQUEST_METHOD'] === 'POST') {
  if (!isset($_POST['user_name'])) {
    $message = '未入力状態';
  } else if ($_POST['user_name'] === '') {
    $message = '名前を入力してください';
  } else {
    $message = 'ようこそ';
    $message .= htmlspecialchars($_POST['user_name'], ENT_QUOTES, 'UTF-8');
    $message .= 'さん';
  }
}
?>

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>画面遷移なしのPOST</title>
  </head>
  <body>
    <h1>入力・表示画面</h1>
    <form method="post">
      <label>
        名前を入力：
        <input type="text" name="user_name">
        <input type="submit" value="送信">
      </label>
    </form>
    <p><?php echo $message; ?></p>
  </body>
</html>

<?php

$message = '';

if ($_SERVER['REQUEST_METHOD'] === 'POST') {

if (!isset($_POST['user_name'])) {

$message = '未入力状態';

} else if ($_POST['user_name'] === '') {

$message = '名前を入力してください';

} else {

$message = 'ようこそ';

$message .= htmlspecialchars($_POST['user_name'], ENT_QUOTES, 'UTF-8');

$message .= 'さん';

}

<!DOCTYPE html>

<head>

<title>画面遷移なしのPOST</title>

</head>

<body>

<label>

名前を入力：

</label>

</form>

</body>

</html>

PHP – 雛形 – HTML要素の生成

2020-12-31 / tau / コメントする

HTMLへの内容の書き込み

HTMLへの直接書き込み

以下のコードはPHPのコードを直接HTML内に埋め込んで、その出力をHTMLの内容とする例。実行後のHTMLソースにはPHPのコードは表示されず、出力結果のみが反映される。

PHPファイル

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>HTML中への要素の直接書き込み</title>
  </head>
  <body>
    <?php echo "<p>このp要素はPHPで直接埋め込まれたものです。</p>\n"; ?>
    <?php echo "<p>HTMLソースでは書き込まれた結果だけが見えます。</p>\n"; ?>
    <?php echo "<p>HTMLソースできちんと改行するために文字列をダブルクォート\"で囲み、改行文字\\nを使っています。</p>\n"; ?>
  </body>
</html>

<!DOCTYPE html>

<head>

<title>HTML中への要素の直接書き込み</title>

</head>

<body>

<?php echo "<p>このp要素はPHPで直接埋め込まれたものです。</p>\n"; ?>

<?php echo "<p>HTMLソースでは書き込まれた結果だけが見えます。</p>\n"; ?>

<?php echo "<p>HTMLソースできちんと改行するために文字列をダブルクォート\"で囲み、改行文字\\nを使っています。</p>\n"; ?>

</body>

</html>

実行後のHTMLソース

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>HTML中への要素の直接書き込み</title>
  </head>
  <body>
    <p>このp要素はPHPで直接埋め込まれたものです。</p>
    <p>HTMLソースでは書き込まれた結果だけが見えます。</p>
    <p>HTMLソースできちんと改行するために文字列をダブルクォート"で囲み、改行文字\nを使っています。</p>
  </body>
</html>

<!DOCTYPE html>

<head>

<title>HTML中への要素の直接書き込み</title>

</head>

<body>

<p>このp要素はPHPで直接埋め込まれたものです。</p>

<p>HTMLソースでは書き込まれた結果だけが見えます。</p>

<p>HTMLソースできちんと改行するために文字列をダブルクォート"で囲み、改行文字\nを使っています。</p>

</body>

</html>

HTMLへの変数内容の書き込み

PHPの変数をHTMLの外側で定義し、HTML内でそれを出力する例。

<?php
$text1 = 'このテキストはHTMLのp要素の内容をPHPの変数として埋め込んだものです。';
$text2 = 'テキストの内容の変数定義はHTMLの中でも外でもかまいません。';
$text3 = '変数を定義しているコードはHTMLソースでは見られません。';
?>

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>HTML中の要素の内容書き込み</title>
  </head>
  <body>
    <p><?php echo $text1 ?></p>
    <p><?php echo $text2 ?></p>
    <p><?php echo $text3 ?></p>
  </body>
</html>

<?php

$text1 = 'このテキストはHTMLのp要素の内容をPHPの変数として埋め込んだものです。';

$text2 = 'テキストの内容の変数定義はHTMLの中でも外でもかまいません。';

$text3 = '変数を定義しているコードはHTMLソースでは見られません。';

<!DOCTYPE html>

<head>

<title>HTML中の要素の内容書き込み</title>

</head>

<body>

</body>

</html>

実行後のHTMLソース

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>HTML中の要素の内容書き込み</title>
  </head>
  <body>
    <p>このテキストはHTMLのp要素の内容をPHPの変数として埋め込んだものです。</p>
    <p>テキストの内容の変数定義はHTMLの中でも外でもかまいません。</p>
    <p>変数を定義しているコードはHTMLソースでは見られません。</p>
  </body>
</html>

<!DOCTYPE html>

<head>

<title>HTML中の要素の内容書き込み</title>

</head>

<body>

<p>このテキストはHTMLのp要素の内容をPHPの変数として埋め込んだものです。</p>

<p>テキストの内容の変数定義はHTMLの中でも外でもかまいません。</p>

<p>変数を定義しているコードはHTMLソースでは見られません。</p>

</body>

</html>

HTML要素の繰り返し書き込み

for文によるHTML要素の生成

以下の例ではfor文で指定した個数のli要素を生成している。

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>繰り返しの例～リスト要素</title>
  </head>
  <body>
    <ul>
<?php for ($i = 1; $i <= 5; $i++) { ?>
      <li><?php echo $i; ?>番目の項目</li>
<?php } ?>
    </ul>
  </body>
</html>

<!DOCTYPE html>

<head>

<title>繰り返しの例～リスト要素</title>

</head>

<body>

<ul>

<?php for ($i = 1; $i <= 5; $i++) { ?>

<li><?php echo $i; ?>番目の項目</li>

<?php } ?>

</ul>

</body>

</html>

実行後のHTMLソース

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>繰り返しの例～リスト要素</title>
  </head>
  <body>
    <ul>
      <li>1番目の項目</li>
      <li>2番目の項目</li>
      <li>3番目の項目</li>
      <li>4番目の項目</li>
      <li>5番目の項目</li>
    </ul>
  </body>
</html>

<!DOCTYPE html>

<head>

<title>繰り返しの例～リスト要素</title>

</head>

<body>

<ul>

<li>1番目の項目</li>

<li>2番目の項目</li>

<li>3番目の項目</li>

<li>4番目の項目</li>

<li>5番目の項目</li>

</ul>

</body>

</html>

foreachによるselect要素の設定

この例ではselect要素の中のoption要素を連想配列に基づいて生成している。

<?php
$science_courses = [
  'physics' => '物理学',
  'chemistry' => '化学',
  'biology' => '生物学',
  'geology' => '地質学',
  'astronomy' => '天文学',
];
?>

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>繰り返しの例～セレクト要素</title>
  </head>
  <body>
    <select name="science_courses">
<?php foreach ($science_courses as $key => $value) { ?>
      <option value="<?php echo $key; ?>"><?php echo $value; ?></option>
<?php } ?>
    </select>
  </body>
</html>

<?php

$science_courses = [

'physics' => '物理学',

'chemistry' => '化学',

'biology' => '生物学',

'geology' => '地質学',

'astronomy' => '天文学',

];

<!DOCTYPE html>

<head>

<title>繰り返しの例～セレクト要素</title>

</head>

<body>

<?php foreach ($science_courses as $key => $value) { ?>

<?php } ?>

</select>

</body>

</html>

実行後のHTMLソース

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>繰り返しの例～セレクト要素</title>
  </head>
  <body>
    <select name="science_courses">
      <option value="physics">物理学</option>
      <option value="chemistry">化学</option>
      <option value="biology">生物学</option>
      <option value="geology">地質学</option>
      <option value="astronomy">天文学</option>
    </select>
  </body>
</html>

<!DOCTYPE html>

<head>

<title>繰り返しの例～セレクト要素</title>

</head>

<body>

</select>

</body>

</html>

PHP – 雛形 – 別ページへの遷移

2020-12-31 / tau / コメントする

概要

現在のページからPHPが書かれた他のページ（拡張子php）に遷移したい場合のテンプレート。

HTMLから

同じドキュメントルート内にターゲットがある場合、普通にファイル名を書けばよい。

<a href="link_to_php_target.php">リンク</a>

<a href="./link_to_php_target.php">リンク</a>

他のディレクトリーにターゲットがある場合、相対パスでの指定も可能。

<a href="./sub/link_to_php_target.php">リンク</a>

1	<a href="./sub/link_to_php_target.php">リンク</a>

サーバーアドレス指定

スーパーグローバル変数$_SERVERからサーバーのIPアドレスを取り出して、そのドキュメントルートから指定することもできる。

<a href="http://<?php echo $_SERVER['HTTP_HOST']; ?>/link_to_php_target.php">リンク</a>

1	<a href="http://<?php echo $_SERVER['HTTP_HOST']; ?>/link_to_php_target.php">リンク</a>

PHPから

header関数

header()関数で’Location:’を設定して遷移する。header()後のexitが必要。注意点として、header()の前には空白行を含めて一切の出力がないこと(PHP-manual)。

以下の例はボタンを押すと別のページに遷移する。

<form method="post">
  <input type="submit" name="header">
</form>

<?php
if (isset($_POST['header'])) {
  header('Location: ./link_to_php_target.php');
  exit;
}
?>

</form>

<?php

if (isset($_POST['header'])) {

header('Location: ./link_to_php_target.php');

exit;

}

PHP – ループ

2020-12-29 / tau / コメントする

for

for (var = 初期値; 終了条件; 変更) {...}

C/C++やJava, JavaScriptと同じで、カウンターとなる変数を介する。

for ($i = 0; $i < 5; $i++) {
  echo $i, ' ';
}

// 0 1 2 3 4

for ($i = 0; $i < 5; $i++) {

echo $i, ' ';

}

// 0 1 2 3 4

このほかに以下の構文も用意されている。

for (継続条件): ... endfor;

for ($i = 0; $i < 5; $i++):
  echo $i, ' ';
endfor;

// 0 1 2 3 4

for ($i = 0; $i < 5; $i++):

echo $i, ' ';

endfor;

// 0 1 2 3 4

while

while (継続条件) {...}

C/C++やJava, JavaScriptと同じで、継続条件が真である間ループを継続する。

$i = 0;
while ($i < 5) {
  echo $, ' ';
  $i++;
}

// 0 1 2 3 4

$i = 0;

while ($i < 5) {

echo $, ' ';

$i++;

}

// 0 1 2 3 4

このほかに以下の構文も用意されている。

while (継続条件): ... endwhile;

$i = 0;
while ($i < 5):
  echo $i, " ";
  $i++;
endwhile;

// 0 1 2 3 4

$i = 0;

while ($i < 5):

echo $i, " ";

$i++;

endwhile;

// 0 1 2 3 4

do-while

do {...} while(継続条件);

do-while構文はブロックの最後で継続条件の判断を行う。

$i = 0;
do {
  echo $i++, ' ';
} while($i < 5);

// 0 1 2 3 4

$i = 0;

do {

echo $i++, ' ';

} while($i < 5);

// 0 1 2 3 4

無限ループ

無限ループの構文。

for(;;)

while(true)

do-while(true);

foreach

配列の要素の取出し

foreach (array as val) {...}

foreachはPythonのfor inやRubyのeach doと同じく、インデックスを介さずに配列の要素を順に取り出す。

$array = ['one', 'two', 'three', 'four'];
foreach ($array as $value) {
  echo $value, ' ';
}

// one two three four

$array = ['one', 'two', 'three', 'four'];

foreach ($array as $value) {

echo $value, ' ';

}

// one two three four

以下の構文も準備されている。

foreach (array as val): ... endforeach;

$array = ['one', 'two', 'three', 'four'];
foreach ($array as $value):
  echo $value, ' ';
endforeach;

// one two three four

$array = ['one', 'two', 'three', 'four'];

foreach ($array as $value):

echo $value, ' ';

endforeach;

// one two three four

連想配列のキーと要素の取出し

foreach (assoc_array as key => val) {}

$assoc_array = [
  'zero' => 0,
  'one' => 1,
  2 => 2,
  3 => '三',
];

foreach ($assoc_array as $key => $val) {
  echo $key, ':', $val, ' ';
}

// zero:0 one:1 2:2 3:三

$assoc_array = [

'zero' => 0,

'one' => 1,

2 => 2,

3 => '三',

];

foreach ($assoc_array as $key => $val) {

echo $key, ':', $val, ' ';

}

// zero:0 one:1 2:2 3:三

PHPの配列は連想配列と等価なので、PythonのenumearateやRubyのeach_with_indexと同じ処理をforeachで書ける。

$array = ['zero', 'one', 'two', 'three'];

foreach ($array as $index => $val) {
  echo $index, ':', $val, ' ';
}

// 0:zero 1:one 2:two 3:three

$array = ['zero', 'one', 'two', 'three'];

foreach ($array as $index => $val) {

echo $index, ':', $val, ' ';

}

// 0:zero 1:one 2:two 3:three