Advertisement::getCMSFields() - Code Metrics - Inspection of "MINOR: enhancements in cmsfields and in template" - sunnysideup/silverstripe-advertisements - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d3c561...218d2f )

by Nicolaas

created 2017-07-31 04:03 UTC

Advertisement::getCMSFields() A

↳ Parent: Advertisement

Complexity

Conditions	3
Paths	4

Size

Total Lines	56
Code Lines	41

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	56
rs	9.7251
c	0
b	0
f	0
cc	3
eloc	41
nc	4
nop	0

How to fix Long Method

<?php

/* *
 *@author nicolaas[at] sunnysideup.co.nz
 *
 **/

class Advertisement extends DataObject
namespace YourVendor;

class YourClass { }
{
    private static $thumbnail_size = 140;


    private static $width = 0;


    private static $height = 0;


    /**
     * must be a string as booleans dont work well on configs
     * @varchar yes / no
     */
    private static $resize_images = "yes";


    public static function recommended_image_size_statement()
    {
        $array = array();
        if (Config::inst()->get("Advertisement", "width")) {
            $array[] = "width = ".Config::inst()->get("Advertisement", "width")."px";
        }
        if (Config::inst()->get("Advertisement", "height")) {
            $array[] = "height = ".Config::inst()->get("Advertisement", "height")."px";
        }
        $count = count($array);
        if ($count == 0) {
            return _t("Advertisement.NO_RECOMMENDED_SIZE_HAS_BEEN_SET", "No recommeded image size has been set.");
        } else {
            return _t("Advertisement.RECOMMENDED_SIZE", "Recommended Size").": ".implode(" "._t("Advertisement.AND", "and")." ", $array).".";
        }
    }

    private static $db = array(

        "Title" => "Varchar(255)",
        "ExternalLink" => "Varchar(150)",
        "Description" => "Text",
        "Sort" => "Int"
    );

    private static $has_one = array(

        "AdvertisementImage" => "Image",
        "LinkedPage" => "SiteTree",
        "AdditionalImage" => "Image"
    );

    private static $belongs_many_many = array(

        "Parents" => "SiteTree",
    );

    private static $casting = array(

        "FullTitle" => "HTMLText",
        "Link" => "Varchar",
        "GroupID" => "Int"
    );

    private static $defaults = array(

        "Sort" => 1000
    );

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


    private static $searchable_fields = array(

        "Title" => "PartialMatchFilter"
    );

    private static $singular_name = "Advertisement";


    private static $plural_name = "Advertisements";


    private static $summary_fields = array(

        "FullTitle" => "Image",
        "Link" => "Link"
    );

    public function getLink()

    {
        $link = '';
        if ($this->ExternalLink) {
<?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.");
        }
    }

}
            $link = $this->ExternalLink;
<?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.");
        }
    }

}
        } elseif ($this->LinkedPageID) {
<?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->LinkedPage()) {
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 { }
                $link = $this->LinkedPage()->Link();
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 { }
            }
        }
        return $link;
    }

    public function Link()

    {
        return $this->getLink();
    }

    public function getFullTitle()
    {
        $s = $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->AdvertisementImageID) {
<?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.");
        }
    }

}
            $image = $this->AdvertisementImage();

            if ($image && $image->exists()) {
                $thumb = $image->setSize(Config::inst()->get("Advertisement", "thumbnail_size"), Config::inst()->get("Advertisement", "thumbnail_size"));
                if ($thumb) {
                    $s = " <img src=\"".$thumb->Link()."\" title=\"".$thumb->Link()."\"/ style=\"vertical-align: top; display: block; float: left; padding-right: 10px; \"><div style=\"width: 100%;\">".$s."</div><div style=\"clear: left;\"></div>";
                }
            }
        }
        return DBField::create_field("HTMLText", $s);
    }

    public function FullTitle()
    {
        return $this->getFullTitle();
    }

    public function getGroupID()

    {
        if ($this->AdvertisementImageID) {
<?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.");
        }
    }

}
            $image = Image::get()->byID($this->AdvertisementImageID);
<?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 ($image) {
                return $image->ParentID;
            }
        }
    }

    public function GroupID()

    {
        return $this->getGroupID();
    }

    public function getCMSFields()
    {
        $fields = parent::getCMSFields();
        $fields->removeFieldFromTab("Root", "Sort");
        $fields->removeFieldFromTab("Root.Main", "AdvertisementImage");
        $fields->removeFieldFromTab("Root.Main", "AdvertisementImageID");
        $fields->removeFieldFromTab("Root.Main", "LinkedPageID");
        $fields->removeFieldFromTab("Root.Main", "ExternalLink");
        $fields->removeFieldFromTab("Root.Parents", "Parents");
        $fields->removeFieldFromTab("Root", "Parents");
        $fields->addFieldToTab("Root.Main", ReadonlyField::create("Link", 'Calculated Link'));
        $fields->addFieldToTab("Root.Main", $mainImageField = new UploadField($name = "AdvertisementImage", $title = $this->i18n_singular_name()));
        $mainImageField->setRightTitle(self::recommended_image_size_statement());
        $fields->addFieldToTab(
            "Root.Main",
            $additionalImageField = UploadField::create(
                $name = "AdditionalImage",
                $title = $this->i18n_singular_name()." "._t("Advertisement.ADDITIONAL_IMAGE", "additional image")
            )
        );
        $additionalImageField->setRightTitle(self::recommended_image_size_statement());
        if ($this->ID) {
            $treeField = TreeMultiselectField::create(
                "Parents",
                _t("Advertisement.GETCMSFIELDSPARENTID", "only show on ... (leave blank to show on all "
                    .$this->i18n_singular_name()
                    ." pages)"),
                "SiteTree"
            );
            /*$callback = $this->callbackFilterFunctionForMultiSelect();

            if($callback) {
                $treeField->setFilterFunction ($callback);
            }*/
            $fields->addFieldToTab("Root.ShownOn", $treeField);
        }
        $fields->addFieldToTab(
            "Root.OptionalLink",
            $externalLinkField = new TextField($name = "ExternalLink", $title = _t("Advertisement.GETCMSFIELDSEXTERNALLINK", "link to external site"))
        );
        $externalLinkField->setRightTitle(_t("Advertisement.GETCMSFIELDSEXTERNALLINK_EXPLANATION", "(e.g. http://www.wikipedia.org) - this will override an internal link"));
        $fields->addFieldToTab("Root.OptionalLink", TreeDropdownField::create($name = "LinkedPageID", $title = _t("Advertisement.GETCMSFIELDSEXTERNALLINKID", "link to a page on this website"), $sourceObject = "SiteTree"));
        if (class_exists("DataObjectSorterController")) {
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}
            //sorted on parent page...
        } else {
            $fields->addFieldToTab(
                "Root.Position",
                $sortField = NumericField::create(
                    "Sort",
                    _t("Advertisement.SORT", "Sort index number")
                )
            );
            $sortField->setRightTitle(_t("Advertisement.SORT_EXPLANATION", "the lower the number, the earlier it shows"));
        }
        $fields->removeFieldFromTab("Root.Main", "AlternativeSortNumber");
        return $fields;
    }

    public function onBeforeWrite()
    {
        parent::onBeforeWrite();
        if (! $this->Sort) {
<?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.");
        }
    }

}
            $defaults = $this->Config()->get("defaults");
            $this->Sort = isset($defaults["Sort"]) ? $defaults["Sort"] : 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.");
        }
    }

}
        }
    }


    public function requireDefaultRecords()
    {
        parent::requireDefaultRecords();
        DB::query("UPDATE \"Advertisement\" SET \"Title\" = \"ID\" WHERE \"Title\" = '' OR \"Title\" IS NULL;");
    }


    protected function callbackFilterFunctionForMultiSelect()
    {
        $inc = Config::inst()->get("AdvertisementDecorator", "page_classes_with_advertisements");
        $exc = Config::inst()->get("AdvertisementDecorator", "page_classes_without_advertisements");
        if (is_array($inc) && count($inc)) {
            $string = 'return in_array($obj->class, array(\''.implode("','", $inc).'\'));';
        } elseif (is_array($exc) && count($exc)) {
            $string = 'return !in_array($obj->class, array(\''.implode("','", $exc).'\'));';
        }
        if (isset($string)) {
            return create_function('$obj', $string);
// Instead of
$function = create_function('$a, $b', 'return $a + $b');

// Better use
$function = function($a, $b) { return $a + $b; }
        } else {
            return false;
        }
    }

    public function Image()

    {
        //will be depreciated in the future.
        return $this->ResizedAdvertisementImage();
    }


    //back-up function...
    public function ResizedAdvertisementImage()

    {
        $resizedImage = null;
        $imageID = intval($this->AdvertisementImageID+ 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.");
        }
    }

}
        if ($imageID) {
            if ($this->Config()->get("resize_images") == 'yes') {
                $imageObject = Image::get()->byID($imageID);
                $resizedImage = $imageObject;
                if ($imageObject) {
                    if ($imageObject->ID) {
                        $imageObject->Title = Convert::raw2att($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.");
        }
    }

}
                        $w = Config::inst()->get("Advertisement", "width");
                        $h = Config::inst()->get("Advertisement", "height");
                        if ($h && $w) {
                            $resizedImage = $imageObject->SetSize($w, $h);
                        } elseif ($h) {
                            $resizedImage = $imageObject->SetHeight($h);
                        } elseif ($w) {
                            $resizedImage = $imageObject->SetWidth($w);
                        } else {
                            $resizedImage = $imageObject;
                        }
                    } else {
if (rand(1, 6) > 3) {
print "Check failed";
} else {
    //print "Check succeeded";
}
                        //debug::show("no image");

                    }
                } else {
if (rand(1, 6) > 3) {
print "Check failed";
} else {
    //print "Check succeeded";
}
                    //debug::show("could not find image");

                }
            } else {
                return $this->AdvertisementImage();

            }
        } else {
if (rand(1, 6) > 3) {
print "Check failed";
} else {
    //print "Check succeeded";
}
            //debug::show("no imageID ($imageID) ");

        }
        return $resizedImage;
    }

    public function ThinyThumb()
    {
        return "This function has not been implemented";
    }
}


1			<?php
2
3			/* *
4			*@author nicolaas[at] sunnysideup.co.nz
5			*
6			**/
7
8			class Advertisement extends DataObject
			0 ignored issues – show Coding Style Compatibility introduced 2017-01-03 00:27 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...
9			{
10			private static $thumbnail_size = 140;
			0 ignored issues – show Unused Code introduced 2017-01-03 00:27 UTC by Report Bug Copy Issue Report The property `$thumbnail_size` 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...
11
12			private static $width = 0;
			0 ignored issues – show Unused Code introduced 2017-01-03 00:27 UTC by Report Bug Copy Issue Report The property `$width` 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...
13
14			private static $height = 0;
			0 ignored issues – show Unused Code introduced 2017-01-03 00:27 UTC by Report Bug Copy Issue Report The property `$height` 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
16			/**
17			* must be a string as booleans dont work well on configs
18			* @varchar yes / no
19			*/
20			private static $resize_images = "yes";
			0 ignored issues – show Unused Code introduced 2017-01-03 00:27 UTC by Report Bug Copy Issue Report The property `$resize_images` 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...
21
22			public static function recommended_image_size_statement()
23			{
24			$array = array();
25			if (Config::inst()->get("Advertisement", "width")) {
26			$array[] = "width = ".Config::inst()->get("Advertisement", "width")."px";
27			}
28			if (Config::inst()->get("Advertisement", "height")) {
29			$array[] = "height = ".Config::inst()->get("Advertisement", "height")."px";
30			}
31			$count = count($array);
32			if ($count == 0) {
33			return _t("Advertisement.NO_RECOMMENDED_SIZE_HAS_BEEN_SET", "No recommeded image size has been set.");
34			} else {
35			return _t("Advertisement.RECOMMENDED_SIZE", "Recommended Size").": ".implode(" "._t("Advertisement.AND", "and")." ", $array).".";

sunnysideup / silverstripe-advertisements

Push — master ( d3c561...218d2f )

Advertisement::getCMSFields() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like