PHP Data Objects

はじめに
インストール/設定
定義済み定数
接続、および接続の管理
トランザクションおよび自動コミット
プリペアドステートメントおよびストアドプロシージャ
エラーおよびエラー処理
ラージオブジェクト (LOB)
PDO — PDO クラス
- PDO::beginTransaction — トランザクションを開始する
- PDO::commit — トランザクションをコミットする
- PDO::__construct — データベースへの接続を表す PDO インスタンスを生成する
- PDO::errorCode — データベースハンドラにおける直近の操作に関連する SQLSTATE を取得する
- PDO::errorInfo — データベースハンドラにおける直近の操作に関連する拡張エラー情報を取得する
- PDO::exec — SQL ステートメントを実行し、作用した行数を返す
- PDO::getAttribute — データベース接続の属性を取得する
- PDO::getAvailableDrivers — 利用可能な PDO ドライバの配列を返す
- PDO::inTransaction — トランザクション内かどうかを調べる
- PDO::lastInsertId — 最後に挿入された行の ID あるいはシーケンスの値を返す
- PDO::prepare — 文を実行する準備を行い、文オブジェクトを返す
- PDO::query — プレースホルダを指定せずに、SQL ステートメントを準備して実行する
- PDO::quote — クエリ用の文字列をクオートする
- PDO::rollBack — トランザクションをロールバックする
- PDO::setAttribute — 属性を設定する
PDOStatement — PDOStatement クラス
- PDOStatement::bindColumn — カラムを PHP 変数にバインドする
- PDOStatement::bindParam — 指定された変数名にパラメータをバインドする
- PDOStatement::bindValue — 値をパラメータにバインドする
- PDOStatement::closeCursor — カーソルを閉じてステートメントを再実行できるようにする
- PDOStatement::columnCount — 結果セット中のカラム数を返す
- PDOStatement::debugDumpParams — SQL プリペアドコマンドを出力する
- PDOStatement::errorCode — 文ハンドラにおける直近の操作に関連する SQLSTATE を取得する
- PDOStatement::errorInfo — 文ハンドラにおける直近の操作に関連する拡張エラー情報を取得する
- PDOStatement::execute — プリペアドステートメントを実行する
- PDOStatement::fetch — 結果セットから次の行を取得する
- PDOStatement::fetchAll — 結果セットから、残っている行を取得する
- PDOStatement::fetchColumn — 結果セットの次行から単一カラムを返す
- PDOStatement::fetchObject — 次の行を取得し、それをオブジェクトとして返す
- PDOStatement::getAttribute — 文の属性を取得する
- PDOStatement::getColumnMeta — 結果セットのカラムに対するメタデータを返す
- PDOStatement::getIterator — 結果セットのイテレータを取得する
- PDOStatement::nextRowset — 複数の行セットを返す文ハンドラで次の行セットに移動する
- PDOStatement::rowCount — 直近の SQL ステートメントによって作用した行数を返す
- PDOStatement::setAttribute — 文の属性を設定する
- PDOStatement::setFetchMode — この文に対するデフォルトのフェッチモードを設定する
PDOException — PDOException クラス
PDORow — PDORow クラス
PDO ドライバ
- CUBRID (PDO) — CUBRID 関数 (PDO_CUBRID)
- MS SQL Server (PDO) — Microsoft SQL Server および Sybase 関数 (PDO_DBLIB)
- Firebird (PDO) — Firebird 関数 (PDO_FIREBIRD)
- IBM (PDO) — IBM 関数 (PDO_IBM)
- Informix (PDO) — Informix 関数 (PDO_INFORMIX)
- MySQL (PDO) — MySQL 関数 (PDO_MYSQL)
- MS SQL Server (PDO) — Microsoft SQL Server 関数 (PDO_SQLSRV)
- Oracle (PDO) — Oracle 関数 (PDO_OCI)
- ODBC and DB2 (PDO) — ODBC および DB2 関数 (PDO_ODBC)
- PostgreSQL (PDO) — PostgreSQL 関数 (PDO_PGSQL)
- SQLite (PDO) — SQLite 関数 (PDO_SQLITE)

PDO クラス

はじめに

PHP とデータベースサーバーの間の接続を表します。

クラス概要

PDO

/* 定数 */

public const int PDO::PARAM_NULL;

public const int PDO::PARAM_BOOL = 5;

public const int PDO::PARAM_INT = 1;

public const int PDO::PARAM_STR = 2;

public const int PDO::PARAM_LOB = 3;

public const int PDO::PARAM_STMT = 4;

public const int PDO::PARAM_INPUT_OUTPUT;

public const int PDO::PARAM_STR_NATL;

public const int PDO::PARAM_STR_CHAR;

public const int PDO::PARAM_EVT_ALLOC;

public const int PDO::PARAM_EVT_FREE;

public const int PDO::PARAM_EVT_EXEC_PRE;

public const int PDO::PARAM_EVT_EXEC_POST;

public const int PDO::PARAM_EVT_FETCH_PRE;

public const int PDO::PARAM_EVT_FETCH_POST;

public const int PDO::PARAM_EVT_NORMALIZE;

public const int PDO::FETCH_DEFAULT;

public const int PDO::FETCH_LAZY;

public const int PDO::FETCH_ASSOC;

public const int PDO::FETCH_NUM;

public const int PDO::FETCH_BOTH;

public const int PDO::FETCH_OBJ;

public const int PDO::FETCH_BOUND;

public const int PDO::FETCH_COLUMN;

public const int PDO::FETCH_CLASS;

public const int PDO::FETCH_INTO;

public const int PDO::FETCH_FUNC;

public const int PDO::FETCH_GROUP;

public const int PDO::FETCH_UNIQUE;

public const int PDO::FETCH_KEY_PAIR;

public const int PDO::FETCH_CLASSTYPE;

public const int PDO::FETCH_SERIALIZE;

public const int PDO::FETCH_PROPS_LATE;

public const int PDO::FETCH_NAMED;

public const int PDO::ATTR_AUTOCOMMIT;

public const int PDO::ATTR_PREFETCH;

public const int PDO::ATTR_TIMEOUT;

public const int PDO::ATTR_ERRMODE;

public const int PDO::ATTR_SERVER_VERSION;

public const int PDO::ATTR_CLIENT_VERSION;

public const int PDO::ATTR_SERVER_INFO;

public const int PDO::ATTR_CONNECTION_STATUS;

public const int PDO::ATTR_CASE;

public const int PDO::ATTR_CURSOR_NAME;

public const int PDO::ATTR_CURSOR;

public const int PDO::ATTR_ORACLE_NULLS;

public const int PDO::ATTR_PERSISTENT;

public const int PDO::ATTR_STATEMENT_CLASS;

public const int PDO::ATTR_FETCH_TABLE_NAMES;

public const int PDO::ATTR_FETCH_CATALOG_NAMES;

public const int PDO::ATTR_DRIVER_NAME;

public const int PDO::ATTR_STRINGIFY_FETCHES;

public const int PDO::ATTR_MAX_COLUMN_LEN;

public const int PDO::ATTR_EMULATE_PREPARES;

public const int PDO::ATTR_DEFAULT_FETCH_MODE;

public const int PDO::ATTR_DEFAULT_STR_PARAM;

public const int PDO::ERRMODE_SILENT;

public const int PDO::ERRMODE_WARNING;

public const int PDO::ERRMODE_EXCEPTION;

public const int PDO::CASE_NATURAL;

public const int PDO::CASE_LOWER;

public const int PDO::CASE_UPPER;

public const int PDO::NULL_NATURAL;

public const int PDO::NULL_EMPTY_STRING;

public const int PDO::NULL_TO_STRING;

public const string PDO::ERR_NONE;

public const int PDO::FETCH_ORI_NEXT;

public const int PDO::FETCH_ORI_PRIOR;

public const int PDO::FETCH_ORI_FIRST;

public const int PDO::FETCH_ORI_LAST;

public const int PDO::FETCH_ORI_ABS;

public const int PDO::FETCH_ORI_REL;

public const int PDO::CURSOR_FWDONLY;

public const int PDO::CURSOR_SCROLL;

/* メソッド */

public __construct(
    string $dsn,
    stringnull $username = null,
    stringnull $password = null,
    arraynull $options = null
)

public bool beginTransaction()

public bool commit()

public stringnull errorCode()

public array errorInfo()

public intfalse exec(string $statement)

public mixed getAttribute(int $attribute)

public static array getAvailableDrivers()

public bool inTransaction()

public stringfalse lastInsertId(stringnull $name = null)

public PDOStatementfalse prepare(string $query, array $options = [])

public PDOStatementfalse query(string $query, intnull $fetchMode = null)

public PDOStatementfalse query(string $query, intnull $fetchMode = PDO::FETCH_COLUMN, int $colno)

public PDOStatementfalse query(
    string $query,
    intnull $fetchMode = PDO::FETCH_CLASS,
    string $classname,
    array $constructorArgs
)

public PDOStatementfalse query(string $query, intnull $fetchMode = PDO::FETCH_INTO, object $object)

public stringfalse quote(string $string, int $type = PDO::PARAM_STR)

public bool rollBack()

public bool setAttribute(int $attribute, mixed $value)

PDOStatement クラス

はじめに

プリペアドステートメントを表します。ステートメント実行後は関連する結果セットを表します。

クラス概要

PDOStatement

implements IteratorAggregate

/* プロパティ */

public string $queryString;

/* メソッド */

public bool bindColumn(
    stringint $column,
    mixed &$var,
    int $type = PDO::PARAM_STR,
    int $maxLength = 0,
    mixed $driverOptions = null
)

public bool bindParam(
    stringint $param,
    mixed &$var,
    int $type = PDO::PARAM_STR,
    int $maxLength = 0,
    mixed $driverOptions = null
)

public bool bindValue(stringint $param, mixed $value, int $type = PDO::PARAM_STR)

public bool closeCursor()

public int columnCount()

public boolnull debugDumpParams()

public stringnull errorCode()

public array errorInfo()

public bool execute(arraynull $params = null)

public mixed fetch(int $mode = PDO::FETCH_DEFAULT, int $cursorOrientation = PDO::FETCH_ORI_NEXT, int $cursorOffset = 0)

public array fetchAll(int $mode = PDO::FETCH_DEFAULT)

public array fetchAll(int $mode = PDO::FETCH_COLUMN, int $column)

public array fetchAll(int $mode = PDO::FETCH_CLASS, string $class, arraynull $constructorArgs)

public array fetchAll(int $mode = PDO::FETCH_FUNC, callable $callback)

public mixed fetchColumn(int $column = 0)

public objectfalse fetchObject(stringnull $class = "stdClass", array $constructorArgs = [])

public mixed getAttribute(int $name)

public arrayfalse getColumnMeta(int $column)

public Iterator getIterator()

public bool nextRowset()

public int rowCount()

public bool setAttribute(int $attribute, mixed $value)

public bool setFetchMode(int $mode)

public bool setFetchMode(int $mode = PDO::FETCH_COLUMN, int $colno)

public bool setFetchMode(int $mode = PDO::FETCH_CLASS, string $class, arraynull $constructorArgs = null)

public bool setFetchMode(int $mode = PDO::FETCH_INTO, object $object)

プロパティ

queryString: 使ったクエリ文字列。

変更履歴

バージョン	説明
8.0.0	PDOStatement は、 Traversable ではなく、 IteratorAggregate を実装するようになりました。

PDOException クラス

はじめに

PDO が発するエラーを表します。あなた自身が書いたコードから PDOException をスローしてはいけません。 PHP の例外についての詳細な情報は、例外を参照ください。

クラス概要

PDOException

extends RuntimeException

/* プロパティ */

protected intstring $code;

public arraynull $errorInfo = null;

/* 継承したプロパティ */

protected string $message = "";

private string $string = "";

protected int $code;

protected string $file = "";

protected int $line;

private array $trace = [];

private Throwablenull $previous = null;

/* 継承したメソッド */

public Exception::__construct(string $message = "", int $code = 0, Throwablenull $previous = null)

final public string Exception::getMessage()

final public Throwablenull Exception::getPrevious()

final public int Exception::getCode()

final public string Exception::getFile()

final public int Exception::getLine()

final public array Exception::getTrace()

final public string Exception::getTraceAsString()

public string Exception::__toString()

private void Exception::__clone()

プロパティ

errorInfo: PDO::errorInfo あるいは PDOStatement::errorInfo に対応します。
code: SQLSTATE エラーコード。 Exception::getCode でアクセスします。

PDORow クラス

はじめに

フェッチモード PDO_FETCH_LAZY を使って PDOStatement::fetch をコールした場合に返される結果セットの行を表します。

このクラスのオブジェクトは、インスタンス化できませんし、シリアライズもできません。デフォルトの queryString プロパティに加えて PDORow オブジェクトはアクセスした結果セットに存在するカラム名に対応するプロパティを作成します。

PDORow は、 PDO::FETCH_OBJ と PDO::FETCH_BOTH のモードを両方使ったかのように、返されるデータにアクセスできます。つまり、返されるデータはオブジェクトのプロパティのようにアクセスできますし、カラム名やカラムのオフセット番号でインデックスされた配列としてもアクセスできます。

プロパティが未定義の場合は、警告を発生させることなく null を返します。

クラス概要

final PDORow

/* プロパティ */

public string $queryString;

プロパティ

queryString: PDORow オブジェクトを返した PDOStatement が使うクエリストリング

エラー / 例外

任意のプロパティに書き込んだり、 unset を行おうとすると Error がスローされます。