BlogCategory::validate() - Code Metrics - Inspection of "Merge pull request #372 from micmania1/271-prevent..." - silverstripe/silverstripe-blog - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 067f41...e7ef92 )

by Damian

created 2016-02-09 01:56 UTC

BlogCategory::validate() B

↳ Parent: BlogCategory

Complexity

Conditions	6
Paths	6

Size

Total Lines	21
Code Lines	14

Duplication

Lines	21
Ratio	100 %

Metric	Value
dl	21
loc	21
rs	8.7624
cc	6
eloc	14
nc	6
nop	0

<?php

/**
 * A blog category for generalising blog posts.
 *
 * @package silverstripe
 * @subpackage blog
 *
 * @method Blog Blog()
 *
 * @property string $URLSegment
 * @property int $BlogID
 */
class BlogCategory extends DataObject implements CategorisationObject
namespace YourVendor;

class YourClass { }
{

    /**
     * Use an exception code so that attempted writes can continue on
     * duplicate errors.
     *
     * @const string
     * This must be a string because ValidationException has decided we can't use int
     */
    const DUPLICATE_EXCEPTION = "DUPLICATE";

    /**
     * @var array
     */
    private static $db = array(

        'Title' => 'Varchar(255)',
    );

    /**
     * @var array
     */
    private static $has_one = array(

        'Blog' => 'Blog',
    );

    /**
     * @var array
     */
    private static $belongs_many_many = array(

        'BlogPosts' => 'BlogPost',
    );

    /**
     * @var array
     */
    private static $extensions = array(

        'URLSegmentExtension',
    );

    /**
     * @return DataList
     */
    public function BlogPosts()
    {
        $blogPosts = parent::BlogPosts();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

        $this->extend("updateGetBlogPosts", $blogPosts);

        return $blogPosts;
    }

    /**
     * {@inheritdoc}
     */
    public function getCMSFields()
    {
        $fields = new FieldList(
            TextField::create('Title', _t('BlogCategory.Title', 'Title'))
        );

        $this->extend('updateCMSFields', $fields);

        return $fields;
    }

    /**
     * {@inheritdoc}
     */
    protected function validate()
    {
        $validation = parent::validate();
        if($validation->valid()) {
            // Check for duplicate categories
            $blog = $this->Blog();
            if($blog && $blog->exists()) {
                $existing = $blog->Categories()->filter('Title', $this->Title);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                if($this->ID) {
                    $existing = $existing->exclude('ID', $this->ID);
                }
                if($existing->count() > 0) {
                    $validation->error(_t(
                        'BlogCategory.Duplicate',
                        'A blog category already exists with that name'
                    ), BlogCategory::DUPLICATE_EXCEPTION);
                }
            }
        }
        return $validation;
    }

    /**
     * Returns a relative link to this category.
     *
     * @return string
     */
    public function getLink()
    {
        return Controller::join_links($this->Blog()->Link(), 'category', $this->URLSegment);
    }

    /**
     * Inherits from the parent blog or can be overwritten using a DataExtension.
     *
     * @param null|Member $member
     *
     * @return bool
     */
    public function canView($member = null)
    {
        $extended = $this->extendedCan(__FUNCTION__, $member);
function notNullable(stdClass $x) { }

// Unsafe
function withoutCheck(stdClass $x = null) {
    notNullable($x);
}

// Safe - Alternative 1: Adding Additional Type-Check
function withCheck(stdClass $x = null) {
    if ($x instanceof stdClass) {
        notNullable($x);
    }
}

// Safe - Alternative 2: Changing Parameter
function withNonNullableParam(stdClass $x) {
    notNullable($x);
}

        if ($extended !== null) {
            return $extended;
        }

        return $this->Blog()->canView($member);
    }

    /**
     * Inherits from the parent blog or can be overwritten using a DataExtension.
     *
     * @param null|Member $member
     *
     * @return bool
     */
    public function canCreate($member = null)
    {
        $extended = $this->extendedCan(__FUNCTION__, $member);
function notNullable(stdClass $x) { }

// Unsafe
function withoutCheck(stdClass $x = null) {
    notNullable($x);
}

// Safe - Alternative 1: Adding Additional Type-Check
function withCheck(stdClass $x = null) {
    if ($x instanceof stdClass) {
        notNullable($x);
    }
}

// Safe - Alternative 2: Changing Parameter
function withNonNullableParam(stdClass $x) {
    notNullable($x);
}

        if ($extended !== null) {
            return $extended;
        }

        $permission = Blog::config()->grant_user_permission;

        return Permission::checkMember($member, $permission);
    }

    /**
     * Inherits from the parent blog or can be overwritten using a DataExtension.
     *
     * @param null|Member $member
     *
     * @return bool
     */
    public function canDelete($member = null)
    {
        $extended = $this->extendedCan(__FUNCTION__, $member);
function notNullable(stdClass $x) { }

// Unsafe
function withoutCheck(stdClass $x = null) {
    notNullable($x);
}

// Safe - Alternative 1: Adding Additional Type-Check
function withCheck(stdClass $x = null) {
    if ($x instanceof stdClass) {
        notNullable($x);
    }
}

// Safe - Alternative 2: Changing Parameter
function withNonNullableParam(stdClass $x) {
    notNullable($x);
}

        if ($extended !== null) {
            return $extended;
        }

        return $this->Blog()->canEdit($member);
    }

    /**
     * Inherits from the parent blog or can be overwritten using a DataExtension.
     *
     * @param null|Member $member
     *
     * @return bool
     */
    public function canEdit($member = null)
    {
        $extended = $this->extendedCan(__FUNCTION__, $member);
function notNullable(stdClass $x) { }

// Unsafe
function withoutCheck(stdClass $x = null) {
    notNullable($x);
}

// Safe - Alternative 1: Adding Additional Type-Check
function withCheck(stdClass $x = null) {
    if ($x instanceof stdClass) {
        notNullable($x);
    }
}

// Safe - Alternative 2: Changing Parameter
function withNonNullableParam(stdClass $x) {
    notNullable($x);
}

        if ($extended !== null) {
            return $extended;
        }

        return $this->Blog()->canEdit($member);
    }
}


1		<?php
2
3		/**
4		* A blog category for generalising blog posts.
5		*
6		* @package silverstripe
7		* @subpackage blog
8		*
9		* @method Blog Blog()
10		*
11		* @property string $URLSegment
12		* @property int $BlogID
13		*/
14	View Code Duplication	class BlogCategory extends DataObject implements CategorisationObject
		0 ignored issues – show Duplication introduced 2015-11-20 23:49 UTC by Report Bug Copy Issue Report This class 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... Coding Style Compatibility introduced 2015-11-20 23:49 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
15		{
16
17		/**
18		* Use an exception code so that attempted writes can continue on
19		* duplicate errors.
20		*
21		* @const string
22		* This must be a string because ValidationException has decided we can't use int
23		*/
24		const DUPLICATE_EXCEPTION = "DUPLICATE";
25
26		/**
27		* @var array
28		*/
29		private static $db = array(
		0 ignored issues – show Comprehensibility introduced 2015-11-20 23:49 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2015-11-20 23:49 UTC by Report Bug Copy Issue Report The property `$db` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
30		'Title' => 'Varchar(255)',
31		);
32
33		/**
34		* @var array
35		*/
36		private static $has_one = array(
		0 ignored issues – show Comprehensibility introduced 2015-11-20 23:49 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2015-11-20 23:49 UTC by Report Bug Copy Issue Report The property `$has_one` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
37		'Blog' => 'Blog',
38		);
39
40		/**
41		* @var array
42		*/
43		private static $belongs_many_many = array(
		0 ignored issues – show Comprehensibility introduced 2015-11-20 23:49 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2015-11-20 23:49 UTC by Report Bug Copy Issue Report The property `$belongs_many_many` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
44		'BlogPosts' => 'BlogPost',
45		);
46
47		/**
48		* @var array
49		*/
50		private static $extensions = array(
		0 ignored issues – show Comprehensibility introduced 2015-11-20 23:49 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2015-11-20 23:49 UTC by Report Bug Copy Issue Report The property `$extensions` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
51		'URLSegmentExtension',
52		);
53
54		/**
55		* @return DataList
56		*/
57		public function BlogPosts()
58		{
59		$blogPosts = parent::BlogPosts();
		0 ignored issues – show Bug introduced 2015-11-20 23:49 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `DataObject` as the method `BlogPosts()` does only exist in the following sub-classes of `DataObject`: `BlogCategory`, `BlogTag`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
60
61		$this->extend("updateGetBlogPosts", $blogPosts);
62
63		return $blogPosts;
64		}
65
66		/**
67		* {@inheritdoc}
68		*/
69		public function getCMSFields()
70		{
71		$fields = new FieldList(
72		TextField::create('Title', _t('BlogCategory.Title', 'Title'))
73		);
74
75		$this->extend('updateCMSFields', $fields);
76
77		return $fields;
78		}
79
80		/**
81		* {@inheritdoc}
82		*/
83		protected function validate()
84		{
85		$validation = parent::validate();
86		if($validation->valid()) {
87		// Check for duplicate categories
88		$blog = $this->Blog();
89		if($blog && $blog->exists()) {
90		$existing = $blog->Categories()->filter('Title', $this->Title);
		0 ignored issues – show Documentation introduced 2016-02-05 00:37 UTC by Report Bug Copy Issue Report The property `Title` does not exist on `object<BlogCategory>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
91		if($this->ID) {
92		$existing = $existing->exclude('ID', $this->ID);
93		}
94		if($existing->count() > 0) {
95		$validation->error(_t(
96		'BlogCategory.Duplicate',
97		'A blog category already exists with that name'
98		), BlogCategory::DUPLICATE_EXCEPTION);
99		}
100		}
101		}
102		return $validation;
103		}
104
105		/**
106		* Returns a relative link to this category.
107		*
108		* @return string
109		*/
110		public function getLink()
111		{
112		return Controller::join_links($this->Blog()->Link(), 'category', $this->URLSegment);
113		}
114
115		/**
116		* Inherits from the parent blog or can be overwritten using a DataExtension.
117		*
118		* @param null\|Member $member
119		*
120		* @return bool
121		*/
122		public function canView($member = null)
123		{
124		$extended = $this->extendedCan(__FUNCTION__, $member);
		0 ignored issues – show Bug introduced 2016-02-05 23:24 UTC by Report Bug Copy Issue Report It seems like `$member` defined by parameter `$member` on line `122` can be `null`; however, `DataObject::extendedCan()` does not accept `null`, maybe add an additional type check? It seems like you allow that null is being passed for a parameter, however the function which is called does not seem to accept null. We recommend to add an additional type check (or disallow null for the parameter): function notNullable(stdClass $x) { } // Unsafe function withoutCheck(stdClass $x = null) { notNullable($x); } // Safe - Alternative 1: Adding Additional Type-Check function withCheck(stdClass $x = null) { if ($x instanceof stdClass) { notNullable($x); } } // Safe - Alternative 2: Changing Parameter function withNonNullableParam(stdClass $x) { notNullable($x); } Loading history...
125
126		if ($extended !== null) {
127		return $extended;
128		}
129
130		return $this->Blog()->canView($member);
131		}
132
133		/**
134		* Inherits from the parent blog or can be overwritten using a DataExtension.
135		*
136		* @param null\|Member $member
137		*
138		* @return bool
139		*/
140		public function canCreate($member = null)
141		{
142		$extended = $this->extendedCan(__FUNCTION__, $member);
		0 ignored issues – show Bug introduced 2016-02-05 23:24 UTC by Report Bug Copy Issue Report It seems like `$member` defined by parameter `$member` on line `140` can be `null`; however, `DataObject::extendedCan()` does not accept `null`, maybe add an additional type check? It seems like you allow that null is being passed for a parameter, however the function which is called does not seem to accept null. We recommend to add an additional type check (or disallow null for the parameter): function notNullable(stdClass $x) { } // Unsafe function withoutCheck(stdClass $x = null) { notNullable($x); } // Safe - Alternative 1: Adding Additional Type-Check function withCheck(stdClass $x = null) { if ($x instanceof stdClass) { notNullable($x); } } // Safe - Alternative 2: Changing Parameter function withNonNullableParam(stdClass $x) { notNullable($x); } Loading history...
143
144		if ($extended !== null) {
145		return $extended;
146		}
147
148		$permission = Blog::config()->grant_user_permission;
149
150		return Permission::checkMember($member, $permission);
151		}
152
153		/**
154		* Inherits from the parent blog or can be overwritten using a DataExtension.
155		*
156		* @param null\|Member $member
157		*
158		* @return bool
159		*/
160		public function canDelete($member = null)
161		{
162		$extended = $this->extendedCan(__FUNCTION__, $member);
		0 ignored issues – show Bug introduced 2016-02-05 23:24 UTC by Report Bug Copy Issue Report It seems like `$member` defined by parameter `$member` on line `160` can be `null`; however, `DataObject::extendedCan()` does not accept `null`, maybe add an additional type check? It seems like you allow that null is being passed for a parameter, however the function which is called does not seem to accept null. We recommend to add an additional type check (or disallow null for the parameter): function notNullable(stdClass $x) { } // Unsafe function withoutCheck(stdClass $x = null) { notNullable($x); } // Safe - Alternative 1: Adding Additional Type-Check function withCheck(stdClass $x = null) { if ($x instanceof stdClass) { notNullable($x); } } // Safe - Alternative 2: Changing Parameter function withNonNullableParam(stdClass $x) { notNullable($x); } Loading history...
163
164		if ($extended !== null) {
165		return $extended;
166		}
167
168		return $this->Blog()->canEdit($member);
169		}
170
171		/**
172		* Inherits from the parent blog or can be overwritten using a DataExtension.
173		*
174		* @param null\|Member $member
175		*
176		* @return bool
177		*/
178		public function canEdit($member = null)
179		{
180		$extended = $this->extendedCan(__FUNCTION__, $member);
		0 ignored issues – show Bug introduced 2016-02-05 23:24 UTC by Report Bug Copy Issue Report It seems like `$member` defined by parameter `$member` on line `178` can be `null`; however, `DataObject::extendedCan()` does not accept `null`, maybe add an additional type check? It seems like you allow that null is being passed for a parameter, however the function which is called does not seem to accept null. We recommend to add an additional type check (or disallow null for the parameter): function notNullable(stdClass $x) { } // Unsafe function withoutCheck(stdClass $x = null) { notNullable($x); } // Safe - Alternative 1: Adding Additional Type-Check function withCheck(stdClass $x = null) { if ($x instanceof stdClass) { notNullable($x); } } // Safe - Alternative 2: Changing Parameter function withNonNullableParam(stdClass $x) { notNullable($x); } Loading history...
181
182		if ($extended !== null) {
183		return $extended;
184		}
185
186		return $this->Blog()->canEdit($member);
187		}
188		}
189

silverstripe / silverstripe-blog

Push — master ( 067f41...e7ef92 )

BlogCategory::validate() B

Complexity

Size

Duplication

Available Fixes

Duplication Side-by-Side

Filter issues like