GalleryImage::getCMSFields() - Code Metrics - Inspection of "Merge branch 'tests'" - gordonbanderson/ss3gallery - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 18f749...9fc766 )

by Gordon

created 2016-02-07 16:08 UTC

GalleryImage::getCMSFields() A

↳ Parent: GalleryImage

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	1

Metric	Value
dl	0
loc	10
ccs	8
cts	8
cp	1
rs	9.4285
cc	1
eloc	8
nc	1
nop	0
crap	1

<?php

class GalleryImage extends DataObject implements RenderableAsPortlet
namespace YourVendor;

class YourClass { }
{
    public static $db = array(
        'SortOrder' => 'Int',
        'Title' => 'Varchar',
    );

    // One-to-one relationship with gallery page
    public static $has_one = array(
        'Image' => 'Image',
        'GalleryPage' => 'GalleryPage',
    );

    // tidy up the CMS by not showing these fields
    public function getCMSFields()
    {
        $fields = parent::getCMSFields();
        $fields->removeFieldFromTab('Root.Main', 'GalleryPageID');
        $fields->removeFieldFromTab('Root.Main', 'ExifRead');
        $fields->removeFieldFromTab('Root.Main', 'SortOrder');
        $fields->renameField('Title', _t('GalleryImage.TITLE', 'Title'));
        $fields->renameField('Image', _t('GalleryImage.IMAGE', 'Image'));
        return $fields;
    }

    // Tell the datagrid what fields to show in the table
    public static $summary_fields = array(
        'ID' => 'ID',
        'Title' => 'Title',
        'Thumbnail' => 'Thumbnail',
    );

    // this function creates the thumnail for the summary fields to use
    public function getThumbnail()
    {
        return $this->Image()->CMSThumbnail();
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 { }
    }

    public function getPortletTitle()
    {
        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.");
        }
    }

}
    }

    /**
    * An accessor method for an image for a portlet.
    *
    * @example
    * <code>
    *  return $this->NewsItemImage;
    * </code>
    *
    * @return string
    */
    public function getPortletImage()
    {
        return $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 { }
    }

    /**
    * An accessor for text associated with the portlet.
    *
    * @example
    * <code>
    * return $this->Summary
    * </code>
    *
    * @return string
    */
    public function getPortletCaption()
    {
        return '';
    }
}


1		<?php
2
3		class GalleryImage extends DataObject implements RenderableAsPortlet
		0 ignored issues – show Coding Style Compatibility introduced 2016-01-20 09:21 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		public static $db = array(
6		'SortOrder' => 'Int',
7		'Title' => 'Varchar',
8		);
9
10		// One-to-one relationship with gallery page
11		public static $has_one = array(
12		'Image' => 'Image',
13		'GalleryPage' => 'GalleryPage',
14		);
15
16		// tidy up the CMS by not showing these fields
17	1	public function getCMSFields()
18		{
19	1	$fields = parent::getCMSFields();
20	1	$fields->removeFieldFromTab('Root.Main', 'GalleryPageID');
21	1	$fields->removeFieldFromTab('Root.Main', 'ExifRead');
22	1	$fields->removeFieldFromTab('Root.Main', 'SortOrder');
23	1	$fields->renameField('Title', _t('GalleryImage.TITLE', 'Title'));
24	1	$fields->renameField('Image', _t('GalleryImage.IMAGE', 'Image'));
25	1	return $fields;
26		}
27
28		// Tell the datagrid what fields to show in the table
29		public static $summary_fields = array(
30		'ID' => 'ID',
31		'Title' => 'Title',
32		'Thumbnail' => 'Thumbnail',
33		);
34
35		// this function creates the thumnail for the summary fields to use
36	1	public function getThumbnail()
37		{
38	1	return $this->Image()->CMSThumbnail();
		0 ignored issues – show Documentation Bug introduced 2016-02-02 11:13 UTC by Report Bug Copy Issue Report The method `Image` does not exist on `object<GalleryImage>`? 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...
39		}
40
41	1	public function getPortletTitle()
42		{
43	1	return $this->Title;
		0 ignored issues – show Documentation introduced 2016-02-02 11:13 UTC by Report Bug Copy Issue Report The property `Title` does not exist on `object<GalleryImage>`. 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...
44		}
45
46		/**
47		* An accessor method for an image for a portlet.
48		*
49		* @example
50		* <code>
51		* return $this->NewsItemImage;
52		* </code>
53		*
54		* @return string
55		*/
56	1	public function getPortletImage()
57		{
58	1	return $this->Image();
		0 ignored issues – show Documentation Bug introduced 2016-02-02 11:13 UTC by Report Bug Copy Issue Report The method `Image` does not exist on `object<GalleryImage>`? 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...
59		}
60
61		/**
62		* An accessor for text associated with the portlet.
63		*
64		* @example
65		* <code>
66		* return $this->Summary
67		* </code>
68		*
69		* @return string
70		*/
71	1	public function getPortletCaption()
72		{
73	1	return '';
74		}
75		}
76

gordonbanderson / ss3gallery

Push — master ( 18f749...9fc766 )

GalleryImage::getCMSFields() A

Complexity

Size

Duplication

Code Coverage

Duplication Side-by-Side

Filter issues like