Model::update_all() - Code Metrics - Inspection of "Change static class Loader, Module to instance cla..." - tnhfw/tnh-fw - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — 1.0.0-dev ( 024223...5d8234 )

by nguereza
created 2020-03-12 12:07 UTC
Model::update_all() A

↳ Parent: Model
Complexity

Conditions	1
Paths	1
Size

Total Lines	6
Code Lines	5
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	5
nc	1
nop	2
dl	0
loc	6
rs	10
c	0
b	0
f	0
<?php
    defined('ROOT_PATH') || exit('Access denied');
    /**
     * TNH Framework
     *
     * A simple PHP framework using HMVC architecture
     *
     * This content is released under the MIT License (MIT)
     *
     * Copyright (c) 2017 TNH Framework
     *
     * Permission is hereby granted, free of charge, to any person obtaining a copy
     * of this software and associated documentation files (the "Software"), to deal
     * in the Software without restriction, including without limitation the rights
     * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     * copies of the Software, and to permit persons to whom the Software is
     * furnished to do so, subject to the following conditions:
     *
     * The above copyright notice and this permission notice shall be included in all
     * copies or substantial portions of the Software.
     *
     * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
     * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
     * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
     * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
     * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
     * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
     * SOFTWARE.
     */


    /**
     * A base model with a series of CRUD functions (powered by CI's query builder),
     * validation-in-model support, event callbacks and more.
     *
     * @link http://github.com/jamierumbelow/codeigniter-base-model
     * @copyright Copyright (c) 2012, Jamie Rumbelow <http://jamierumbelow.net>
     */

    class Model {

        /* --------------------------------------------------------------
         * VARIABLES
         * ------------------------------------------------------------ */

        /**
         * This model's default database table. Automatically
         * guessed by pluralising the model name.
         */
        protected $_table;

        /**
         * The database connection object. Will be set to the default
         * connection. This allows individual models to use different DBs
         * without overwriting the global database connection.
         */
        protected $_database;

        /**
         * This model's default primary key or unique identifier.
         * Used by the get(), update() and delete() functions.
         */
        protected $primary_key = 'id';

        /**
         * Support for soft deletes and this model's 'deleted' key
         */
        protected $soft_delete = false;
        protected $soft_delete_key = 'is_deleted';
        protected $_temporary_with_deleted = FALSE;
        protected $_temporary_only_deleted = FALSE;

        /**
         * The various callbacks available to the model. Each are
         * simple lists of method names (methods will be run on $this).
         */
        protected $before_create = array();
        protected $after_create = array();
        protected $before_update = array();
        protected $after_update = array();
        protected $before_get = array();
        protected $after_get = array();
        protected $before_delete = array();
        protected $after_delete = array();

        protected $callback_parameters = array();

        /**
         * Protected, non-modifiable attributes
         */
        protected $protected_attributes = array();

        /**
         * Relationship arrays. Use flat strings for defaults or string
         * => array to customise the class name and primary key
         */
        protected $belongs_to = array();
        protected $has_many = array();

        protected $_with = array();

        /**
         * An array of validation rules. This needs to be the same format
         * as validation rules passed to the FormValidation library.
         */
        protected $validate = array();

        /**
         * Optionally skip the validation. Used in conjunction with
         * skip_validation() to skip data validation for any future calls.
         */
        protected $skip_validation = FALSE;

        /**
         * By default we return our results as objects. If we need to override
         * this, we can, or, we could use the `as_array()` and `as_object()` scopes.
         */
        protected $return_type = 'object';

        /**
         * Set return type array or object
         * @var string
         */
        protected $_temporary_return_type = NULL;
    	
    	
        /**
    		The database cache time 
         */
        protected $dbCacheTime = 0;

        /* --------------------------------------------------------------
         * GENERIC METHODS
         * ------------------------------------------------------------ */

        /**
         * Initialise the model, tie into the CodeIgniter superobject and
         * try our best to guess the table name.
         */
        public function __construct(Database $db = null) {
            $instance = null;
            if (is_object($db)) {
                $instance = $db;
            } else {
                $obj = & get_instance();
                if (isset($obj->database)){
                    /**
                     * NOTE: Need use "clone" because some Model need have the personal instance of the database library
                     * to prevent duplication
                     */
                    $instance = clone $obj->database;
                }
            }
            //Note: don't use the property direct access here as some update is done in the method
            //$this->setDatabaseInstance
            $this->setDatabaseInstance($instance);

            array_unshift($this->before_create, 'protect_attributes');
            array_unshift($this->before_update, 'protect_attributes');
            $this->_temporary_return_type = $this->return_type;
        }

        /* --------------------------------------------------------------
         * CRUD INTERFACE
         * ------------------------------------------------------------ */

        /**
         * Fetch a single record based on the primary key. Returns an object.
         */
        public function get($primary_value) {
            return $this->get_by($this->primary_key, $primary_value);
        }


        /**
         * Fetch a single record based on an arbitrary WHERE call. Can be
         * any valid value to DatabaseQueryBuilder->where().
         */
        public function get_by() {
            $where = func_get_args();
            $this->checkForSoftDelete();
            $this->_set_where($where);
            $this->trigger('before_get');
            $type = $this->getReturnType();
            $this->getQueryBuilder()->from($this->_table);
            $row = $this->_database->get($type);
            $this->_temporary_return_type = $this->return_type;
            $row = $this->trigger('after_get', $row);
            $this->_with = array();
            return $row;
        }

        /**
         * Fetch an array of records based on an array of primary values.
         */
        public function get_many($values) {
            $this->getQueryBuilder()->in($this->primary_key, $values);
            return $this->get_all();
        }

        /**
         * Fetch an array of records based on an arbitrary WHERE call.
         */
        public function get_many_by() {
            $where = func_get_args();
            $this->_set_where($where);
            return $this->get_all();
        }

        /**
         * Fetch all the records in the table. Can be used as a generic call
         * to $this->_database->get() with scoped methods.
         */
        public function get_all() {
            $this->trigger('before_get');
            $this->checkForSoftDelete();
            $type = $this->getReturnType();
            $this->getQueryBuilder()->from($this->_table);
            $result = $this->_database->getAll($type);
            $this->_temporary_return_type = $this->return_type;
            foreach ($result as $key => &$row) {
                $row = $this->trigger('after_get', $row, ($key == count($result) - 1));
            }
            $this->_with = array();
            return $result;
        }

        /**
         * Insert a new row into the table. $data should be an associative array
         * of data to be inserted. Returns newly created ID.
         * @see Database::insert
         */
        public function insert($data = array(), $skip_validation = FALSE, $escape = true) {
            if ($this->validateData($data, $skip_validation) !== FALSE) {
                $data = $this->trigger('before_create', $data);
                $this->getQueryBuilder()->from($this->_table);
                $this->_database->insert($data, $escape);
                $insert_id = $this->_database->insertId();
                $this->trigger('after_create', $insert_id);
                //if the table doesn't have the auto increment field or sequence, the value of 0 will be returned 
                $id = $insert_id;
                if (!$id) {
                    $id = true;
                }
                return $id;
            } 
            return FALSE;
        }

        /**
         * Insert multiple rows into the table. Returns an array of multiple IDs.
         */
        public function insert_many($data = array(), $skip_validation = FALSE, $escape = true) {
            $ids = array();
            foreach ($data as $key => $row) {
                $ids[] = $this->insert($row, $skip_validation, $escape);
            }
            return $ids;
        }

        /**
         * Updated a record based on the primary value.
         */
        public function update($primary_value, $data = array(), $skip_validation = FALSE, $escape = true) {
            $data = $this->trigger('before_update', $data);
            if ($this->validateData($data, $skip_validation) !== FALSE) {
                $this->getQueryBuilder()->where($this->primary_key, $primary_value)
                                        ->from($this->_table);
                $result = $this->_database->update($data, $escape);
                $this->trigger('after_update', array($data, $result));
                return $result;
            } 
            return FALSE;
        }

        /**
         * Update many records, based on an array of primary values.
         */
        public function update_many($primary_values, $data = array(), $skip_validation = FALSE, $escape = true) {
            $data = $this->trigger('before_update', $data);
            if ($this->validateData($data, $skip_validation) !== FALSE) {
                $this->getQueryBuilder()->in($this->primary_key, $primary_values)
                                        ->from($this->_table);
                $result = $this->_database->update($data, $escape);
                $this->trigger('after_update', array($data, $result));
                return $result;
            }
            return FALSE;
        }

        /**
         * Updated a record based on an arbitrary WHERE clause.
         */
        public function update_by() {
            $args = func_get_args();
            $data = array();
            if (count($args) == 2) {
                if (is_array($args[1])) {
                    $data = array_pop($args);
                }
            } else if (count($args) == 3) {
                if (is_array($args[2])) {
                    $data = array_pop($args);
                }
            }
            $data = $this->trigger('before_update', $data);
            if ($this->validate($data) !== FALSE) {
                $this->_set_where($args);
                $this->getQueryBuilder()->from($this->_table);
                $result = $this->_database->update($data);
                $this->trigger('after_update', array($data, $result));
                return $result;
            }
            return FALSE;
        }

        /**
         * Update all records
         */
        public function update_all($data = array(), $escape = true) {
            $data = $this->trigger('before_update', $data);
            $this->getQueryBuilder()->from($this->_table);
            $result = $this->_database->update($data, $escape);
            $this->trigger('after_update', array($data, $result));
            return $result;
        }

        /**
         * Delete a row from the table by the primary value
         */
        public function delete($id) {
            $this->trigger('before_delete', $id);
            $this->getQueryBuilder()->where($this->primary_key, $id);
            $result = false;
            $this->getQueryBuilder()->from($this->_table);  
            if ($this->soft_delete) {
                $result = $this->_database->update(array($this->soft_delete_key => TRUE));
            } else {
                $result = $this->_database->delete();
            }
            $this->trigger('after_delete', $result);
            return $result;
        }

        /**
         * Delete a row from the database table by an arbitrary WHERE clause
         */
        public function delete_by() {
            $where = func_get_args();
            $where = $this->trigger('before_delete', $where);
            $this->_set_where($where);
            $result = false;
            $this->getQueryBuilder()->from($this->_table);  
            if ($this->soft_delete) {
                $result = $this->_database->update(array($this->soft_delete_key => TRUE));
            } else {
                $result = $this->_database->delete();
            }
            $this->trigger('after_delete', $result);
            return $result;
        }

        /**
         * Delete many rows from the database table by multiple primary values
         */
        public function delete_many($primary_values) {
            $primary_values = $this->trigger('before_delete', $primary_values);
            $this->getQueryBuilder()->in($this->primary_key, $primary_values);
            $result = false;
            $this->getQueryBuilder()->from($this->_table);  
            if ($this->soft_delete) {
                $result = $this->_database->update(array($this->soft_delete_key => TRUE));
            } else {
                $result = $this->_database->delete();
            }
            $this->trigger('after_delete', $result);
            return $result;
        }


        /**
         * Truncates the table
         */
        public function truncate() {
            $this->getQueryBuilder()->from($this->_table); 
            $result = $this->_database->delete();
            return $result;
        }

        /* --------------------------------------------------------------
         * RELATIONSHIPS
         * ------------------------------------------------------------ */

        public function with($relationship) {
            $this->_with[] = $relationship;
            if (!in_array('relate', $this->after_get)) {
                $this->after_get[] = 'relate';
            }
            return $this;
        }
		
        /**
         * Relationship
         */
        public function relate($row) {
            if (empty($row)) {
                return $row;
            }
            $row = $this->relateBelongsTo($row);
            $row = $this->relateHasMany($row);
            return $row;
        }

        /* --------------------------------------------------------------
         * UTILITY METHODS
         * ------------------------------------------------------------ */

        /**
         * Retrieve and generate a form_dropdown friendly array
         */
        public function dropdown() {
            $args = func_get_args();
            if (count($args) == 2) {
                list($key, $value) = $args;
            } else {
                $key = $this->primary_key;
                $value = $args[0];
            }
            $this->trigger('before_dropdown', array($key, $value));
            $this->checkForSoftDelete();
            $this->getQueryBuilder()->select(array($key, $value))
                                    ->from($this->_table);
            $result = $this->_database->getAll();
            $options = array();
            foreach ($result as $row) {
                $options[$row->{$key}] = $row->{$value};
            }
            $options = $this->trigger('after_dropdown', $options);
            return $options;
        }

        /**
         * Fetch a count of rows based on an arbitrary WHERE call.
         */
        public function count_by() {
            $this->checkForSoftDelete();
            $where = func_get_args();
            $this->_set_where($where);
            $this->getQueryBuilder()->from($this->_table);
            $this->_database->getAll();
            return $this->_database->numRows();
        }

        /**
         * Fetch a total count of rows, disregarding any previous conditions
         */
        public function count_all() {
            $this->checkForSoftDelete();
            $this->getQueryBuilder()->from($this->_table);
            $this->_database->getAll();
            return $this->_database->numRows();
        }
		
        /**
         * Enabled cache temporary
         */
        public function cached($ttl = 0) {
            $this->_database = $this->_database->cached($ttl);
            return $this;
        }

        /**
         * Tell the class to skip the insert validation
         */
        public function skip_validation() {
            $this->skip_validation = TRUE;
            return $this;
        }

        /**
         * Get the skip validation status
         */
        public function get_skip_validation() {
            return $this->skip_validation;
        }

        /**
         * Return the next auto increment of the table. Only tested on MySQL.
         */
        public function get_next_id() {
            $this->getQueryBuilder()->select('AUTO_INCREMENT')
                                    ->from('information_schema.TABLES')
                                    ->where('TABLE_NAME', $this->_table)
                                    ->where('TABLE_SCHEMA', $this->_database->getConnection()->getDatabase());
            return (int) $this->_database->get()->AUTO_INCREMENT;
        }

        /**
         * Getter for the table name
         */
        public function table() {
            return $this->_table;
        }

        /* --------------------------------------------------------------
         * GLOBAL SCOPES
         * ------------------------------------------------------------ */

        /**
         * Return the next call as an array rather than an object
         */
        public function as_array() {
            $this->_temporary_return_type = 'array';
            return $this;
        }

        /**
         * Return the next call as an object rather than an array
         */
        public function as_object() {
            $this->_temporary_return_type = 'object';
            return $this;
        }

        /**
         * Don't care about soft deleted rows on the next call
         */
        public function with_deleted() {
            $this->_temporary_with_deleted = TRUE;
            return $this;
        }

        /**
         * Only get deleted rows on the next call
         */
        public function only_deleted() {
            $this->_temporary_only_deleted = TRUE;
            return $this;
        }

        /* --------------------------------------------------------------
         * OBSERVERS
         * ------------------------------------------------------------ */

        /**
         * MySQL DATETIME created_at and updated_at
         */
        public function created_at($row) {
            if (is_object($row)) {
                $row->created_at = date('Y-m-d H:i:s');
            } else {
                $row['created_at'] = date('Y-m-d H:i:s');
            }
            return $row;
        }

        public function updated_at($row) {
            if (is_object($row)) {
                $row->updated_at = date('Y-m-d H:i:s');
            } else {
                $row['updated_at'] = date('Y-m-d H:i:s');
            }
            return $row;
        }

        /**
         * Serialises data for you automatically, allowing you to pass
         * through objects and let it handle the serialisation in the background
         */
        public function serialize($row) {
            foreach ($this->callback_parameters as $column) {
                $row[$column] = serialize($row[$column]);
            }
            return $row;
        }

        public function unserialize($row) {
            foreach ($this->callback_parameters as $column) {
                if (is_array($row)) {
                    $row[$column] = unserialize($row[$column]);
                } else {
                    $row->$column = unserialize($row->$column);
                }
            }
            return $row;
        }

        /**
         * Protect attributes by removing them from $row array
         */
        public function protect_attributes($row) {
            foreach ($this->protected_attributes as $attr) {
                if (is_object($row) && isset($row->$attr)) {
                    unset($row->$attr);
                } else if (isset($row[$attr])) {
                    unset($row[$attr]);
                }
            }
            return $row;
        }
		
            /**
             * Return the database instance
             * @return Database the database instance
             */
        public function getDatabaseInstance() {
            return $this->_database;
        }

        /**
         * set the Database instance for future use
         * @param Database $db the database object
         */
        public function setDatabaseInstance($db) {
            $this->_database = $db;
            if ($this->dbCacheTime > 0) {
                $this->_database->setCache($this->dbCacheTime);
            }
            return $this;
        }

        /**
         * Return the queryBuilder instance this is the shortcut to database queryBuilder
         * @return object the DatabaseQueryBuilder instance
         */
        public function getQueryBuilder() {
            return $this->_database->getQueryBuilder();
        }

        /**
         * Set the DatabaseQueryBuilder instance for future use
         * @param object $queryBuilder the DatabaseQueryBuilder object
         * @return object
         */
        public function setQueryBuilder($queryBuilder) {
            $this->_database->setQueryBuilder($queryBuilder);
            return $this;
        }

        /* --------------------------------------------------------------
         * QUERY BUILDER DIRECT ACCESS METHODS
         * ------------------------------------------------------------ */

        /**
         * A wrapper to $this->getQueryBuilder()->orderBy()
         */
        public function order_by($criteria, $order = 'ASC') {
            if (is_array($criteria)) {
                foreach ($criteria as $key => $value) {
                    $this->getQueryBuilder()->orderBy($key, $value);
                }
            } else {
                $this->getQueryBuilder()->orderBy($criteria, $order);
            }
            return $this;
        }

        /**
         * A wrapper to $this->getQueryBuilder()->limit()
         */
        public function limit($offset = 0, $limit = 10) {
            $this->getQueryBuilder()->limit($offset, $limit);
            return $this;
        }

        /* --------------------------------------------------------------
         * INTERNAL METHODS
         * ------------------------------------------------------------ */
        
        /**
         * Validate the data using the validation rules
         * @param  mixed $data the data to validate before insert, update, etc.
         * @param boolean $skipValidation whether to skip validation or not
         * @return mixed
         */
        protected function validateData($data, $skipValidation) {
            if ($skipValidation === FALSE) {
                $data = $this->validate($data);
            }
            return $data;
        }

         /**
         * Get the return type array or object
         * @return string|boolean
         */
        protected function getReturnType(){
            $type = false;
            if ($this->_temporary_return_type == 'array') {
               $type = 'array';
            }
            return $type;
        }

         /**
         * Check if soft delete is enable setting the condition
         * @return object the current instance 
         */
        protected function checkForSoftDelete(){
            if ($this->soft_delete && $this->_temporary_with_deleted !== true) {
                $this->getQueryBuilder()->where($this->soft_delete_key, (bool) $this->_temporary_only_deleted);
            }
            return $this;
        }

         /**
         * Relate for "belongs_to" and "has_many"
         * @param  string $relationship the name of relation
         * @param  string|array $options      the model and primary key values
         * @param  object|array $row          the row to update
         * @param  string $type         the type can be "belongs_to", "has_many"
         * @return mixed               the final row values
         */
        protected function relateBelongsToAndHasMany($relationship, $options, $row, $type){
            if (in_array($relationship, $this->_with)) {
                get_instance()->loader->model($options['model'], $relationship . '_model');

                if($type == 'belongs_to'){
                    if (is_object($row)) {
                        $row->{$relationship} = $this->{$relationship . '_model'}->get($row->{$options['primary_key']});
                    } else {
                        $row[$relationship] = $this->{$relationship . '_model'}->get($row[$options['primary_key']]);
                    }
                } else {
                    if (is_object($row)) {
                        $row->{$relationship} = $this->{$relationship . '_model'}->get_many_by($options['primary_key'], $row->{$this->primary_key});
                    } else {
                        $row[$relationship] = $this->{$relationship . '_model'}->get_many_by($options['primary_key'], $row[$this->primary_key]);
                    }
                }
            }
            return $row;
        }

        /**
         * relate for the relation "belongs_to"
         * @return mixed
         */
        protected function relateBelongsTo($row) {
            foreach ($this->belongs_to as $key => $value) {
                if (is_string($value)) {
                    $relationship = $value;
                    $options = array('primary_key' => $value . '_id', 'model' => $value . '_model');
                } else {
                    $relationship = $key;
                    $options = $value;
                }
                $row = $this->relateBelongsToAndHasMany($relationship, $options, $row, 'belongs_to');
            }
            return $row;
        }

        /**
         * relate for the relation "has_many"
         * @return mixed
         */
        protected function relateHasMany($row) {
            foreach ($this->has_many as $key => $value) {
                if (is_string($value)) {
                    $relationship = $value;
                    $options = array('primary_key' => $this->_table . '_id', 'model' => $value . '_model');
                } else {
                    $relationship = $key;
                    $options = $value;
                }
                $row = $this->relateBelongsToAndHasMany($relationship, $options, $row, 'belongs_to');
            }
            return $row;
        }
		
        /**
         * Trigger an event and call its observers. Pass through the event name
         * (which looks for an instance variable $this->event_name), an array of
         * parameters to pass through and an optional 'last in interation' boolean
         */
        protected function trigger($event, $data = FALSE, $last = TRUE) {
            if (isset($this->$event) && is_array($this->$event)) {
                foreach ($this->$event as $method) {
                    if (strpos($method, '(')) {
                        preg_match('/([a-zA-Z0-9\_\-]+)(\(([a-zA-Z0-9\_\-\., ]+)\))?/', $method, $matches);
                        $method = $matches[1];
                        $this->callback_parameters = explode(',', $matches[3]);
                    }
                    $data = call_user_func_array(array($this, $method), array($data, $last));
                }
            }
            return $data;
        }

        /**
         * Run validation on the passed data
         */
        protected function validate(array $data) {
            if ($this->skip_validation || empty($this->validate)) {
                return $data;
            }
            get_instance()->formvalidation->setData($data);
            get_instance()->formvalidation->setRules($this->validate);

            if (get_instance()->formvalidation->validate()) {
                return $data;
            }
            return FALSE;
        }
		
		
        /**
         * Set WHERE parameters, when is array
         * @param array $params
         */
        protected function _set_where_array(array $params) {
            foreach ($params as $field => $filter) {
                if (is_array($filter)) {
                    $this->getQueryBuilder()->in($field, $filter);
                } else {
                    if (is_int($field)) {
                        $this->getQueryBuilder()->where($filter);
                    } else {
                        $this->getQueryBuilder()->where($field, $filter);
                    }
                }
            }
        }


        /**
         * Set WHERE parameters, cleverly
         */
        protected function _set_where($params) {
            if (count($params) == 1 && is_array($params[0])) {
                $this->_set_where_array($params[0]);
            } else if (count($params) == 1) {
                $this->getQueryBuilder()->where($params[0]);
            } else if (count($params) == 2) {
                if (is_array($params[1])) {
                    $this->getQueryBuilder()->in($params[0], $params[1]);
                } else {
                    $this->getQueryBuilder()->where($params[0], $params[1]);
                }
            } else if (count($params) == 3) {
                $this->getQueryBuilder()->where($params[0], $params[1], $params[2]);
            } else {
                if (is_array($params[1])) {
                    $this->getQueryBuilder()->in($params[0], $params[1]);
                } else {
                    $this->getQueryBuilder()->where($params[0], $params[1]);
                }
            }
        }

        /**
            Shortcut to controller
         */
        public function __get($key) {
            return get_instance()->{$key};
        }

    }

tnhfw / tnh-fw

Push — 1.0.0-dev ( 024223...5d8234 )

Model::update_all() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
