Abbreviation - Code Metrics - wernerkrauss/silverstripe-explainable - Measure and Improve Code Quality continuously with Scrutinizer

Abbreviation A
last analyzed 2016-03-23 17:11 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	134
Duplicated Lines	15.67 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
wmc	23
c	2
b	0
f	0
lcom	1
cbo	7
dl	21
loc	134
rs	10

10 Methods

Rating	Name	Duplication	Size	Complexity
A	getCMSFields()	0	6	1
A	Slug()	0	5	3
B	onBeforeWrite()	0	17	6
A	Link()	0	4	1
A	AbsoluteLink()	0	4	1
A	forTemplate()	0	5	1
A	getMenuTitle()	0	4	1
A	getTitleFirstLetter()	0	4	1
B	parse_shortcode()	21	21	7
A	shortcode_attribute_fields()	0	4	1

How to fix Duplicated Code

<?php

class Abbreviation extends DataObject implements Shortcodable
namespace YourVendor;

class YourClass { }
{

    private static $db = array(

        'Title' => 'Varchar(255)',
        'Description' => 'Varchar(255)',
        'URLSlug' => 'Varchar(255)',
        'Explanation' => 'HTMLText'
    );

    private static $has_one = array(

        'Page' => 'Page'
    );

    private static $singular_name = 'Abbreviation';


    private static $plural_name = 'Abbreviations';


    private static $summary_fields = array('Title', 'Description');


    private static $searchable_fields = array('Title', 'Description');


    public function getCMSFields()
    {
        $fields = parent::getCMSFields();
        $fields->removeByName('URLSlug');
        return $fields;
    }

    /**
     * Taken from https://github.com/NightJar/ssrigging-slug/blob/master/code/Slug.php
     */
    public function Slug($regen=false)

    {
        $existing = $this->URLSlug;
<?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.");
        }
    }

}
        return $existing && !$regen ? $existing : URLSegmentFilter::create()->filter($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.");
        }
    }

}
    }

    /**
     * Taken from https://github.com/NightJar/ssrigging-slug/blob/master/code/Slug.php
     */
    public function onBeforeWrite()
    {
        parent::onBeforeWrite();
        if ($this->isChanged('URLSlug') || !$this->URLSlug || $this->isChanged($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.");
        }
    }

}
            $this->URLSlug = $this->Slug();
<?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.");
        }
    }

}
            $class = $this->class;
            $filter = array('URLSlug' => $this->URLSlug);
<?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 ($parent = $this->parentRel) {
<?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.");
        }
    }

}
                $filter[$parent] = $this->$parent;
            }
            $count = 1;
            while ($exists = $class::get()->filter($filter)->exclude('ID', $this->ID)->exists()) {
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
                $this->URLSlug = $this->URLSlug.$count++;
<?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.");
        }
    }

}
                $filter['URLSlug'] = $this->URLSlug;
<?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 Link()
    {
        return Controller::join_links($this->Page()->Link(), $this->URLSlug);
<?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 AbsoluteLink()
    {
        return Director::absoluteURL($this->Link());
    }

    public function forTemplate()
    {
        $template = new SSViewer('Abbreviation');
        return $template->process($this);
    }


    /**
     * Used for Breadcrumbs
     *
     * @return DBField
     */
    public function getMenuTitle()
    {
        return $this->dbObject('Title');
    }

    /**
     * Returns the first letter of the module title, used for grouping.
     * @return string
     */
    public function getTitleFirstLetter()
    {
        return strtoupper($this->Title[0]);
<?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.");
        }
    }

}
    }

    /**
     * Parse the shortcode and render as a string, probably with a template
     * @param array $arguments the list of attributes of the shortcode
     * @param string $content the shortcode content
     * @param ShortcodeParser $parser the ShortcodeParser instance
     * @param string $shortcode the raw shortcode being parsed
     * @return String

     **/
    public static function parse_shortcode($arguments, $content, $parser, $shortcode)

    {
        if (empty($arguments['id'])) {
            return;
        }

        if (array_key_exists('id', $arguments) && $arguments['id']) {
            $abbreviation = Abbreviation::get()->byID($arguments['id']);
        }

        if (!$abbreviation) {
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
            return;
        }

        if (array_key_exists('title', $arguments) && $arguments['title']) {
            $abbreviation->Title = $arguments['title'];
        }

        $template = new SSViewer('AbbreviationShortcode');
        return $template->process($abbreviation);
    }

    /**
     * returns a list of fields for editing the shortcode's attributes
     * @return Fieldlist

     **/
    public static function shortcode_attribute_fields()
    {
        //@todo use addnew field to add a new abbr. on the fly
    }
}


1		<?php
2
3		class Abbreviation extends DataObject implements Shortcodable
		0 ignored issues – show Coding Style Compatibility introduced 2016-03-23 17:09 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
6		private static $db = array(
		0 ignored issues – show Comprehensibility introduced 2016-03-23 17:09 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 2016-03-23 17:09 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...
7		'Title' => 'Varchar(255)',
8		'Description' => 'Varchar(255)',
9		'URLSlug' => 'Varchar(255)',
10		'Explanation' => 'HTMLText'
11		);
12
13		private static $has_one = array(
		0 ignored issues – show Comprehensibility introduced 2016-03-23 17:09 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 2016-03-23 17:09 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...
14		'Page' => 'Page'
15		);
16
17		private static $singular_name = 'Abbreviation';
		0 ignored issues – show Comprehensibility introduced 2016-03-23 17:09 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 2016-03-23 17:09 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...
18
19		private static $plural_name = 'Abbreviations';
		0 ignored issues – show Comprehensibility introduced 2016-03-23 17:09 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 2016-03-23 17:09 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...
20
21		private static $summary_fields = array('Title', 'Description');
		0 ignored issues – show Comprehensibility introduced 2016-03-23 17:09 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 2016-03-23 17:09 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...
22
23		private static $searchable_fields = array('Title', 'Description');
		0 ignored issues – show Comprehensibility introduced 2016-03-23 17:09 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 2016-03-23 17:09 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...
24
25		public function getCMSFields()
26		{
27		$fields = parent::getCMSFields();
28		$fields->removeByName('URLSlug');
29		return $fields;
30		}
31
32		/**
33		* Taken from https://github.com/NightJar/ssrigging-slug/blob/master/code/Slug.php
34		*/
35		public function Slug($regen=false)
		0 ignored issues – show Documentation introduced 2016-03-23 17:09 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...
36		{
37		$existing = $this->URLSlug;
		0 ignored issues – show Documentation introduced 2016-03-23 17:09 UTC by Report Bug Copy Issue Report The property `URLSlug` does not exist on `object<Abbreviation>`. 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...
38		return $existing && !$regen ? $existing : URLSegmentFilter::create()->filter($this->Title);
		0 ignored issues – show Documentation introduced 2016-03-23 17:09 UTC by Report Bug Copy Issue Report The property `Title` does not exist on `object<Abbreviation>`. 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...
39		}
40
41		/**
42		* Taken from https://github.com/NightJar/ssrigging-slug/blob/master/code/Slug.php
43		*/
44		public function onBeforeWrite()
45		{
46		parent::onBeforeWrite();
47		if ($this->isChanged('URLSlug') \|\| !$this->URLSlug \|\| $this->isChanged($this->Title)) {
		0 ignored issues – show Documentation introduced 2016-03-23 17:09 UTC by Report Bug Copy Issue Report The property `URLSlug` does not exist on `object<Abbreviation>`. 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... Documentation introduced 2016-03-23 17:09 UTC by Report Bug Copy Issue Report The property `Title` does not exist on `object<Abbreviation>`. 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...
48		$this->URLSlug = $this->Slug();
		0 ignored issues – show Documentation introduced 2016-03-23 17:09 UTC by Report Bug Copy Issue Report The property `URLSlug` does not exist on `object<Abbreviation>`. 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...
49		$class = $this->class;
50		$filter = array('URLSlug' => $this->URLSlug);
		0 ignored issues – show Documentation introduced 2016-03-23 17:09 UTC by Report Bug Copy Issue Report The property `URLSlug` does not exist on `object<Abbreviation>`. 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...
51		if ($parent = $this->parentRel) {
		0 ignored issues – show Documentation introduced 2016-03-23 17:09 UTC by Report Bug Copy Issue Report The property `parentRel` does not exist on `object<Abbreviation>`. 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...
52		$filter[$parent] = $this->$parent;
53		}
54		$count = 1;
55		while ($exists = $class::get()->filter($filter)->exclude('ID', $this->ID)->exists()) {
		0 ignored issues – show Unused Code introduced 2016-03-23 17:09 UTC by Report Bug Copy Issue Report `$exists` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
56		$this->URLSlug = $this->URLSlug.$count++;
		0 ignored issues – show Documentation introduced 2016-03-23 17:09 UTC by Report Bug Copy Issue Report The property `URLSlug` does not exist on `object<Abbreviation>`. 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... Documentation introduced 2016-03-23 17:09 UTC by Report Bug Copy Issue Report The property `URLSlug` does not exist on `object<Abbreviation>`. 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		$filter['URLSlug'] = $this->URLSlug;
		0 ignored issues – show Documentation introduced 2016-03-23 17:09 UTC by Report Bug Copy Issue Report The property `URLSlug` does not exist on `object<Abbreviation>`. 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...
58		}
59		}
60		}
61
62		public function Link()
63		{
64		return Controller::join_links($this->Page()->Link(), $this->URLSlug);
		0 ignored issues – show Documentation introduced 2016-03-23 17:09 UTC by Report Bug Copy Issue Report The property `URLSlug` does not exist on `object<Abbreviation>`. 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... Documentation Bug introduced 2016-03-23 17:09 UTC by Report Bug Copy Issue Report The method `Page` does not exist on `object<Abbreviation>`? 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...
65		}
66
67		public function AbsoluteLink()
68		{
69		return Director::absoluteURL($this->Link());
70		}
71
72		public function forTemplate()
73		{
74		$template = new SSViewer('Abbreviation');
75		return $template->process($this);
76		}
77
78
79		/**
80		* Used for Breadcrumbs
81		*
82		* @return DBField
83		*/
84		public function getMenuTitle()
85		{
86		return $this->dbObject('Title');
87		}
88
89		/**
90		* Returns the first letter of the module title, used for grouping.
91		* @return string
92		*/
93		public function getTitleFirstLetter()
94		{
95		return strtoupper($this->Title[0]);
		0 ignored issues – show Documentation introduced 2016-03-23 17:09 UTC by Report Bug Copy Issue Report The property `Title` does not exist on `object<Abbreviation>`. 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...
96		}
97
98		/**
99		* Parse the shortcode and render as a string, probably with a template
100		* @param array $arguments the list of attributes of the shortcode
101		* @param string $content the shortcode content
102		* @param ShortcodeParser $parser the ShortcodeParser instance
103		* @param string $shortcode the raw shortcode being parsed
104		* @return String
		0 ignored issues – show Documentation introduced 2016-03-23 17:09 UTC by Report Bug Copy Issue Report Should the return type not be `null\|HTMLText`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
105		**/
106	View Code Duplication	public static function parse_shortcode($arguments, $content, $parser, $shortcode)
		0 ignored issues – show Duplication introduced 2016-03-23 17:09 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...
107		{
108		if (empty($arguments['id'])) {
109		return;
110		}
111
112		if (array_key_exists('id', $arguments) && $arguments['id']) {
113		$abbreviation = Abbreviation::get()->byID($arguments['id']);
114		}
115
116		if (!$abbreviation) {
		0 ignored issues – show Bug introduced 2016-03-23 17:09 UTC by Report Bug Copy Issue Report The variable `$abbreviation` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
117		return;
118		}
119
120		if (array_key_exists('title', $arguments) && $arguments['title']) {
121		$abbreviation->Title = $arguments['title'];
122		}
123
124		$template = new SSViewer('AbbreviationShortcode');
125		return $template->process($abbreviation);
126		}
127
128		/**
129		* returns a list of fields for editing the shortcode's attributes
130		* @return Fieldlist
		0 ignored issues – show Documentation introduced 2016-03-23 17:09 UTC by Report Bug Copy Issue Report Should the return type not be `FieldList\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
131		**/
132		public static function shortcode_attribute_fields()
133		{
134		//@todo use addnew field to add a new abbr. on the fly
135		}
136		}
137

wernerkrauss / silverstripe-explainable

Abbreviation A last analyzed 2016-03-23 17:11 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

10 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Duplication Side-by-Side

Filter issues like

Abbreviation A
last analyzed 2016-03-23 17:11 UTC