Eloquent::save() - Code Metrics - Inspection of "[WIP] PHP7 and new infrastructure" - devemio/elasticsearch-eloquent - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#22)

by Sergey

created 2017-03-10 08:49 UTC

Eloquent::save() B

↳ Parent: Eloquent

Complexity

Conditions	5
Paths	9

Size

Total Lines	19
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	19
rs	8.8571
c	0
b	0
f	0
nc	9
cc	5
eloc	13
nop	1

<?php

namespace Isswp101\Persimmon\Model;

use Isswp101\Persimmon\Collection\ICollection;
use Isswp101\Persimmon\DI\Container;
use Isswp101\Persimmon\Exceptions\IllegalCollectionException;
use Isswp101\Persimmon\Exceptions\ModelNotFoundException;
use Isswp101\Persimmon\QueryBuilder\IQueryBuilder;
use Isswp101\Persimmon\Traits\Containerable;
use Isswp101\Persimmon\Traits\Eventable;
use Isswp101\Persimmon\Traits\Timestampable;

/**
 * @TODO
 * 1. Cache
 * 2. Consider columns when searching
 * 3. Check __clone()
 */
abstract class Eloquent implements IEloquent
{
    use Containerable, Timestampable, Eventable;

    protected $exists = false;
    protected $timestamps = false;

    /** @MustBeOverridden */
    const COLLECTION = null;

    const PRIMARY_KEY = 'id';
    const CREATED_AT = 'created_at';
    const UPDATED_AT = 'updated_at';

    abstract protected static function di(): Container;

    public function __construct(array $attributes = [])
    {
        $this->fill($attributes);
    }

    public function getPrimaryKey(): string
    {
        return $this->{static::PRIMARY_KEY};
    }

    public function setPrimaryKey(string $key)
    {
        $this->{static::PRIMARY_KEY} = $key;
    }

    final public static function getCollectionName(): string
    {
        if (static::COLLECTION == null) {
            throw new IllegalCollectionException();
        }
        return static::COLLECTION;
    }

    public function exists(bool $value = null): bool
    {
        if ($value != null) {
            $this->exists = $value;
        }
        return $this->exists;
    }

    public static function all(IQueryBuilder $query, array $columns = [], callable $callback = null): ICollection
    {
        $collection = static::di()->getRepository()->all(
            $query,
            static::class,
            $columns,
            function (IEloquent $model) use ($callback) {
                $model->exists(true);
                if ($callback != null) {
                    $callback($model);
                }
            });
        return $collection;
    }

    public static function find($id, array $columns = []): IEloquent
    {
        $model = static::di()->getRepository()->find($id, static::class, $columns);
        if ($model != null) {
            $model->exists = true;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        }
        return $model;
    }

    public static function findOrFail($id, array $columns = []): IEloquent
    {
        $model = static::find($id, $columns);
        if ($model == null) {
            throw new ModelNotFoundException(get_called_class(), $id);
        }
        return $model;
    }

    public static function create(array $attributes): IEloquent
    {
        $model = new static($attributes);
        $model->save();
        return $model;
    }

    public static function destroy($id)
    {
        static::findOrFail($id)->delete();
    }

    public function save(array $columns = [])
    {
        if ($this->saving() === false) {
            return;
        }
        $repository = $this->di()->getRepository();
        if ($this->timestamps) {
            $this->updateTimestamps();
        }
        if (!$this->exists) {
            $repository->insert($this);
        } else {
            $repository->update($this);
        }
        $this->exists = true;
        if ($this->saved() === false) {
            return;
        }
    }

    public function delete()
    {
        if ($this->deleting() === false) {
            return;
        }
        $this->di()->getRepository()->delete($this->getPrimaryKey());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->exists = false;
        if ($this->deleted() === false) {
            return;
        }
    }
}

1			<?php
2
3			namespace Isswp101\Persimmon\Model;
4
5			use Isswp101\Persimmon\Collection\ICollection;
6			use Isswp101\Persimmon\DI\Container;
7			use Isswp101\Persimmon\Exceptions\IllegalCollectionException;
8			use Isswp101\Persimmon\Exceptions\ModelNotFoundException;
9			use Isswp101\Persimmon\QueryBuilder\IQueryBuilder;
10			use Isswp101\Persimmon\Traits\Containerable;
11			use Isswp101\Persimmon\Traits\Eventable;
12			use Isswp101\Persimmon\Traits\Timestampable;
13
14			/**
15			* @TODO
16			* 1. Cache
17			* 2. Consider columns when searching
18			* 3. Check __clone()
19			*/
20			abstract class Eloquent implements IEloquent
21			{
22			use Containerable, Timestampable, Eventable;
23
24			protected $exists = false;
25			protected $timestamps = false;
26
27			/** @MustBeOverridden */
28			const COLLECTION = null;
29
30			const PRIMARY_KEY = 'id';
31			const CREATED_AT = 'created_at';
32			const UPDATED_AT = 'updated_at';
33
34			abstract protected static function di(): Container;
35
36			public function __construct(array $attributes = [])
37			{
38			$this->fill($attributes);
39			}
40
41			public function getPrimaryKey(): string
42			{
43			return $this->{static::PRIMARY_KEY};
44			}
45
46			public function setPrimaryKey(string $key)
47			{
48			$this->{static::PRIMARY_KEY} = $key;
49			}
50
51			final public static function getCollectionName(): string
52			{
53			if (static::COLLECTION == null) {
54			throw new IllegalCollectionException();
55			}
56			return static::COLLECTION;
57			}
58
59			public function exists(bool $value = null): bool
60			{
61			if ($value != null) {
62			$this->exists = $value;
63			}
64			return $this->exists;
65			}
66
67			public static function all(IQueryBuilder $query, array $columns = [], callable $callback = null): ICollection
68			{
69			$collection = static::di()->getRepository()->all(
70			$query,
71			static::class,
72			$columns,
73			function (IEloquent $model) use ($callback) {
74			$model->exists(true);
75			if ($callback != null) {
76			$callback($model);
77			}
78			});
79			return $collection;
80			}
81
82			public static function find($id, array $columns = []): IEloquent
83			{
84			$model = static::di()->getRepository()->find($id, static::class, $columns);
85			if ($model != null) {
86			$model->exists = true;
			0 ignored issues – show Bug introduced 2017-03-07 13:18 UTC by Report Bug Copy Issue Report Accessing `exists` on the interface `Isswp101\Persimmon\Contracts\Storable` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
87			}
88			return $model;
89			}
90
91			public static function findOrFail($id, array $columns = []): IEloquent
92			{
93			$model = static::find($id, $columns);
94			if ($model == null) {
95			throw new ModelNotFoundException(get_called_class(), $id);
96			}
97			return $model;
98			}
99
100			public static function create(array $attributes): IEloquent
101			{
102			$model = new static($attributes);
103			$model->save();
104			return $model;
105			}
106
107			public static function destroy($id)
108			{
109			static::findOrFail($id)->delete();
110			}
111
112			public function save(array $columns = [])
113			{
114			if ($this->saving() === false) {
115			return;
116			}
117			$repository = $this->di()->getRepository();
118			if ($this->timestamps) {
119			$this->updateTimestamps();
120			}
121			if (!$this->exists) {
122			$repository->insert($this);
123			} else {
124			$repository->update($this);
125			}
126			$this->exists = true;
127			if ($this->saved() === false) {
128			return;
129			}
130			}
131
132			public function delete()
133			{
134			if ($this->deleting() === false) {
135			return;
136			}
137			$this->di()->getRepository()->delete($this->getPrimaryKey());
			0 ignored issues – show Documentation introduced 2017-03-09 14:14 UTC by Report Bug Copy Issue Report `$this->getPrimaryKey()` is of type `string`, but the function expects a `object<Isswp101\Persimmon\Contracts\Storable>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
138			$this->exists = false;
139			if ($this->deleted() === false) {
140			return;
141			}
142			}
143			}

devemio / elasticsearch-eloquent

Pull Request — master (#22)

Eloquent::save() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like