ImageGalleryEntry::getBestTitle() - Code Metrics - Inspection of "PATCH: fixes" - sunnysideup/silverstripe-imagegallery_basic - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b12a44...de8c07 )

by Nicolaas

created 2018-08-21 23:56 UTC

ImageGalleryEntry::getBestTitle() A

↳ Parent: ImageGalleryEntry

Complexity

Conditions	5
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	14
rs	9.4888
c	0
b	0
f	0
cc	5
nc	4
nop	0

<?php

class ImageGalleryEntry extends DataObject
namespace YourVendor;

class YourClass { }
{
    private static $singular_name = "Image Gallery Picture";


    private static $plural_name = "Image Gallery Pictures";


    private static $db = array(

        "Title" => "Varchar(100)",
        "Sort" => "Int"
    );

    private static $has_one = array(

        "Parent" => "SiteTree",
        "Image" => "Image"
    );

    private static $searchable_fields = array(

        "Title" => "PartialMatchFilter"
    );

    private static $summary_fields = array(

        "Image.CMSThumbNail" => "Image",
        "Title" => "Title"
    );

    private static $field_labels = array(

        "Sort" => "Sorting Index Number (lower numbers show first)"
    );

    private static $casting = array(

        "BestTitle" => "Varchar"
    );

    //CRUD settings

    private static $default_sort = "Sort ASC, Title ASC";


    private static $defaults = array(

        "Sort" => 100
    );

    public function getBestTitle()

    {
        $image = $this->Image();
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 { }
        if($image && $image->exists()) {
            if($image->Title) {
                if($this->Title !== $image->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.");
        }
    }

}
                    $this->Title = $image->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.");
        }
    }

}
                    $this->write();
                }
                return $image->Title;
            }
        }
        return $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.");
        }
    }

}
    }

    public function populateDefaults()
    {
        parent::populateDefaults();
        $this->Sort = 100;
<?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.");
        }
    }

}
    }

    /**
     * CMS Fields
     * @return FieldList
     */
    public function getCMSFields()
    {
        $fields = parent::getCMSFields();
        $fields->removeFieldFromTab('Root.Main', 'Title');

        return $fields;
    }

}


1			<?php
2
3			class ImageGalleryEntry extends DataObject
			0 ignored issues – show Coding Style Compatibility introduced 2017-01-03 01:20 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...
4			{
5			private static $singular_name = "Image Gallery Picture";
			0 ignored issues – show Comprehensibility introduced 2017-01-03 01:20 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 2017-01-03 01:20 UTC by Report Bug Copy Issue Report The property `$singular_name` 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...
6
7			private static $plural_name = "Image Gallery Pictures";
			0 ignored issues – show Comprehensibility introduced 2017-01-03 01:20 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 2017-01-03 01:20 UTC by Report Bug Copy Issue Report The property `$plural_name` 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...
8
9			private static $db = array(
			0 ignored issues – show Comprehensibility introduced 2017-01-03 01:20 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 2017-01-03 01:20 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...
10			"Title" => "Varchar(100)",
11			"Sort" => "Int"
12			);
13
14			private static $has_one = array(
			0 ignored issues – show Comprehensibility introduced 2017-01-03 01:20 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 2017-01-03 01:20 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...
15			"Parent" => "SiteTree",
16			"Image" => "Image"
17			);
18
19			private static $searchable_fields = array(
			0 ignored issues – show Comprehensibility introduced 2017-01-03 01:20 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 2017-01-03 01:20 UTC by Report Bug Copy Issue Report The property `$searchable_fields` 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...
20			"Title" => "PartialMatchFilter"
21			);
22
23			private static $summary_fields = array(
			0 ignored issues – show Comprehensibility introduced 2017-01-03 01:20 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 2017-01-03 01:20 UTC by Report Bug Copy Issue Report The property `$summary_fields` 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...
24			"Image.CMSThumbNail" => "Image",
25			"Title" => "Title"
26			);
27
28			private static $field_labels = array(
			0 ignored issues – show Comprehensibility introduced 2017-01-03 01:20 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 2017-01-03 01:20 UTC by Report Bug Copy Issue Report The property `$field_labels` 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...
29			"Sort" => "Sorting Index Number (lower numbers show first)"
30			);
31
32			private static $casting = array(
			0 ignored issues – show Comprehensibility introduced 2018-08-21 23:57 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 2018-08-21 23:57 UTC by Report Bug Copy Issue Report The property `$casting` 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...
33			"BestTitle" => "Varchar"
34			);
35
36			//CRUD settings
37
38			private static $default_sort = "Sort ASC, Title ASC";
			0 ignored issues – show Comprehensibility introduced 2017-01-03 01:20 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 2017-01-03 01:20 UTC by Report Bug Copy Issue Report The property `$default_sort` 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...
39
40			private static $defaults = array(
			0 ignored issues – show Comprehensibility introduced 2017-01-03 01:20 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 2017-01-03 01:20 UTC by Report Bug Copy Issue Report The property `$defaults` 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...
41			"Sort" => 100
42			);
43
44			public function getBestTitle()
			0 ignored issues – show Documentation introduced 2018-08-21 23:57 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
45			{
46			$image = $this->Image();
			0 ignored issues – show Documentation Bug introduced 2018-08-21 23:57 UTC by Report Bug Copy Issue Report The method `Image` does not exist on `object<ImageGalleryEntry>`? 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...
47			if($image && $image->exists()) {
48			if($image->Title) {
49			if($this->Title !== $image->Title) {
			0 ignored issues – show Documentation introduced 2018-08-21 23:57 UTC by Report Bug Copy Issue Report The property `Title` does not exist on `object<ImageGalleryEntry>`. 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...
50			$this->Title = $image->Title;
			0 ignored issues – show Documentation introduced 2018-08-21 23:57 UTC by Report Bug Copy Issue Report The property `Title` does not exist on `object<ImageGalleryEntry>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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...
51			$this->write();
52			}
53			return $image->Title;
54			}
55			}
56			return $this->Title;
			0 ignored issues – show Documentation introduced 2018-08-21 23:57 UTC by Report Bug Copy Issue Report The property `Title` does not exist on `object<ImageGalleryEntry>`. 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...
57			}
58
59			public function populateDefaults()
60			{
61			parent::populateDefaults();
62			$this->Sort = 100;
			0 ignored issues – show Documentation introduced 2017-01-03 01:20 UTC by Report Bug Copy Issue Report The property `Sort` does not exist on `object<ImageGalleryEntry>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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...
63			}
64
65			/**
66			* CMS Fields
67			* @return FieldList
68			*/
69			public function getCMSFields()
70			{
71			$fields = parent::getCMSFields();
72			$fields->removeFieldFromTab('Root.Main', 'Title');
73
74			return $fields;
75			}
76
77			}
78

sunnysideup / silverstripe-imagegallery_basic

Push — master ( b12a44...de8c07 )

ImageGalleryEntry::getBestTitle() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like