summaryrefslogtreecommitdiff
path: root/app/Statement.php
diff options
context:
space:
mode:
authorGreg Roach <fisharebest@webtrees.net>2018-07-16 08:20:33 +0100
committerGreg Roach <fisharebest@webtrees.net>2018-07-16 08:20:33 +0100
commitc1010eda29c0909ed4d5d463f32d32bfefdd4dfe (patch)
treefbb656ebc014aa1295ac8e6176f41e89f94b91e7 /app/Statement.php
parent782f08d9bd2bfa06635da947ee34f8e1afd65088 (diff)
downloadwebtrees-c1010eda29c0909ed4d5d463f32d32bfefdd4dfe.tar.gz
webtrees-c1010eda29c0909ed4d5d463f32d32bfefdd4dfe.tar.bz2
webtrees-c1010eda29c0909ed4d5d463f32d32bfefdd4dfe.zip
Use PSR2 code style
Diffstat (limited to 'app/Statement.php')
-rw-r--r--app/Statement.php357
1 files changed, 184 insertions, 173 deletions
diff --git a/app/Statement.php b/app/Statement.php
index 169adec08b..8b3f8ebe1c 100644
--- a/app/Statement.php
+++ b/app/Statement.php
@@ -22,203 +22,214 @@ use stdClass;
/**
* Extend PHP's native PDOStatement class.
*/
-class Statement {
- /** @var PDOStatement A prepared statement. */
- private $pdo_statement;
+class Statement
+{
+ /** @var PDOStatement A prepared statement. */
+ private $pdo_statement;
- /** @var bool Keep track of calls to execute(), so we can do it automatically. */
- private $executed = false;
+ /** @var bool Keep track of calls to execute(), so we can do it automatically. */
+ private $executed = false;
- /**
- * Create a Statement object from a PDOStatement object.
- *
- * @param PDOStatement $pdo_statement
- */
- public function __construct(PDOStatement $pdo_statement) {
- $this->pdo_statement = $pdo_statement;
- }
+ /**
+ * Create a Statement object from a PDOStatement object.
+ *
+ * @param PDOStatement $pdo_statement
+ */
+ public function __construct(PDOStatement $pdo_statement)
+ {
+ $this->pdo_statement = $pdo_statement;
+ }
- /**
- * Execute a query
- *
- * @param array $bind_variables
- *
- * @throws \Exception
- *
- * @return Statement
- */
- public function execute($bind_variables = []) {
- if ($this->executed) {
- throw new \Exception('Statement::execute() called twice.');
- }
+ /**
+ * Execute a query
+ *
+ * @param array $bind_variables
+ *
+ * @throws \Exception
+ *
+ * @return Statement
+ */
+ public function execute($bind_variables = [])
+ {
+ if ($this->executed) {
+ throw new \Exception('Statement::execute() called twice.');
+ }
- // Parameters may be either named (e.g. :foo) or positional (e.g. ?).
- // Named parameters may take any type. Positional parameters are always strings.
- // Queries should use one format or the other.
- foreach ($bind_variables as $key => $bind_variable) {
- if (is_numeric($key)) {
- // Positional parameters are numeric (starting at 1)
- $key = 1 + $key;
- } else {
- // Named parameters are prefixed with a colon
- $key = ':' . $key;
- }
- switch (gettype($bind_variable)) {
- case 'NULL':
- $this->pdo_statement->bindValue($key, $bind_variable, PDO::PARAM_NULL);
- break;
- case 'boolean':
- $this->pdo_statement->bindValue($key, (int) $bind_variable, PDO::PARAM_INT);
- break;
- case 'integer':
- $this->pdo_statement->bindValue($key, $bind_variable, PDO::PARAM_INT);
- break;
- default:
- $this->pdo_statement->bindValue($key, $bind_variable, PDO::PARAM_STR);
- break;
- }
- }
+ // Parameters may be either named (e.g. :foo) or positional (e.g. ?).
+ // Named parameters may take any type. Positional parameters are always strings.
+ // Queries should use one format or the other.
+ foreach ($bind_variables as $key => $bind_variable) {
+ if (is_numeric($key)) {
+ // Positional parameters are numeric (starting at 1)
+ $key = 1 + $key;
+ } else {
+ // Named parameters are prefixed with a colon
+ $key = ':' . $key;
+ }
+ switch (gettype($bind_variable)) {
+ case 'NULL':
+ $this->pdo_statement->bindValue($key, $bind_variable, PDO::PARAM_NULL);
+ break;
+ case 'boolean':
+ $this->pdo_statement->bindValue($key, (int)$bind_variable, PDO::PARAM_INT);
+ break;
+ case 'integer':
+ $this->pdo_statement->bindValue($key, $bind_variable, PDO::PARAM_INT);
+ break;
+ default:
+ $this->pdo_statement->bindValue($key, $bind_variable, PDO::PARAM_STR);
+ break;
+ }
+ }
- $this->pdo_statement->execute();
+ $this->pdo_statement->execute();
- // If it was a SELECT statement, we cannot run it again.
- $this->executed = strpos($this->pdo_statement->queryString, 'SELECT') === 0;
+ // If it was a SELECT statement, we cannot run it again.
+ $this->executed = strpos($this->pdo_statement->queryString, 'SELECT') === 0;
- return $this;
- }
+ return $this;
+ }
- /**
- * Close the cursor, and mark it as not-executed, so we can execute
- * it again (perhaps with different parameters).
- */
- public function closeCursor() {
- $this->pdo_statement->closeCursor();
- $this->executed = false;
- }
+ /**
+ * Close the cursor, and mark it as not-executed, so we can execute
+ * it again (perhaps with different parameters).
+ */
+ public function closeCursor()
+ {
+ $this->pdo_statement->closeCursor();
+ $this->executed = false;
+ }
- /**
- * Fetch the next row from the cursor.
- *
- * Execute the query, if necessary. Typically when there are no parameters.
- *
- * @param int $fetch_style
- *
- * @return stdClass|array|false
- */
- public function fetch($fetch_style = PDO::FETCH_OBJ) {
- if (!$this->executed) {
- $this->execute();
- }
+ /**
+ * Fetch the next row from the cursor.
+ *
+ * Execute the query, if necessary. Typically when there are no parameters.
+ *
+ * @param int $fetch_style
+ *
+ * @return stdClass|array|false
+ */
+ public function fetch($fetch_style = PDO::FETCH_OBJ)
+ {
+ if (!$this->executed) {
+ $this->execute();
+ }
- return $this->pdo_statement->fetch($fetch_style);
- }
+ return $this->pdo_statement->fetch($fetch_style);
+ }
- /**
- * Fetch all rows from the cursor, and close it.
- *
- * Execute the query, if necessary. Typically when there are no parameters.
- *
- * @param int $fetch_style
- *
- * @return stdClass[]|string[][]
- */
- public function fetchAll($fetch_style = PDO::FETCH_OBJ) {
- if (!$this->executed) {
- $this->execute();
- }
+ /**
+ * Fetch all rows from the cursor, and close it.
+ *
+ * Execute the query, if necessary. Typically when there are no parameters.
+ *
+ * @param int $fetch_style
+ *
+ * @return stdClass[]|string[][]
+ */
+ public function fetchAll($fetch_style = PDO::FETCH_OBJ)
+ {
+ if (!$this->executed) {
+ $this->execute();
+ }
- $rows = $this->pdo_statement->fetchAll($fetch_style);
- $this->closeCursor();
+ $rows = $this->pdo_statement->fetchAll($fetch_style);
+ $this->closeCursor();
- return $rows;
- }
+ return $rows;
+ }
- /**
- * Fetch one row, and close the cursor. e.g. SELECT * FROM foo WHERE pk=bar
- *
- * Execute the query, if necessary. Typically when there are no parameters.
- *
- * @param int $fetch_style
- *
- * @return stdClass|array|null
- */
- public function fetchOneRow($fetch_style = PDO::FETCH_OBJ) {
- if (!$this->executed) {
- $this->execute();
- }
+ /**
+ * Fetch one row, and close the cursor. e.g. SELECT * FROM foo WHERE pk=bar
+ *
+ * Execute the query, if necessary. Typically when there are no parameters.
+ *
+ * @param int $fetch_style
+ *
+ * @return stdClass|array|null
+ */
+ public function fetchOneRow($fetch_style = PDO::FETCH_OBJ)
+ {
+ if (!$this->executed) {
+ $this->execute();
+ }
- $row = $this->pdo_statement->fetch($fetch_style);
- $this->closeCursor();
+ $row = $this->pdo_statement->fetch($fetch_style);
+ $this->closeCursor();
- return $row === false ? null : $row;
- }
+ return $row === false ? null : $row;
+ }
- /**
- * Fetch one value and close the cursor. e.g. SELECT MAX(foo) FROM bar
- *
- * Execute the query, if necessary. Typically when there are no parameters.
- *
- * @return string|null
- */
- public function fetchOne() {
- if (!$this->executed) {
- $this->execute();
- }
+ /**
+ * Fetch one value and close the cursor. e.g. SELECT MAX(foo) FROM bar
+ *
+ * Execute the query, if necessary. Typically when there are no parameters.
+ *
+ * @return string|null
+ */
+ public function fetchOne()
+ {
+ if (!$this->executed) {
+ $this->execute();
+ }
- $value = $this->pdo_statement->fetchColumn();
- $this->closeCursor();
+ $value = $this->pdo_statement->fetchColumn();
+ $this->closeCursor();
- return $value === false ? null : $value;
- }
+ return $value === false ? null : $value;
+ }
- /**
- * Fetch two columns, and return an associative array of col1=>col2
- *
- * Execute the query, if necessary. Typically when there are no parameters.
- *
- * @return string[]
- */
- public function fetchAssoc() {
- if (!$this->executed) {
- $this->execute();
- }
+ /**
+ * Fetch two columns, and return an associative array of col1=>col2
+ *
+ * Execute the query, if necessary. Typically when there are no parameters.
+ *
+ * @return string[]
+ */
+ public function fetchAssoc()
+ {
+ if (!$this->executed) {
+ $this->execute();
+ }
- $rows = [];
- while ($row = $this->pdo_statement->fetch(PDO::FETCH_NUM)) {
- $rows[$row[0]] = $row[1];
- }
- $this->closeCursor();
+ $rows = [];
+ while ($row = $this->pdo_statement->fetch(PDO::FETCH_NUM)) {
+ $rows[$row[0]] = $row[1];
+ }
+ $this->closeCursor();
- return $rows;
- }
+ return $rows;
+ }
- /**
- * Fetch all the first column, as an array.
- *
- * Execute the query, if necessary. Typically when there are no parameters.
- *
- * @return string[]
- */
- public function fetchOneColumn() {
- if (!$this->executed) {
- $this->execute();
- }
+ /**
+ * Fetch all the first column, as an array.
+ *
+ * Execute the query, if necessary. Typically when there are no parameters.
+ *
+ * @return string[]
+ */
+ public function fetchOneColumn()
+ {
+ if (!$this->executed) {
+ $this->execute();
+ }
- $list = [];
- while ($row = $this->pdo_statement->fetch(PDO::FETCH_NUM)) {
- $list[] = $row[0];
- }
- $this->closeCursor();
+ $list = [];
+ while ($row = $this->pdo_statement->fetch(PDO::FETCH_NUM)) {
+ $list[] = $row[0];
+ }
+ $this->closeCursor();
- return $list;
- }
+ return $list;
+ }
- /**
- * How many rows were affected by this statement.
- *
- * @return int
- */
- public function rowCount() {
- return $this->pdo_statement->rowCount();
- }
+ /**
+ * How many rows were affected by this statement.
+ *
+ * @return int
+ */
+ public function rowCount()
+ {
+ return $this->pdo_statement->rowCount();
+ }
}