StorableTrait::update() - Code Metrics - Inspection of "Error and warning messages (logger), in case the s..." - locomotivemtl/charcoal-core - Measure and Improve Code Quality continuously with Scrutinizer

Test Setup Failed
Push — master ( 4762d2...40d590 )

by Mathieu
created 2017-06-14 21:00 UTC
StorableTrait::update() B

↳ Parent: StorableTrait
Complexity

Conditions	4
Paths	4
Size

Total Lines	31
Code Lines	23
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
dl	0
loc	31
rs	8.5806
c	0
b	0
f	0
cc	4
eloc	23
nc	4
nop	1
<?php

namespace Charcoal\Source;

use \Exception;
use \InvalidArgumentException;

// Module `charcoal-factory` dependencies
use \Charcoal\Factory\FactoryInterface;

// Local namespace dependencies
use \Charcoal\Source\SourceInterface;

/**
 * Full implementation, as trait, of the StorableInterface
 */
trait StorableTrait
{
    /**
     * @var mixed $id The object (unique) identifier
     */
    protected $id;

    /**
     * @var string $key The object key
     */
    protected $key = 'id';

    /**
     * @var FactoryInterface $sourceFactory
     */
    protected $sourceFactory;

    /**
     * @var SourceInterface $source
     */
    private $source;

    /**
     * Set the object's ID. The actual property set depends on `key()`
     *
     * @param mixed $id The object id (identifier / primary key value).
     * @throws InvalidArgumentException If the argument is not scalar.
     * @return StorableInterface Chainable
     */
    public function setId($id)
    {
        if (!is_scalar($id)) {
            throw new InvalidArgumentException(
                sprintf(
                    'ID for "%s" must be a scalar (integer, float, string, or boolean); received %s',
                    get_class($this),
                    (is_object($id) ? get_class($id) : gettype($id))
                )
            );
        }

        $key = $this->key();
        if ($key == 'id') {
            $this->id = $id;
        } else {
            $this[$key] = $id;
        }

        return $this;
    }

    /**
     * Get the object's (unique) ID. The actualy property get depends on `key()`
     *
     * @throws Exception If the set key is invalid.
     * @return mixed
     */
    public function id()
    {
        $key = $this->key();
        if ($key == 'id') {
            return $this->id;
        } else {
            return $this[$key];
        }
    }

    /**
     * Set the key property.
     *
     * @param string $key The object key, or identifier "name".
     * @throws InvalidArgumentException If the argument is not scalar.
     * @return StorableInterface Chainable
     */
    public function setKey($key)

    {
        if (!is_string($key)) {
            throw new InvalidArgumentException(
                sprintf(
                    'Key must be a string; received %s',
                    (is_object($key) ? get_class($key) : gettype($key))
                )
            );
        }
        // For security reason, only alphanumeric characters (+ underscores) are valid key names.
        // Although SQL can support more, there's really no reason to.
        if (!preg_match_all('/^[A-Za-z0-9_]+$/', $key)) {
            throw new InvalidArgumentException(
                sprintf('Key "%s" is invalid: must be alphanumeric / underscore.', $key)
            );
        }
        $this->key = $key;

        return $this;
    }

    /**
     * Get the key property.
     *
     * @return string
     */
    public function key()
    {
        return $this->key;
    }

    /**
     * @param FactoryInterface $factory The source factory, which is useful to create source.
     * @return StorableInterface Chainable
     */
    protected function setSourceFactory(FactoryInterface $factory)
    {
        $this->sourceFactory = $factory;
        return $this;
    }

    /**
     * @throws Exception If the source factory was not previously set.
     * @return FactoryInterface
     */
    protected function sourceFactory()
    {
        if (!isset($this->sourceFactory)) {
            throw new Exception(
                sprintf('Source factory is not set for "%s"', get_class($this))
            );
        }
        return $this->sourceFactory;
    }

    /**
     * Set the object's source.
     *
     * @param SourceInterface $source The storable object's source.
     * @return StorableInterface Chainable
     * @todo This method needs to go protected.
     */
    public function setSource(SourceInterface $source)
    {
        $this->source = $source;
        return $this;
    }

    /**
     * Get the object's source.
     *
     * @return SourceInterface
     */
    public function source()
    {
        if ($this->source === null) {
            $this->source = $this->createSource();
        }
        return $this->source;
    }

    /**
     * Create the model's source, with the Source Factory.
     *
     * @return SourceInterface
     */
    abstract protected function createSource();

    /**
     * Load an object from the database from its ID.
     *
     * @param mixed $id The identifier to load.
     * @return StorableInterface Chainable
     */
    public function load($id = null)
    {
        if ($id === null) {
            $id = $this->id();
        }
        $this->source()->loadItem($id, $this);
        return $this;
    }

    /**
     * Load an object from the database from its key $key.
     *
     * @param string $key   Key pointing a column's name.
     * @param mixed  $value Value of said column.
     * @return StorableInterface Chainable.
     */
    public function loadFrom($key = null, $value = null)
    {
        $this->source()->loadItemFromKey($key, $value, $this);

        return $this;
    }

    /**
     * Load an object from the database from a custom SQL query.
     *
     * @param string $query The SQL query.
     * @param array  $binds Optional. The SQL query parameters.
     * @return StorableInterface Chainable.
     */
    public function loadFromQuery($query, array $binds = [])
    {
        $this->source()->loadItemFromQuery($query, $binds, $this);

        return $this;
    }

    /**
     * Save an object current state to storage
     *
     * @return boolean
     */
    public function save()

    {
        $pre = $this->preSave();
        if ($pre === false) {
            $this->logger()->error(sprintf(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                'Can not save object (%s:%s). The preSave() method failed.',
                $this->objType(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                $this->id()
            ));
            return false;
        }
        $ret = $this->source()->saveItem($this);
        if ($ret === false) {
            $this->logger()->error(sprintf(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                'Can not save object (%s:%s). The source\'s saveItem() method failed.',
                $this->objType(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                $this->id()
            ));
            return false;
        }
        $post = $this->postSave();
        if ($post === false) {
            $this->logger()->warning(sprintf(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                'Although the object (%s:%s) was saved, the postSave() method had an error. Expect problems later.',
                $this->objType(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                $this->id()
            ));
            return false;
        }
        return true;
    }

    /**
     * Update the object in storage to the current object state.
     *
     * @param array $properties If set, only update the properties specified in this array.
     * @return boolean
     */
    public function update(array $properties = null)
    {
        $pre = $this->preUpdate($properties);

        if ($pre === false) {
            $this->logger()->error(sprintf(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                'Can not update object (%s:%s). The preUpdate() method failed.',
                $this->objType(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                $this->id()
            ));
            return false;
        }
        $ret = $this->source()->updateItem($this, $properties);
        if ($ret === false) {
            $this->logger()->error(sprintf(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                'Can not update object (%s:%s). The source\'s updateItem() method failed.',
                $this->objType(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                $this->id()
            ));
            return false;
        }
        $post = $this->postUpdate($properties);

        if ($post === false) {
            $this->logger()->warning(sprintf(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                'Although the object (%s:%s) was updated, the postUpdate() method had an error. Expect problems later.',
                $this->objType(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                $this->id()
            ));
            return false;
        }
        return true;
    }

    /**
     * Delete an object from storage.
     *
     * @return boolean
     */
    public function delete()

    {
        $pre = $this->preDelete();
        if ($pre === false) {
            $this->logger()->error(sprintf(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                'Can not update object (%s:%s). The preUpdate() method failed.',
                $this->objType(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                $this->id()
            ));
            return false;
        }
        $ret = $this->source()->deleteItem($this);
        if ($ret === false) {
            $this->logger()->error(sprintf(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                'Can not delete object (%s:%s). The source\'s deleteItem() method failed.',
                $this->objType(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                $this->id()
            ));
            return false;
        }
        $del = $this->postDelete();
        if ($del === false) {
            $this->logger()->warning(sprintf(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                'Although the object (%s:%s) was deleted, the postDelete() method had an error. Expect problems later.',
                $this->objType(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                $this->id()
            ));
            return false;
        }
        return true;
    }

    /**
     * @return boolean
     */
    protected function preSave()
    {
        return true;
    }

    /**
     * @return boolean
     */
    protected function postSave()
    {
        return true;
    }

    /**
     * @param string[] $keys Optional. The list of keys to update.
     * @return boolean
     */
    protected function preUpdate(array $keys = null)

    {
        return true;
    }

    /**
     * @param string[] $keys Optional. The list of keys to update.
     * @return boolean
     */
    protected function postUpdate(array $keys = null)

    {
        return true;
    }

    /**
     * @return boolean
     */
    protected function preDelete()
    {
        return true;
    }

    /**
     * @return boolean
     */
    protected function postDelete()
    {
        return true;
    }
}

1			<?php
2
3			namespace Charcoal\Source;
4
5			use \Exception;
6			use \InvalidArgumentException;
7
8			// Module `charcoal-factory` dependencies
9			use \Charcoal\Factory\FactoryInterface;
10
11			// Local namespace dependencies
12			use \Charcoal\Source\SourceInterface;
13
14			/**
15			* Full implementation, as trait, of the StorableInterface
16			*/
17			trait StorableTrait
18			{
19			/**
20			* @var mixed $id The object (unique) identifier
21			*/
22			protected $id;
23
24			/**
25			* @var string $key The object key
26			*/
27			protected $key = 'id';
28
29			/**
30			* @var FactoryInterface $sourceFactory
31			*/
32			protected $sourceFactory;
33
34			/**
35			* @var SourceInterface $source
36			*/
37			private $source;
38
39			/**
40			* Set the object's ID. The actual property set depends on `key()`
locomotivemtl / charcoal-core

Push — master ( 4762d2...40d590 )

StorableTrait::update() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
