AdvertisementDecorator - Code Metrics - sunnysideup/silverstripe-advertisements - Measure and Improve Code Quality continuously with Scrutinizer

AdvertisementDecorator F
last analyzed 2018-08-23 23:08 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	391
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	21

Importance

Changes

Metric	Value
wmc	67
lcom	1
cbo	21
dl	0
loc	391
rs	3.04
c	0
b	0
f	0

10 Methods

Rating	Name	Size	Complexity
B	add_requirements()	25	6
F	updateCMSFields()	138	16
A	MyTabName()	6	1
A	MyHeaderField()	6	1
A	MyHeaderFieldLarge()	6	1
A	AdvertisementSet()	18	5
B	advertisementParent()	21	7
F	onBeforeWrite()	62	16
B	advertisementsToShow()	27	7
B	classHasAdvertisements()	19	7

How to fix Complexity

<?php

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

class AdvertisementDecorator extends SiteTreeExtension
namespace YourVendor;

class YourClass { }
{

    /**
     * load an alternative collection of JS file to power your
     * slideslow
     * see yml files for example
     * @var Array
     */
    private static $alternative_javascript_file_array = array();


    /**
     * load an alternative collection of JS file to power your
     * slideslow
     * see yml files for example
     * @var Array
     */
    private static $add_advertisements_shown_on_no_pages_to_all_pages = true;


    public static function add_requirements($alternativeFileLocation = null)
    {
        Requirements::javascript(THIRDPARTY_DIR."/jquery/jquery.js");
        $jsFileArray = Config::inst()->get("AdvertisementDecorator", "alternative_javascript_file_array");

        if (count($jsFileArray)) {
            foreach ($jsFileArray as $file) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                Requirements::javascript($file);
            }
        } else {
            Requirements::javascript("advertisements/javascript/Advertisements.js");
            $file = "";
            $customJavascript = Config::inst()->get("AdvertisementDecorator", "use_custom_javascript");
            if ($customJavascript == 1) {
                $file = project()."/javascript/AdvertisementsExecutive.js";
            } elseif ($alternativeFileLocation) {
                $file = $alternativeFileLocation;
            }
            if (!$file) {
                $file = "advertisements/javascript/AdvertisementsExecutive.js";
            }
            Requirements::javascript($file);
            Requirements::themedCSS("Advertisements", "advertisements");
        }
    }

    private static $db = array(

        "UseParentAdvertisements" => "Boolean"
    );

    private static $has_one = array(

        "AdvertisementsFolder" => "Folder",
        "AdvertisementStyle" => "AdvertisementStyle"
    );

    private static $many_many = array(

        "Advertisements" => "Advertisement"
    );

    private static $use_custom_javascript = false;


    private static $page_classes_without_advertisements = array();


    private static $specific_name_for_advertisements = "Advertisements";


    private static $page_classes_with_advertisements = array();


    private static $advertisements_dos = null;


    public function updateCMSFields(FieldList $fields)
    {
        if ($this->classHasAdvertisements($this->owner->ClassName)  && $this->owner->exists()) {

            $tabName = $this->MyTabName();
            //advertisements shown...
            $where = '1 = 1';
            if ($this->owner->AdvertisementsFolderID) {
                $images = Image::get()->filter("ParentID", $this->owner->AdvertisementsFolderID);

                if ($images->count()) {
                    $where = "\"AdvertisementImageID\" IN (".implode(",", $images->column("ID")).")";
                } else {
                    $where = " 1 = 2";
                }
            }

            $source = Advertisement::get();
            if ($source && $source->count()) {
                $newSource = [];
                foreach ($source as $ad) {
                    $newSource[$ad->ID] = $ad->getFullTitle('width: 75px!important;');
                }
                $fields->addFieldToTab($tabName, CheckboxSetField::create(
                    'Advertisements',
                    'Select '.Config::inst()->get("Advertisement", "plural_name"),
                    $newSource
                ));
            }

            //$advertisementsCount = DB::query("SELECT COUNT(ID) FROM \"Advertisement\" $whereDB ;")->value();

            $advertisements = $this->owner->Advertisements()->where($where);
            $txt = sprintf(_t("AdvertisementDecorator.ACTUAL", 'Current %1$s Shown'), Config::inst()->get("Advertisement", "plural_name"));
            $fields->addFieldToTab($tabName, $this->MyHeaderField($txt));
            $txt = sprintf(_t("AdvertisementDecorator.SELECT", 'Select %1$s to show ... '), Config::inst()->get("Advertisement", "plural_name"));
            $advertisementsGridField = new GridField('AdvertisementsList', $txt, $this->owner->Advertisements(), GridFieldConfig_RelationEditor::create());
            $fields->addFieldToTab($tabName, $advertisementsGridField);
            if (Config::inst()->get("Advertisement", "resize_images") == 'no') {
                $totalSize = 0;
                foreach ($this->owner->Advertisements() as $advertisement) {
                    $totalSize += $advertisement->AdvertisementImage()->getAbsoluteSize();
                }
                $seconds = round(($totalSize + 1) / 524288)    ;
                $fields->addFieldToTab($tabName, new LiteralField("TotalSize", '<p><em>Total download size: '.File::format_size($totalSize).', good reception 3G network download time less than ~'.($seconds+1).' seconds.</em></p>'));
            }
            if (class_exists("DataObjectSorterController")) {
                $shownAdvertisements = $this->owner->getManyManyComponents('Advertisements');
                if ($shownAdvertisements) {
                    $array = $shownAdvertisements->column("ID");
                    $idString = implode(",", $array);
                    $link = DataObjectSorterController::popup_link("Advertisement", $filterField = "ID", $filterValue = $idString, $linkText = "sort ".Config::inst()->get("Advertisement", "plural_name"), $titleField = "FullTitle");
                    $fields->addFieldToTab($tabName, new LiteralField("AdvertisementsSorter", $link));
                }
            }
            if ($advertisements->count()) {
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}
            } else {
                $txt = sprintf(
                    _t("AdvertisementDecorator.CREATE", '<p>Please <a href="admin/%1$s/">create %2$s</a> on the <a href="admin/%1$s/">%3$s tab</a> first, or see below on how to create %2$s from a folder.</p>'),
                    Config::inst()->get("AdvertisementAdmin", "url_segment"),
                    Config::inst()->get("Advertisement", "plural_name"),
                    Config::inst()->get("AdvertisementAdmin", "menu_title")
                );
                $fields->addFieldToTab($tabName, new LiteralField("AdvertisementsHowToCreate", $txt));
            }
            if ($parent = $this->advertisementParent()) {
                $txt = sprintf(_t("AdvertisementDecorator.ORUSE", 'OR  ... use %1$s from  <i>%2$s</i>.'), Config::inst()->get("Advertisement", "plural_name"), $parent->Title);
                $fields->addFieldToTab($tabName, new CheckboxField("UseParentAdvertisements", $txt));
            }


            $txt = _t('AdvertisementDecorator.ADVANCED', 'Advanced');
            $fields->addFieldToTab($tabName, $this->MyHeaderFieldLarge($txt));

            //create new advertisements
            $txt = sprintf(_t("AdvertisementDecorator.CREATE", 'Create new %1$s'), Config::inst()->get("Advertisement", "plural_name"));
            $fields->addFieldToTab($tabName, $this->MyHeaderField($txt));
            $txt = sprintf(
                _t(
                    "AdvertisementDecorator.CREATENEWFROMFOLDER_EXPLANATION",
                    'Create New %1$s from images in the folder selected - each image in the folder will be used to create a %3$s. %2$s'
                ),
                Config::inst()->get("Advertisement", "plural_name"),
                Advertisement::recommended_image_size_statement(),
                Config::inst()->get("Advertisement", "singular_name")
            );
            if (Folder::get()->count()) {
                $fields->addFieldToTab(
                    $tabName,
                    $treeDropdownField = new TreeDropdownField(
                        'AdvertisementsFolderID',
                        _t("AdvertisementDecorator.CREATENEWFROMFOLDER", "Create from folder"),
                        'Folder'
                    )
                );
                $treeDropdownField->setRightTitle($txt);
            }

            $styles = AdvertisementStyle::get();
            if ($styles->count()) {
                $fields->addFieldToTab($tabName, $this->MyHeaderField("Style"));
                $list = $styles->map("ID", "Title", $emptyString = _t("AdvertisementDecorator.SELECTSTYLE", "--select style--"), $sortByTitle = true);

                $fields->addFieldToTab(
                    $tabName,
                    $selectStyleField = new DropdownField(
                        "AdvertisementStyleID",
                        _t("AdvertisementDecorator.STYLECREATED", "Select style"),
                        $list
                    )
                );
                $selectStyleField->setRightTitle(_t("AdvertisementDecorator.STYLECREATED_EXPLANATION", "Styles are created by your developer"));
            }


            $txt = sprintf(_t("AdvertisementDecorator.EDIT", 'Edit %1$s'), Config::inst()->get("Advertisement", "plural_name"));
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
            $txt = sprintf(
                _t("AdvertisementDecorator.PLEASEMANAGEEXISTING", '<p>Please manage existing %1$s on the <a href="admin/%2$s/">%3$s tab</a>.</p>'),
                Config::inst()->get("Advertisement", "plural_name"),
                Config::inst()->get("AdvertisementAdmin", "url_segment"),
                Config::inst()->get("AdvertisementAdmin", "menu_title")
            );
            $fields->addFieldToTab($tabName, new LiteralField("ManageAdvertisements", $txt));
            $txt = sprintf(_t("AdvertisementDecorator.DELETE", 'Delete %1$s'), Config::inst()->get("Advertisement", "plural_name"));
            $fields->addFieldToTab($tabName, $this->MyHeaderField($txt));
            $page = SiteTree::get()->byID($this->owner->ID);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

            $txtRemove = sprintf(_t("AdvertisementDecorator.REMOVE", 'Remove all %1$s from this page (%1$s will not be deleted but are not longer associated with this page)'), Config::inst()->get("Advertisement", "plural_name"));
            $txtConfirmRemove = sprintf(_t("AdvertisementDecorator.CONFIRMREMOVE", 'Are you sure you want to remove all %1$s from this page?'), Config::inst()->get("Advertisement", "plural_name"));
            $removeallLink = 'advertisements/removealladvertisements/'.$this->owner->ID.'/';
            $jquery = 'if(confirm(\''.$txtConfirmRemove.'\')) {jQuery(\'#removealladvertisements\').load(\''.$removeallLink.'\');} return false;';
            $fields->addFieldToTab($tabName, new LiteralField("removealladvertisements", '<p class="message warning"><a href="'.$removeallLink.'" onclick="'.$jquery.'"  id="removealladvertisements"  class="ss-ui-button">'.$txtRemove.'</a></p>'));

            $txtDelete = sprintf(_t("AdvertisementDecorator.DELETE", 'Delete all %1$s from this website (but not the images associated with them)'), Config::inst()->get("Advertisement", "plural_name"));
            $txtConfirmDelete = sprintf(_t("AdvertisementDecorator.CONFIRMDELETE", 'Are you sure you want to delete all %1$s - there is no UNDO?'), Config::inst()->get("Advertisement", "plural_name"));
            $deleteallLink = 'advertisements/deletealladvertisements/'.$this->owner->ID.'/';
            $jquery = 'if(confirm(\''.$txtConfirmDelete.'\')) {jQuery(\'#deletealladvertisements\').load(\''.$deleteallLink.'\');} return false;';
            $fields->addFieldToTab($tabName, new LiteralField("deletealladvertisements", '<p class="message bad"><a href="'.$deleteallLink.'" onclick="'.$jquery.'"  id="deletealladvertisements" class="ss-ui-button">'.$txtDelete.'</a></p>'));
        }

        return $fields;
    }

    protected function MyTabName()
    {
        $code = preg_replace("/[^a-zA-Z0-9\s]/", " ", Config::inst()->get("AdvertisementAdmin", "menu_title"));
        $code = str_replace(" ", "", $code);
        return "Root.".$code;
    }

    protected function MyHeaderField($title)
    {
        $code = preg_replace("/[^a-zA-Z0-9\s]/", "", $title);
        $code = str_replace(" ", "", $code);
        return new LiteralField($code, "<h4 style='margin-top: 20px'>$title</h4>");
    }

    protected function MyHeaderFieldLarge($title)
    {
        $code = preg_replace("/[^a-zA-Z0-9\s]/", "", $title);
        $code = str_replace(" ", "", $code);
        return new LiteralField($code, "<h2 style='margin-top: 40px'>$title</h2>");
    }

    public function AdvertisementSet($style = null)

    {
        if ($this->classHasAdvertisements($this->owner->ClassName)) {

            $browseSet = $this->owner->advertisementsToShow();
            if ($browseSet) {
                $file = null;
                if ($this->owner->AdvertisementStyleID) {

                    $style = $this->owner->AdvertisementStyle();
                }
                if ($style) {
                    $file = $style->FileLocation;
                }
                self::add_requirements($file);

                return $browseSet;
            }
        }
    }

    protected function advertisementParent()

    {
        $parent = null;
        if ($this->owner->ParentID) {
            $parent = SiteTree::get()->byID($this->owner->ParentID);

        } elseif ($this->owner->URLSegment != "home") {

            $parent = SiteTree::get()->where("URLSegment = 'home' AND \"ClassName\" <> 'RedirectorPage'")->First();
            if (!$parent) {
                if (class_exists("HomePage")) {
                    $parent = HomePage::get()->First();
                } else {
                    $parent = Page::get()->filter(array("URLSegment" => "home"))->First();
                }
            }
        }
        if ($parent) {
            if ($this->classHasAdvertisements($parent->ClassName)) {
                return $parent;
            }
        }
    }

    public function onBeforeWrite()
    {
        parent::onBeforeWrite();
        $bt = defined('DB::USE_ANSI_SQL') ? "\"" : "`";
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        if ($this->classHasAdvertisements($this->owner->ClassName)) {

            $objects = array(0 => 0);
            $images = array(0 => 0);
            $dos1 = $this->advertisementsToShow();
            if ($dos1) {
                foreach ($dos1 as $obj) {
                    $images[$obj->ID] = $obj->AdvertisementImageID;
                    $objects[$obj->ID] = $obj->ID;
                }
            }
            //check for non-existing images and delete advertisements associated with it

            foreach ($images as $objectID => $imageID) {
                if (!Image::get()->byID($imageID)) {
                    $obj = Advertisement::get()->byID($objectID);
                    if ($obj) {
                        $obj->delete();
                        $obj->destroy();
                        unset($objects[$objectID]);
                    }
                }
            }
            //check if a folder has been set and create objects
            if ($this->owner->AdvertisementsFolderID) {
                $dos2 = Image::get()
                    ->where("\"File\".\"ParentID\" = ".$this->owner->AdvertisementsFolderID." AND \"Advertisement\".\"AdvertisementImageID\" IS NULL ")

                    ->leftJoin("Advertisement", "\"Advertisement\".\"AdvertisementImageID\" = \"File\".\"ID\" ");
                if ($dos2->count()) {
                    $advertisementsToAdd = array();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
                    foreach ($dos2 as $image) {
                        $newAdvertisement = new Advertisement();
                        $newAdvertisement->AdvertisementImageID = $image->ID;
<?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.");
        }
    }

}
                        $newAdvertisement->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.");
        }
    }

}
                        $newAdvertisement->AutoAdded = true;
<?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.");
        }
    }

}
                        $newAdvertisement->write();
                        $objects[$newAdvertisement->ID] = $newAdvertisement->ID;
                    }
                    $this->owner->Advertisements()->addMany($objects);
                }
            }
            if ($this->owner->AdvertisementStyleID) {
                if (!AdvertisementStyle::get()->byID($this->owner->AdvertisementStyleID)) {
                    $this->owner->AdvertisementStyleID = 0;

                }
            }
            //remove advdertisements if parent is being used...
            if ($this->owner->UseParentAdvertisements) {
                if ($this->advertisementParent()) {
                    $combos = $this->owner->Advertisements();
                    if ($combos) {
                        $combos->removeAll();
                    }
                } else {
                    $this->owner->UseParentAdvertisements  = false;

                }
            }
        }
    }

    /**
     *
     *
     * @return DataList
     */
    public function advertisementsToShow()
    {
        $array = array(0 => 0);
        if ($this->owner->exists()) {
            if ($this->owner->UseParentAdvertisements) {

                $parent = $this->owner->advertisementParent();
                if ($parent) {
                    return $parent->advertisementsToShow();
                }
            }
            //from page
            $objects1 = $this->owner->Advertisements();
            if ($objects1->count()) {
                $array += $objects1->map('ID', 'ID')->toArray();
            }
            if (Config::inst()->get(self::class, 'add_advertisements_shown_on_no_pages_to_all_pages')) {
                //shown on all pages ...
                $objects2 = Advertisement::get()
                    ->leftJoin('SiteTree_Advertisements', 'Advertisement.ID = AdvertisementID')
                    ->where('AdvertisementID IS NULL');
                if ($objects2->count()) {
                    $array += $objects2->map('ID', 'ID')->toArray();
                }
            }
        }
        return Advertisement::get()->filter(array('ID' => $array));
    }

    /*

    protected function getResizedAdvertisements(){

    }
    */

    protected function classHasAdvertisements($className)
    {
        //assumptions:
        //1. in general YES
        //2. if list of WITH is shown then it must be in that
        //3. otherwise check if it is specifically excluded (WITHOUT)
        $result = true;
        $inc =  Config::inst()->get("AdvertisementDecorator", "page_classes_with_advertisements");
        $exc =  Config::inst()->get("AdvertisementDecorator", "page_classes_without_advertisements");
        if (is_array($inc) && count($inc)) {
            $result = false;
            if (in_array($className, $inc)) {
                $result = true;
            }
        } elseif (is_array($exc) && count($exc) && in_array($className, $exc)) {
            $result = false;
        }
        return $result;
    }
}


1			<?php
2
3			/**
4			*@author nicolaas [at] sunnysideup.co.nz
5			*
6			*
7			**/
8
9			class AdvertisementDecorator extends SiteTreeExtension
			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...
10			{
11
12			/**
13			* load an alternative collection of JS file to power your
14			* slideslow
15			* see yml files for example
16			* @var Array
17			*/
18			private static $alternative_javascript_file_array = array();
			0 ignored issues – show Unused Code introduced 2017-01-03 00:27 UTC by Report Bug Copy Issue Report The property `$alternative_javascript_file_array` 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...
19
20			/**
21			* load an alternative collection of JS file to power your
22			* slideslow
23			* see yml files for example
24			* @var Array
25			*/
26			private static $add_advertisements_shown_on_no_pages_to_all_pages = true;
			0 ignored issues – show Unused Code introduced 2018-08-22 00:36 UTC by Report Bug Copy Issue Report The property `$add_advertisements_shown_on_no_pages_to_all_pages` 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...
27
28			public static function add_requirements($alternativeFileLocation = null)
29			{
30			Requirements::javascript(THIRDPARTY_DIR."/jquery/jquery.js");
31			$jsFileArray = Config::inst()->get("AdvertisementDecorator", "alternative_javascript_file_array");
32
33			if (count($jsFileArray)) {
34			foreach ($jsFileArray as $file) {
			0 ignored issues – show Bug introduced 2017-01-03 00:27 UTC by Report Bug Copy Issue Report The expression `$jsFileArray` of type `array\|integer\|double\|string\|boolean` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
35			Requirements::javascript($file);
36			}

sunnysideup / silverstripe-advertisements

AdvertisementDecorator F last analyzed 2018-08-23 23:08 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

10 Methods

How to fix Complexity

Complex Class

Duplication Side-by-Side

Filter issues like

AdvertisementDecorator F
last analyzed 2018-08-23 23:08 UTC