AbstractRow::jsonSerialize() - Code Metrics - Inspection of "improved docs" - oscarotero/simple-crud - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1d7365...c04903 )

by Oscar

created 2016-08-31 16:03 UTC

AbstractRow::jsonSerialize() A

↳ Parent: AbstractRow

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php

namespace SimpleCrud;

use JsonSerializable;
use SimpleCrud\Scheme\Scheme;
use Closure;

/**
 * Base class used by Row and RowCollection.
 *
 * @property mixed $id
 */
abstract class AbstractRow implements JsonSerializable
{
    protected $table;
    private $methods = [];
    private $bindMethods = [];

    /**
     * Constructor.
     *
     * @param Table $table
     */
    public function __construct(Table $table)
    {
        $this->table = $table;
    }

    /**
     * Returns the table associated with this row.
     *
     * @return Table
     */
    public function getTable()
    {
        return $this->table;
    }

    /**
     * Returns the database associated with this row.
     *
     * @return SimpleCrud
     */
    public function getDatabase()
    {
        return $this->getTable()->getDatabase();
    }

    /**
     * @see JsonSerializable
     *
     * @return array
     */
    public function jsonSerialize()
    {
        return $this->toArray();
    }

    /**
     * Magic method to stringify the values.
     *
     * @return string
     */
    public function __toString()
    {
        return json_encode($this, JSON_NUMERIC_CHECK);
    }

    /**
     * Converts this object into an array.
     * 
     * @param array $bannedEntities
     *
     * @return array
     */
    abstract public function toArray(array $bannedEntities = []);

    /**
     * Magic method to return properties.
     * 
     * @param string $name
     *
     * @return mixed
     */
    abstract public function __get($name);

    /**
     * Magic method to edit a property.
     * 
     * @param string $name
     * @param mixed  $value
     *
     * @return mixed
     */
    abstract public function __set($name, $value);

    /**
     * Deletes the row(s) in the database.
     *
     * @return self
     */
    public function delete()
    {
        $id = $this->id;

        if (!empty($id)) {
            $this->getTable()->delete()
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
                ->byId($id)
                ->run();

            $this->id = null;
        }

        return $this;
    }

    /**
     * Register a custom method.
     *
     * @param string  $name
     * @param Closure $method
     *
     * @return self
     */
    public function setMethod($name, Closure $method)
    {
        $this->methods[$name] = $method;
        unset($this->bindMethods[$name]);

        return $this;
    }

    /**
     * Magic method to execute queries or custom methods.
     *
     * @param string $name
     */
    public function __call($name, $arguments)
    {
        if (isset($this->methods[$name])) {
            if (!isset($this->bindMethods[$name])) {
                $this->bindMethods[$name] = $this->methods[$name]->bindTo($this);
            }

            return call_user_func_array($this->bindMethods[$name], $arguments);
        }

        $scheme = $this->getTable()->getScheme();

        if (!isset($scheme['relations'][$name])) {
            throw new \BadMethodCallException(sprintf('Call to undefined method %s', $name));
        }

        $table = $this->getTable();
        $relation = $table->getScheme()['relations'][$name];
        $related = $table->getDatabase()->$name;

        if ($relation[0] === Scheme::HAS_ONE) {
            return $related->select()->one()->relatedWith($this);
        }

        return $related->select()->relatedWith($this);
    }
}


1			<?php
2
3			namespace SimpleCrud;
4
5			use JsonSerializable;
6			use SimpleCrud\Scheme\Scheme;
7			use Closure;
8
9			/**
10			* Base class used by Row and RowCollection.
11			*
12			* @property mixed $id
13			*/
14			abstract class AbstractRow implements JsonSerializable
15			{
16			protected $table;
17			private $methods = [];
18			private $bindMethods = [];
19
20			/**
21			* Constructor.
22			*
23			* @param Table $table
24			*/
25			public function __construct(Table $table)
26			{
27			$this->table = $table;
28			}
29
30			/**
31			* Returns the table associated with this row.
32			*
33			* @return Table
34			*/
35			public function getTable()
36			{
37			return $this->table;
38			}
39
40			/**
41			* Returns the database associated with this row.
42			*
43			* @return SimpleCrud
44			*/
45			public function getDatabase()
46			{
47			return $this->getTable()->getDatabase();
48			}
49
50			/**
51			* @see JsonSerializable
52			*
53			* @return array
54			*/
55			public function jsonSerialize()
56			{
57			return $this->toArray();
58			}
59
60			/**
61			* Magic method to stringify the values.
62			*
63			* @return string
64			*/
65			public function __toString()
66			{
67			return json_encode($this, JSON_NUMERIC_CHECK);
68			}
69
70			/**
71			* Converts this object into an array.
72			*
73			* @param array $bannedEntities
74			*
75			* @return array
76			*/
77			abstract public function toArray(array $bannedEntities = []);
78
79			/**
80			* Magic method to return properties.
81			*
82			* @param string $name
83			*
84			* @return mixed
85			*/
86			abstract public function __get($name);
87
88			/**
89			* Magic method to edit a property.
90			*
91			* @param string $name
92			* @param mixed $value
93			*
94			* @return mixed
95			*/
96			abstract public function __set($name, $value);
97
98			/**
99			* Deletes the row(s) in the database.
100			*
101			* @return self
102			*/
103			public function delete()
104			{
105			$id = $this->id;
106
107			if (!empty($id)) {
108			$this->getTable()->delete()
			0 ignored issues – show Documentation Bug introduced 2016-02-17 00:40 UTC by Report Bug Copy Issue Report The method `delete` does not exist on `object<SimpleCrud\Table>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
109			->byId($id)
110			->run();
111
112			$this->id = null;
113			}
114
115			return $this;
116			}
117
118			/**
119			* Register a custom method.
120			*
121			* @param string $name
122			* @param Closure $method
123			*
124			* @return self
125			*/
126			public function setMethod($name, Closure $method)
127			{
128			$this->methods[$name] = $method;
129			unset($this->bindMethods[$name]);
130
131			return $this;
132			}
133
134			/**
135			* Magic method to execute queries or custom methods.
136			*
137			* @param string $name
138			*/
139			public function __call($name, $arguments)
140			{
141			if (isset($this->methods[$name])) {
142			if (!isset($this->bindMethods[$name])) {
143			$this->bindMethods[$name] = $this->methods[$name]->bindTo($this);
144			}
145
146			return call_user_func_array($this->bindMethods[$name], $arguments);
147			}
148
149			$scheme = $this->getTable()->getScheme();
150
151			if (!isset($scheme['relations'][$name])) {
152			throw new \BadMethodCallException(sprintf('Call to undefined method %s', $name));
153			}
154
155			$table = $this->getTable();
156			$relation = $table->getScheme()['relations'][$name];
157			$related = $table->getDatabase()->$name;
158
159			if ($relation[0] === Scheme::HAS_ONE) {
160			return $related->select()->one()->relatedWith($this);
161			}
162
163			return $related->select()->relatedWith($this);
164			}
165			}
166

oscarotero / simple-crud

Push — master ( 1d7365...c04903 )

AbstractRow::jsonSerialize() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like