Model::newQuery() - Code Metrics - Inspection of "Release" - aaemnnosttv/silk - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#20)

by Evan

created 2016-07-15 14:05 UTC

Model::newQuery() A

↳ Parent: Model

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

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

<?php

namespace Silk\Term;

use stdClass;
use WP_Term;
use Silk\Taxonomy\Taxonomy;
use Silk\Type\Model as BaseModel;
use Illuminate\Support\Collection;
use Silk\Term\Exception\TermNotFoundException;
use Silk\Term\Exception\TaxonomyMismatchException;

/**
 * @property-read WP_Term $term
 * 
 * @property int    $term_id
 * @property string $name
 * @property string $slug
 * @property string $term_group
 * @property int    $term_taxonomy_id
 * @property string $taxonomy
 * @property string $description
 * @property int    $parent
 * @property int    $count
 */
abstract class Model extends BaseModel
{
    /**
     * The term's taxonomy
     * @var string
     */
    const TAXONOMY = '';

    /**
     * The object type in WordPress
     * @var string
     */
    const OBJECT_TYPE = 'term';

    /**
     * The primary ID property on the object
     */
    const ID_PROPERTY = 'term_id';

    /**
     * Model Constructor.
     *
     * @param mixed $term  WP_Term to fill data from
     *
     * @throws TaxonomyMismatchException
     */
    public function __construct(WP_Term $term = null)
    {
        if (! $term) {
            $term = new WP_Term(new stdClass);
            $term->taxonomy = static::TAXONOMY;
        } elseif ($term->taxonomy != static::TAXONOMY) {
            throw new TaxonomyMismatchException();
        }

        $this->object = $term;
    }

    /**
     * Create a new instance from a WP_Term object.
     *
     * @param  WP_Term $term [description]
     *
     * @return static
     */
    public static function fromWpTerm(WP_Term $term)
    {
        return new static($term);
    }

    /**
     * Create a new instance from a term ID.
     *
     * @param  int|string $id  Term ID
     *
     * @throws TermNotFoundException
     *
     * @return static
     */
    public static function fromID($id)

    {
        if (! $term = get_term_by('id', (int) $id, static::TAXONOMY)) {
            throw new TermNotFoundException("No term found with ID $id.");
        }

        return static::fromWpTerm($term);
    }

    /**
     * Create a new instance from a slug.
     *
     * @param  string $slug  Term slug
     *
     * @throws TermNotFoundException
     *
     * @return static
     */
    public static function fromSlug($slug)

    {
        if (! $term = get_term_by('slug', $slug, static::TAXONOMY)) {
            throw new TermNotFoundException("No term found with slug '$slug'.");
        }

        return static::fromWpTerm($term);
    }

    /**
     * Create a new instance from an array of attributes.
     *
     * @param  array  $attributes [description]
     *
     * @return static
     */
    public static function fromArray(array $attributes)
    {
        return new static(
            new WP_Term((object) $attributes)
        );
    }

    /**
     * Create a new term, and get the instance for it.
     *
     * @param  array $attributes  Term attributes
     *
     * @return static
     */
    public static function create(array $attributes = [])
    {
        return static::fromArray(
            Collection::make($attributes)
                ->except([static::ID_PROPERTY, 'term_taxonomy_id'])
                ->put('taxonomy', static::TAXONOMY)
                ->toArray()
        )->save();
    }

    /**
     * Check if this term exists in the database.
     *
     * @return boolean
     */
    public function exists()
    {
        return $this->id && ((bool) term_exists((int) $this->id, static::TAXONOMY));
    }

    /**
     * Check if this term exists in the database as the child of the given parent.
     *
     * @param  int|string|object  $parent  integer Parent term ID
     *                                     string  Parent term slug or name
     *                                     object  The parent term object/model.
     *
     * @return boolean                     True if the this term and the parent
     *                                     exist in the database, and the instance
     *                                     is a child of the given parent;
     *                                     otherwise false
     */
    public function isChildOf($parent)
    {
        if (isset($parent->term_id)) {
            $parent = $parent->term_id;
        }

        return (bool) term_exists((int) $this->id, static::TAXONOMY, $parent);
    }

    /**
     * Get the parent term instance.
     *
     * @return static
     */
    public function parent()
    {
        return static::fromID($this->object->parent);
    }

    /**
     * Get all ancestors of this term as a collection.
     *
     * @return Collection
     */
    public function ancestors()
    {
        return Collection::make(get_ancestors($this->id, static::TAXONOMY, 'taxonomy'))
            ->map(function ($term_ID) {
                return static::fromID($term_ID);
            });
    }

    /**
     * Get the taxonomy identifier for the model.
     *
     * @return string
     */
    public static function typeId()
    {
        return static::taxonomy()->id;
    }

    /**
     * Get the Taxonomy model.
     *
     * @return Taxonomy|\Silk\Taxonomy\Builder
     */
    public static function taxonomy()
    {
        return Taxonomy::make(static::TAXONOMY);
    }

    /**
     * Start a new query for terms of this type.
     *
     * @return QueryBuilder
     */
    public function newQuery()
    {
        return (new QueryBuilder)->setModel($this);
    }

    /**
     * Get the array of actions and their respective handler classes.
     *
     * @return array
     */
    protected function actionClasses()
    {
        return [
            'save'   => Action\TermSaver::class,
            'load'   => Action\TermLoader::class,
            'delete' => Action\TermDeleter::class,
        ];
    }
}


1			<?php
2
3			namespace Silk\Term;
4
5			use stdClass;
6			use WP_Term;
7			use Silk\Taxonomy\Taxonomy;
8			use Silk\Type\Model as BaseModel;
9			use Illuminate\Support\Collection;
10			use Silk\Term\Exception\TermNotFoundException;
11			use Silk\Term\Exception\TaxonomyMismatchException;
12
13			/**
14			* @property-read WP_Term $term
15			*
16			* @property int $term_id
17			* @property string $name
18			* @property string $slug
19			* @property string $term_group
20			* @property int $term_taxonomy_id
21			* @property string $taxonomy
22			* @property string $description
23			* @property int $parent
24			* @property int $count
25			*/
26			abstract class Model extends BaseModel
27			{
28			/**
29			* The term's taxonomy
30			* @var string
31			*/
32			const TAXONOMY = '';
33
34			/**
35			* The object type in WordPress
36			* @var string
37			*/
38			const OBJECT_TYPE = 'term';
39
40			/**
41			* The primary ID property on the object
42			*/
43			const ID_PROPERTY = 'term_id';
44
45			/**
46			* Model Constructor.
47			*
48			* @param mixed $term WP_Term to fill data from
49			*
50			* @throws TaxonomyMismatchException
51			*/
52			public function __construct(WP_Term $term = null)
53			{
54			if (! $term) {
55			$term = new WP_Term(new stdClass);
56			$term->taxonomy = static::TAXONOMY;
57			} elseif ($term->taxonomy != static::TAXONOMY) {
58			throw new TaxonomyMismatchException();
59			}
60
61			$this->object = $term;
62			}
63
64			/**
65			* Create a new instance from a WP_Term object.
66			*
67			* @param WP_Term $term [description]
68			*
69			* @return static
70			*/
71			public static function fromWpTerm(WP_Term $term)
72			{
73			return new static($term);
74			}
75
76			/**
77			* Create a new instance from a term ID.
78			*
79			* @param int\|string $id Term ID
80			*
81			* @throws TermNotFoundException
82			*
83			* @return static
84			*/
85			public static function fromID($id)
			1 ignored issue – show Duplication introduced 2016-07-04 12:10 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
86			{
87			if (! $term = get_term_by('id', (int) $id, static::TAXONOMY)) {
88			throw new TermNotFoundException("No term found with ID $id.");
89			}
90
91			return static::fromWpTerm($term);
92			}
93
94			/**
95			* Create a new instance from a slug.
96			*
97			* @param string $slug Term slug
98			*
99			* @throws TermNotFoundException
100			*
101			* @return static
102			*/
103			public static function fromSlug($slug)
			1 ignored issue – show Duplication introduced 2016-07-04 12:10 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
104			{
105			if (! $term = get_term_by('slug', $slug, static::TAXONOMY)) {
106			throw new TermNotFoundException("No term found with slug '$slug'.");
107			}
108
109			return static::fromWpTerm($term);
110			}
111
112			/**
113			* Create a new instance from an array of attributes.
114			*
115			* @param array $attributes [description]
116			*
117			* @return static
118			*/
119			public static function fromArray(array $attributes)
120			{
121			return new static(
122			new WP_Term((object) $attributes)
123			);
124			}
125
126			/**
127			* Create a new term, and get the instance for it.
128			*
129			* @param array $attributes Term attributes
130			*
131			* @return static
132			*/
133			public static function create(array $attributes = [])
134			{
135			return static::fromArray(
136			Collection::make($attributes)
137			->except([static::ID_PROPERTY, 'term_taxonomy_id'])
138			->put('taxonomy', static::TAXONOMY)
139			->toArray()
140			)->save();
141			}
142
143			/**
144			* Check if this term exists in the database.
145			*
146			* @return boolean
147			*/
148			public function exists()
149			{
150			return $this->id && ((bool) term_exists((int) $this->id, static::TAXONOMY));
151			}
152
153			/**
154			* Check if this term exists in the database as the child of the given parent.
155			*
156			* @param int\|string\|object $parent integer Parent term ID
157			* string Parent term slug or name
158			* object The parent term object/model.
159			*
160			* @return boolean True if the this term and the parent
161			* exist in the database, and the instance
162			* is a child of the given parent;
163			* otherwise false
164			*/
165			public function isChildOf($parent)
166			{
167			if (isset($parent->term_id)) {
168			$parent = $parent->term_id;
169			}
170
171			return (bool) term_exists((int) $this->id, static::TAXONOMY, $parent);
172			}
173
174			/**
175			* Get the parent term instance.
176			*
177			* @return static
178			*/
179			public function parent()
180			{
181			return static::fromID($this->object->parent);
182			}
183
184			/**
185			* Get all ancestors of this term as a collection.
186			*
187			* @return Collection
188			*/
189			public function ancestors()
190			{
191			return Collection::make(get_ancestors($this->id, static::TAXONOMY, 'taxonomy'))
192			->map(function ($term_ID) {
193			return static::fromID($term_ID);
194			});
195			}
196
197			/**
198			* Get the taxonomy identifier for the model.
199			*
200			* @return string
201			*/
202			public static function typeId()
203			{
204			return static::taxonomy()->id;
205			}
206
207			/**
208			* Get the Taxonomy model.
209			*
210			* @return Taxonomy\|\Silk\Taxonomy\Builder
211			*/
212			public static function taxonomy()
213			{
214			return Taxonomy::make(static::TAXONOMY);
215			}
216
217			/**
218			* Start a new query for terms of this type.
219			*
220			* @return QueryBuilder
221			*/
222			public function newQuery()
223			{
224			return (new QueryBuilder)->setModel($this);
225			}
226
227			/**
228			* Get the array of actions and their respective handler classes.
229			*
230			* @return array
231			*/
232			protected function actionClasses()
233			{
234			return [
235			'save' => Action\TermSaver::class,
236			'load' => Action\TermLoader::class,
237			'delete' => Action\TermDeleter::class,
238			];
239			}
240			}
241

aaemnnosttv / silk

Pull Request — master (#20)

Model::newQuery() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like