Rozbo / puck

core/Model.php

Doc Comments +8 added lines, -9 removed lines

@@ -76,7 +76,6 @@ 
     private $_with = Array();
 
     /**
-     * @param array $data Data to preload on object creation
      */
     public function __construct() {
         $this->db = app('db')->connect($this->dbConn);
@@ -207,7 +206,7 @@ 
     /**
      * Save or Update object
      *
-     * @return mixed insert id or false in case of failure
+     * @return boolean insert id or false in case of failure
      */
     public function save($data = null) {
         if ($this->isNew)
@@ -216,7 +215,7 @@ 
     }
 
     /**
-     * @return mixed insert id or false in case of failure
+     * @return boolean insert id or false in case of failure
      */
     public function insert() {
         if (!empty ($this->timestamps) && in_array("createdAt", $this->timestamps))
@@ -362,7 +361,7 @@ 
     /**
      * Delete method. Works only if object primaryKey is defined
      *
-     * @return boolean Indicates success. 0 or 1.
+     * @return null|boolean Indicates success. 0 or 1.
      */
     public function delete() {
         if (empty ($this->data[$this->primaryKey]))
@@ -522,7 +521,7 @@ 
      * @param string $joinType SQL join type: LEFT, RIGHT,  INNER, OUTER
      * @param string $primaryKey SQL join On Second primaryKey
      *
-     * @return dbObject
+     * @return Model
      */
     private function join($objectName, $key = null, $joinType = 'LEFT', $primaryKey = null) {
         $joinObj = new $objectName;
@@ -571,7 +570,7 @@ 
     /**
      * Helper function to create dbObject with Json return type
      *
-     * @return dbObject
+     * @return Model
      */
     private function JsonBuilder() {
         $this->returnType = 'Json';
@@ -585,7 +584,7 @@ 
     /**
      * Helper function to create dbObject with Array return type
      *
-     * @return dbObject
+     * @return Model
      */
     private function ArrayBuilder() {
         $this->returnType = 'Array';
@@ -596,7 +595,7 @@ 
      * Helper function to create dbObject with Object return type.
      * Added for consistency. Works same way as new $objname ()
      *
-     * @return dbObject
+     * @return Model
      */
     private function ObjectBuilder() {
         $this->returnType = 'Object';
@@ -651,7 +650,7 @@ 
      * @access public
      * @param string $objectName Object Name
      *
-     * @return dbObject
+     * @return null|Model
      */
     private function with($objectName) {
         if (!property_exists($this, 'relations') && !isset ($this->relations[$name]))

core/Mysql.php

Doc Comments +28 added lines, -28 removed lines

@@ -255,7 +255,7 @@ 
      *
      * @param string $subQueryAlias
      *
-     * @return MysqliDb
+     * @return Mysql
      */
     public static function subQuery($subQueryAlias = "") {
         return new self(array('host' => $subQueryAlias, 'isSubQuery' => true));
@@ -277,7 +277,7 @@ 
     /**
      * Helper function to create dbObject with JSON return type
      *
-     * @return MysqliDb
+     * @return Mysql
      */
     public function jsonBuilder() {
         $this->returnType = 'json';
@@ -287,7 +287,7 @@ 
     /**
      * Helper function to create dbObject with object return type.
      *
-     * @return MysqliDb
+     * @return Mysql
      */
     public function objectBuilder() {
         $this->returnType = 'object';
@@ -350,7 +350,7 @@ 
      * Method attempts to prepare the SQL query
      * and throws an error if there was a problem.
      *
-     * @return mysqli_stmt
+     * @return \mysqli_stmt
      */
     protected function _prepareQuery() {
         if (!$stmt = $this->mysqli()->prepare($this->_query)) {
@@ -539,7 +539,7 @@ 
      * This helper method takes care of prepared statements' "bind_result method
      * , when the number of variables to pass is unknown.
      *
-     * @param mysqli_stmt $stmt Equal to the prepared statement object.
+     * @param \mysqli_stmt $stmt Equal to the prepared statement object.
      *
      * @return array The results of the SQL fetch.
      */
@@ -702,7 +702,7 @@ 
      *                               or only $count
      * @param array $tableData Should contain an array of data for updating the database.
      *
-     * @return mysqli_stmt Returns the $stmt object.
+     * @return null|\mysqli_stmt Returns the $stmt object.
      */
     protected function _buildQuery($numRows = null, $tableData = null) {
         // $this->_buildJoinOld();
@@ -1211,7 +1211,7 @@ 
      *
      * @param string $tableName The name of the database table to work with.
      *
-     * @return array Contains the returned rows from the select query.
+     * @return boolean Contains the returned rows from the select query.
      */
     public function has($tableName) {
         $this->getOne($tableName, '1');
@@ -1311,7 +1311,7 @@ 
      * @param int|array $numRows Array to define SQL limit in format Array ($count, $offset)
      *                               or only $count
      *
-     * @return bool Indicates success. 0 or 1.
+     * @return null|boolean Indicates success. 0 or 1.
      */
     public function delete($numRows = null) {
         if ($this->isSubQuery) {
@@ -1342,7 +1342,7 @@ 
      * @param array $updateColumns Variable with values
      * @param string $lastInsertId Variable value
      *
-     * @return MysqliDb
+     * @return Mysql
      */
     public function onDuplicate($updateColumns, $lastInsertId = null) {
         $this->_lastInsertId = $lastInsertId;
@@ -1359,7 +1359,7 @@ 
      * @param mixed $whereValue The value of the database field.
      * @param string $operator Comparison operator. Default is =
      *
-     * @return MysqliDb
+     * @return Mysql
      */
     public function orWhere($whereProp, $whereValue = 'DBNULL', $operator = '=') {
         return $this->where($whereProp, $whereValue, $operator, 'OR');
@@ -1375,7 +1375,7 @@ 
      * @param string $operator Comparison operator. Default is =
      * @param string $cond Condition of where statement (OR, AND)
      *
-     * @return MysqliDb
+     * @return Mysql
      */
     public function where($whereProp, $whereValue = 'DBNULL', $operator = '=', $cond = 'AND') {
         // forkaround for an old operation api
@@ -1401,7 +1401,7 @@ 
      * @param mixed $havingValue The value of the database field.
      * @param string $operator Comparison operator. Default is =
      *
-     * @return MysqliDb
+     * @return Mysql
      */
     public function orHaving($havingProp, $havingValue = null, $operator = null) {
         return $this->having($havingProp, $havingValue, $operator, 'OR');
@@ -1416,7 +1416,7 @@ 
      * @param mixed $havingValue The value of the database field.
      * @param string $operator Comparison operator. Default is =
      *
-     * @return MysqliDb
+     * @return Mysql
      */
 
     public function having($havingProp, $havingValue = 'DBNULL', $operator = '=', $cond = 'AND') {
@@ -1444,7 +1444,7 @@ 
      * @param string $joinType 'LEFT', 'INNER' etc.
      *
      * @throws Exception
-     * @return MysqliDb
+     * @return Mysql
      */
     public function join($joinTable, $joinCondition, $joinType = '') {
         $allowedTypes = array('LEFT', 'RIGHT', 'OUTER', 'INNER', 'LEFT OUTER', 'RIGHT OUTER');
@@ -1529,7 +1529,7 @@ 
      * This method does not escape strings by default so make sure you'll never use it in production.
      *
      * @author Jonas Barascu
-     * @param [[Type]] $query [[Description]]
+     * @param string $query [[Description]]
      */
     private function queryUnprepared($query) {
         // Execute query
@@ -1603,11 +1603,11 @@ 
      * @uses $MySqliDb->orderBy('id', 'desc')->orderBy('name', 'desc');
      *
      * @param string $orderByField The name of the database field.
-     * @param string $orderByDirection Order direction.
+     * @param string $orderbyDirection Order direction.
      * @param array $customFields Fieldset for ORDER BY FIELD() ordering
      *
      * @throws Exception
-     * @return MysqliDb
+     * @return Mysql
      */
     public function orderBy($orderByField, $orderbyDirection = "DESC", $customFields = null) {
         $allowedDirection = Array("ASC", "DESC");
@@ -1643,7 +1643,7 @@ 
      *
      * @param string $groupByField The name of the database field.
      *
-     * @return MysqliDb
+     * @return Mysql
      */
     public function groupBy($groupByField) {
         $groupByField = preg_replace("/[^-a-z0-9\.\(\),_\*]+/i", '', $groupByField);
@@ -1659,7 +1659,7 @@ 
      * @param  string $method The table lock method. Can be READ or WRITE.
      *
      * @throws Exception
-     * @return MysqliDb
+     * @return Mysql
      */
     public function setLockMethod($method) {
         // Switch the uppercase string
@@ -1806,7 +1806,7 @@ 
      *
      * @param string $prefix Contains a tableprefix
      *
-     * @return MysqliDb
+     * @return Mysql
      */
     public function setPrefix($prefix = '') {
         $this->prefix = $prefix;
@@ -2016,7 +2016,7 @@ 
      * @param bool $enabled Enable execution time tracking
      * @param string $stripPrefix Prefix to strip from the path in exec log
      *
-     * @return MysqliDb
+     * @return Mysql
      */
     public function setTrace($enabled, $stripPrefix = null) {
         $this->traceEnabled = $enabled;
@@ -2053,7 +2053,7 @@ 
      *
      * @param string $idField field name to use for a mapped element key
      *
-     * @return MysqliDb
+     * @return Mysql
      */
     public function map($idField) {
         $this->_mapKey = $idField;
@@ -2069,7 +2069,7 @@ 
      * @param string $whereProp The name of the database field.
      * @param mixed $whereValue The value of the database field.
      *
-     * @return dbWrapper
+     * @return Mysql
      */
     public function joinOrWhere($whereJoin, $whereProp, $whereValue = 'DBNULL', $operator = '=', $cond = 'AND') {
         return $this->joinWhere($whereJoin, $whereProp, $whereValue, $operator, 'OR');
@@ -2084,7 +2084,7 @@ 
      * @param string $whereProp The name of the database field.
      * @param mixed $whereValue The value of the database field.
      *
-     * @return dbWrapper
+     * @return Mysql
      */
     public function joinWhere($whereJoin, $whereProp, $whereValue = 'DBNULL', $operator = '=', $cond = 'AND') {
         $this->_joinAnd[$whereJoin][] = Array($cond, $whereProp, $operator, $whereValue);
@@ -2160,7 +2160,7 @@ 
      * Helper function to create dbObject with array return type
      * Added for consistency as thats default output type
      *
-     * @return MysqliDb
+     * @return Mysql
      */
     public function arrayBuilder() {
         $this->returnType = 'array';
@@ -2241,7 +2241,7 @@ 
     /**
      * Function to enable SQL_CALC_FOUND_ROWS in the get queries
      *
-     * @return MysqliDb
+     * @return Mysql
      */
     public function withTotalCount() {
         $this->setQueryOption('SQL_CALC_FOUND_ROWS');
@@ -2253,10 +2253,10 @@ 
      *
      * @uses $MySqliDb->setQueryOption('name');
      *
-     * @param string|array $options The optons name of the query.
+     * @param string $options The optons name of the query.
      *
      * @throws Exception
-     * @return MysqliDb
+     * @return Mysql
      */
     public function setQueryOption($options) {
         $allowedOptions = Array('ALL', 'DISTINCT', 'DISTINCTROW', 'HIGH_PRIORITY', 'STRAIGHT_JOIN', 'SQL_SMALL_RESULT',