gamernetwork / yolk-database

src/BaseConnection.php

Doc Comments +7 added lines, -1 removed lines

@@ -389,7 +389,7 @@ 
 
 	/**
 	 * Bind named and positional parameters to a PDOStatement.
-	 * @param  PDOStatement $statement
+	 * @param  \PDOStatement $statement
 	 * @param  array        $params
 	 * @return void
 	 */
@@ -434,6 +434,12 @@ 
 
 	}
 
+	/**
+	 * @param string $option
+	 * @param string $default
+	 *
+	 * @return string
+	 */
 	protected function getOption( $option, $default = null ) {
 		return isset($this->dsn->options[$option]) ? $this->dsn->options[$option] : $default;
 	}

Unused Use Statements -1 removed lines

@@ -15,7 +15,6 @@
 use yolk\contracts\profiler\ProfilerAwareTrait;
 use yolk\contracts\profiler\ProfilerAware;
 use yolk\contracts\support\Dumpable;
-
 use yolk\database\exceptions\DatabaseException;
 use yolk\database\exceptions\ConnectionException;
 use yolk\database\exceptions\NotConnectedException;

Indentation +4 added lines, -4 removed lines

@@ -346,15 +346,15 @@
 
 		$name = trim($name);
 
-        if( $name == '*' )
-            return $name;
+		if( $name == '*' )
+			return $name;
 
 		// ANSI-SQL (everything else) says to use double quotes to quote identifiers
-        $char = '"';
+		$char = '"';
 
 		// MySQL uses backticks cos it's special
 		if( $this->dsn->isMySQL() )
-        	$char = '`';
+			$char = '`';
 
 		return $char. $name. $char;
 

Upper-Lower-Casing +1 added lines, -1 removed lines

@@ -62,7 +62,7 @@
 
 		// check the PDO driver is available
 		elseif( !in_array($this->dsn->type, \PDO::getAvailableDrivers()) )
-			throw new DatabaseException("The {$this->dsn->type} PDO driver is not currently installed");
+			throw new DatabaseException("the {$this->dsn->type} PDO driver is not currently installed");
 
 	}
 

Spacing +5 added lines, -5 removed lines

@@ -81,7 +81,7 @@ 
 			);
 
 			$this->pdo->setAttribute(\PDO::ATTR_DEFAULT_FETCH_MODE, \PDO::FETCH_ASSOC);
-			$this->pdo->setAttribute(\PDO::ATTR_ERRMODE, \PDO::ERRMODE_EXCEPTION);           // always use exceptions
+			$this->pdo->setAttribute(\PDO::ATTR_ERRMODE, \PDO::ERRMODE_EXCEPTION); // always use exceptions
 
 			$this->setCharacterSet(
 				$this->getOption('charset', 'UTF8'),
@@ -128,7 +128,7 @@ 
 
 	public function prepare( $statement ) {
 
-		if( ! $statement instanceof \PDOStatement  ) {
+		if( !$statement instanceof \PDOStatement ) {
 
 			$this->connect();
 
@@ -356,7 +356,7 @@ 
 		if( $this->dsn->isMySQL() )
         	$char = '`';
 
-		return $char. $name. $char;
+		return $char.$name.$char;
 
 	}
 
@@ -450,10 +450,10 @@ 
 		if( !$charset ) 
 			throw new DatabaseException('No character set specified');
 
-		$sql = 'SET NAMES '. $this->pdo->quote($charset);
+		$sql = 'SET NAMES '.$this->pdo->quote($charset);
 
 		if( $collation )
-			$sql .= ' COLLATE '. $this->pdo->quote($collation);
+			$sql .= ' COLLATE '.$this->pdo->quote($collation);
 
 		$this->pdo->exec($sql);
 

src/DSN.php

Doc Comments +4 added lines, -2 removed lines

@@ -32,6 +32,9 @@ 
 
 	protected $config;
 
+	/**
+	 * @param string $config
+	 */
 	public static function fromString( $config ) {
 
 		// parse the string into some components
@@ -85,7 +88,6 @@ 
 	 * pass - user's password
 	 * db - name of the database schema to connect to
 	 * options - an array of database specific options
-	 * @param array $dsn
 	 */
 	public function __construct( array $config ) {
 
@@ -120,7 +122,7 @@ 
 	/**
 	 * Dynamic property access.
 	 * @param  string $key
-	 * @return mixed
+	 * @return string|null
 	 */
 	public function __get( $key ) {
 		return isset($this->config[$key]) ? $this->config[$key] : null;

Spacing +6 added lines, -6 removed lines

@@ -39,7 +39,7 @@ 
 
 		// no point continuing if it went wrong
 		if( !$parts || empty($parts['scheme']) )
-			throw new ConfigurationException('Invalid DSN string: '. $config);
+			throw new ConfigurationException('Invalid DSN string: '.$config);
 
 		// use a closure to save loads of duplicate logic
 		$select = function( $k, array $arr ) {
@@ -141,22 +141,22 @@ 
 	 */
 	public function toString() {
 
-		$str = $this->config['type']. '://';
+		$str = $this->config['type'].'://';
 
 		if( $this->config['user'] ) {
 			$str .= $this->config['user'];
 			if( $this->config['pass'] )
-				$str .= ':'. $this->config['pass'];
+				$str .= ':'.$this->config['pass'];
 			$str .= '@';
 		}
 
 		if( $this->config['host'] ) {
 			$str .= $this->config['host'];
 			if( $this->config['port'] )
-				$str .= ':'. $this->config['port'];
+				$str .= ':'.$this->config['port'];
 		}
 
-		$str .= '/'. $this->config['db'];
+		$str .= '/'.$this->config['db'];
 
 		if( $this->config['options'] ) {
 			$str .= '?';
@@ -203,7 +203,7 @@ 
 				break;
 
 			default:
-				throw new ConfigurationException('Invalid database type: '. $config['type']);
+				throw new ConfigurationException('Invalid database type: '.$config['type']);
 
 		}
 

src/query/BaseQuery.php

Doc Comments +8 added lines

@@ -92,6 +92,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $operator
+	 */
 	public function where( $column, $operator, $value = null ) {
 
 		// shortcut for equals
@@ -302,6 +305,11 @@ 
 
 	}
 
+	/**
+	 * @param string $operator
+	 *
+	 * @return string
+	 */
 	protected function getParameterName( $column, $operator ) {
 
 		$suffixes = [

Spacing +4 added lines, -4 removed lines

@@ -209,7 +209,7 @@ 
 		foreach( $this->where as $i => $clause ) {
 			if( is_array($clause) )
 				$clause = implode(' ', $clause);
-			$sql[] = ($i ? 'AND ' : 'WHERE '). $clause;
+			$sql[] = ($i ? 'AND ' : 'WHERE ').$clause;
 		}
 
 		return $sql;
@@ -223,7 +223,7 @@ 
 		if( $this->order ) {
 			$order = 'ORDER BY ';
 			foreach( $this->order as $column => $dir ) {
-				$order .= $column. ' '. $dir. ', ';
+				$order .= $column.' '.$dir.', ';
 			}
 			$sql[] = trim($order, ', ');
 		}
@@ -262,7 +262,7 @@ 
 		if( strpos($spec, '(') !== false )
 			return $spec;
 
-		foreach( [' AS ', ' ', '.'] as $sep) {
+		foreach( [' AS ', ' ', '.'] as $sep ) {
 			if( $pos = strripos($spec, $sep) ) {
 				return
 					$this->quoteIdentifier(substr($spec, 0, $pos)).
@@ -323,7 +323,7 @@ 
 			$name = substr($name, $pos + 1);
 
 		if( isset($suffixes[$operator]) )
-			$name .= '_'. $suffixes[$operator];
+			$name .= '_'.$suffixes[$operator];
 
 		return $name;
 

src/adapters/MySQLConnection.php

Braces +2 added lines, -2 removed lines

@@ -15,9 +15,9 @@
 use yolk\database\DSN;

 use yolk\database\exceptions\ConfigurationException;

 

-class MySQLConnection extends BaseConnection {

+class MySQLConnection extends BaseConnection {
 

-	public function __construct( DSN $dsn ) {

+	public function __construct( DSN $dsn ) {
 

 		if( !$dsn->isMySQL() )

 			throw new ConfigurationException(sprintf("\\%s expects a DSN of type '%s', '%s' given", __CLASS__, DSN::TYPE_MYSQL, $dsn->type));

src/adapters/PgSQLConnection.php

Braces +2 added lines, -2 removed lines

@@ -15,9 +15,9 @@
 use yolk\database\DSN;

 use yolk\database\exceptions\ConfigurationException;

 

-class PgSQLConnection extends BaseConnection {

+class PgSQLConnection extends BaseConnection {
 

-	public function __construct( DSN $dsn ) {

+	public function __construct( DSN $dsn ) {
 

 		if( !$dsn->isPgSQL() )

 			throw new ConfigurationException(sprintf("\\%s expects a DSN of type '%s', '%s' given", __CLASS__, DSN::TYPE_PGSQL, $dsn->type));

src/adapters/SQLiteConnection.php

Braces +2 added lines, -2 removed lines

@@ -15,9 +15,9 @@
 use yolk\database\DSN;

 use yolk\database\exceptions\ConfigurationException;

 

-class SQLiteConnection extends BaseConnection {

+class SQLiteConnection extends BaseConnection {
 

-	public function __construct( DSN $dsn ) {

+	public function __construct( DSN $dsn ) {
 

 		if( !$dsn->isSQLite() )

 			throw new ConfigurationException(sprintf("\\%s expects a DSN of type '%s', '%s' given", __CLASS__, DSN::TYPE_SQLITE, $dsn->type));

src/exceptions/ConfigurationException.php

Braces +2 added lines, -2 removed lines

@@ -14,9 +14,9 @@
 /**

  * Thrown if a database configuration is invalid.

  */

-class ConfigurationException extends DatabaseException {

+class ConfigurationException extends DatabaseException {
 

-	public function __construct( $message = 'The specified database configuration is invalid', $code = 0, \Exception $previous = null ) {

+	public function __construct( $message = 'The specified database configuration is invalid', $code = 0, \Exception $previous = null ) {
 		parent::__construct($message, $code, $previous);

 	}

 

src/exceptions/ConnectionException.php

Braces +2 added lines, -2 removed lines

@@ -14,9 +14,9 @@
 /**

  * Thrown if a database connection could not be established.

  */

-class ConnectionException extends DatabaseException {

+class ConnectionException extends DatabaseException {
 

-	public function __construct( $message = 'An error occured attempting to connect to the database', $code = 0, \Exception $previous = null ) {

+	public function __construct( $message = 'An error occured attempting to connect to the database', $code = 0, \Exception $previous = null ) {
 		parent::__construct($message, $code, $previous);

 	}

 

src/exceptions/DatabaseException.php

Braces +2 added lines, -2 removed lines

@@ -14,7 +14,7 @@ 
 /**

  * Base database exception.

  */

-class DatabaseException extends \Exception {

+class DatabaseException extends \Exception {
 

 	/**

 	 * https://bugs.php.net/bug.php?id=51742

@@ -22,7 +22,7 @@ 
 	 */

 	protected $code;

 

-	public function __construct( $message = 'An unknown database error occured', $code = 0, \Exception $previous = null ) {

+	public function __construct( $message = 'An unknown database error occured', $code = 0, \Exception $previous = null ) {
 		parent::__construct($message, (int) $code, $previous);

 		$this->code = $code;

 	}