PostType::object() - Code Metrics - Inspection of "replace WP_Query usage with interface and Post\Que..." - aaemnnosttv/silk - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — develop (73bc23)

by Evan

created 2016-07-12 14:18 UTC

PostType::object() A

↳ Parent: PostType

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
cc	1
eloc	2
nc	1
nop	0
rs	10

<?php

namespace Silk\PostType;

use stdClass;
use Illuminate\Support\Collection;
use Silk\Exception\WP_ErrorException;
use Silk\PostType\Exception\NonExistentPostTypeException;
use Silk\PostType\Builder;

/**
 * @property-read string $id
 * @property-read string $slug
 * @property-read string $one
 * @property-read string $many
 */
class PostType
{
    /**
     * Post type object
     * @var stdClass
     */
    protected $object;

    /**
     * PostType Constructor
     *
     * @param stdClass $object  The WordPress post type object
     */
    public function __construct(stdClass $object)
    {
        $this->object = $object;
    }

    /**
     * Create a new instance using the post type slug.
     *
     * Loads an existing type, or returns a new builder for registering a new type.
     *
     * @param  string $slug  The post type slug
     *
     * @return static|PostTypeBuilder  If the post type has been registered, a new static instance is returned.
     *                                 Otherwise a new PostTypeBuilder is created for building a new post type to register.
     */
    public static function make($slug)
    {
        if (static::exists($slug)) {
            return static::load($slug);
        }

        return new Builder($slug);
    }

    /**
     * Create a new instance from an existing type.
     *
     * @param  string $slug  The post type slug
     *
     * @return static
     */
    public static function load($slug)
    {
        if (! $object = get_post_type_object($slug)) {
            throw new NonExistentPostTypeException("No post type exists with name '$slug'.");
        }

        return new static($object);
    }

    /**
     * Checks if a post type with this slug has been registered.
     *
     * @param string $slug  The post type slug
     *
     * @return bool
     */
    public static function exists($slug)
    {
        return post_type_exists($slug);
    }

    /**
     * Get the post type object.
     *
     * @return object
     */
    public function object()
    {
        return $this->object;
    }

    /**
     * Check for feature support.
     *
     * @param string,...|array $features  string - First feature of possible many,

     *                                    array - Many features to check support for.
     *
     * @return mixed
     */
    public function supports($features)
    {
        if (! is_array($features)) {
            $features = func_get_args();

        }

        return ! Collection::make($features)
            ->contains(function ($key, $feature) {
                return ! post_type_supports($this->slug, $feature);
            });
    }

    /**
     * Register support of certain features for an existing post type.
     *
     * @param mixed $features  string - single feature to add
     *                        array - multiple features to add
     */
    public function addSupportFor($features)
    {
        add_post_type_support($this->slug, is_array($features) ? $features : func_get_args());

        return $this;
    }

    /**
     * Deregister support of certain features for an existing post type.
     *
     * @param mixed $features  string - single feature to remove
     *                        array - multiple features to remove
     */
    public function removeSupportFor($features)
    {
        Collection::make(is_array($features) ? $features : func_get_args())
            ->each(function ($features) {
                remove_post_type_support($this->slug, $features);
            });

        return $this;
    }

    /**
     * Unregister the post type
     *
     * @return $this
     */
    public function unregister()
    {
        if (! static::exists($this->slug)) {
            throw new NonExistentPostTypeException("No post type exists with name '{$this->slug}'.");
        }

        if (is_wp_error($error = unregister_post_type($this->slug))) {
            throw new WP_ErrorException($error);
        }

        return $this;
    }

    /**
     * Magic Getter.
     *
     * @param  string $property  Accessed property name
     *
     * @return mixed
     */
    public function __get($property)
    {
        $default = isset($this->object->$property)
            ? $this->object->$property
            : null;

        return Collection::make([
            'id'   => $this->object->name,
            'slug' => $this->object->name,
            'one'  => $this->object->labels->singular_name,
            'many' => $this->object->labels->name,
        ])->get($property, $default);
    }

    /**
     * Magic Isset Check.
     *
     * @param  string  $property Queried property name
     *
     * @return boolean
     */
    public function __isset($property)
    {
        return ! is_null($this->__get($property));
    }
}


1			<?php
2
3			namespace Silk\PostType;
4
5			use stdClass;
6			use Illuminate\Support\Collection;
7			use Silk\Exception\WP_ErrorException;
8			use Silk\PostType\Exception\NonExistentPostTypeException;
9			use Silk\PostType\Builder;
10
11			/**
12			* @property-read string $id
13			* @property-read string $slug
14			* @property-read string $one
15			* @property-read string $many
16			*/
17			class PostType
18			{
19			/**
20			* Post type object
21			* @var stdClass
22			*/
23			protected $object;
24
25			/**
26			* PostType Constructor
27			*
28			* @param stdClass $object The WordPress post type object
29			*/
30			public function __construct(stdClass $object)
31			{
32			$this->object = $object;
33			}
34
35			/**
36			* Create a new instance using the post type slug.
37			*
38			* Loads an existing type, or returns a new builder for registering a new type.
39			*
40			* @param string $slug The post type slug
41			*
42			* @return static\|PostTypeBuilder If the post type has been registered, a new static instance is returned.
43			* Otherwise a new PostTypeBuilder is created for building a new post type to register.
44			*/
45			public static function make($slug)
46			{
47			if (static::exists($slug)) {
48			return static::load($slug);
49			}
50
51			return new Builder($slug);
52			}
53
54			/**
55			* Create a new instance from an existing type.
56			*
57			* @param string $slug The post type slug
58			*
59			* @return static
60			*/
61			public static function load($slug)
62			{
63			if (! $object = get_post_type_object($slug)) {
64			throw new NonExistentPostTypeException("No post type exists with name '$slug'.");
65			}
66
67			return new static($object);
68			}
69
70			/**
71			* Checks if a post type with this slug has been registered.
72			*
73			* @param string $slug The post type slug
74			*
75			* @return bool
76			*/
77			public static function exists($slug)
78			{
79			return post_type_exists($slug);
80			}
81
82			/**
83			* Get the post type object.
84			*
85			* @return object
86			*/
87			public function object()
88			{
89			return $this->object;
90			}
91
92			/**
93			* Check for feature support.
94			*
95			* @param string,...\|array $features string - First feature of possible many,
			0 ignored issues – show Documentation introduced 2016-06-25 08:47 UTC by Report Bug Copy Issue Report The doc-type `string,...\|array` could not be parsed: Expected "\|" or "end of type", but got "," at position 6. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
96			* array - Many features to check support for.
97			*
98			* @return mixed
99			*/
100			public function supports($features)
101			{
102			if (! is_array($features)) {
103			$features = func_get_args();
			0 ignored issues – show Coding Style introduced 2016-07-12 14:21 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$features`. This often makes code more readable. Loading history...
104			}
105
106			return ! Collection::make($features)
107			->contains(function ($key, $feature) {
108			return ! post_type_supports($this->slug, $feature);
109			});
110			}
111
112			/**
113			* Register support of certain features for an existing post type.
114			*
115			* @param mixed $features string - single feature to add
116			* array - multiple features to add
117			*/
118			public function addSupportFor($features)
119			{
120			add_post_type_support($this->slug, is_array($features) ? $features : func_get_args());
121
122			return $this;
123			}
124
125			/**
126			* Deregister support of certain features for an existing post type.
127			*
128			* @param mixed $features string - single feature to remove
129			* array - multiple features to remove
130			*/
131			public function removeSupportFor($features)
132			{
133			Collection::make(is_array($features) ? $features : func_get_args())
134			->each(function ($features) {
135			remove_post_type_support($this->slug, $features);
136			});
137
138			return $this;
139			}
140
141			/**
142			* Unregister the post type
143			*
144			* @return $this
145			*/
146			public function unregister()
147			{
148			if (! static::exists($this->slug)) {
149			throw new NonExistentPostTypeException("No post type exists with name '{$this->slug}'.");
150			}
151
152			if (is_wp_error($error = unregister_post_type($this->slug))) {
153			throw new WP_ErrorException($error);
154			}
155
156			return $this;
157			}
158
159			/**
160			* Magic Getter.
161			*
162			* @param string $property Accessed property name
163			*
164			* @return mixed
165			*/
166			public function __get($property)
167			{
168			$default = isset($this->object->$property)
169			? $this->object->$property
170			: null;
171
172			return Collection::make([
173			'id' => $this->object->name,
174			'slug' => $this->object->name,
175			'one' => $this->object->labels->singular_name,
176			'many' => $this->object->labels->name,
177			])->get($property, $default);
178			}
179
180			/**
181			* Magic Isset Check.
182			*
183			* @param string $property Queried property name
184			*
185			* @return boolean
186			*/
187			public function __isset($property)
188			{
189			return ! is_null($this->__get($property));
190			}
191			}
192

aaemnnosttv / silk

Branch — develop (73bc23)

PostType::object() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like