sunnysideup / silverstripe-themecustomiser

code/model/ThemeCustomisation.php

<?php



class ThemeCustomisation extends DataObject {

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

    private static $location_for_scss_file = 'themes/main_mysite/src/variables/_themecustomisation.scss';

The property $location_for_scss_file is not used and could be removed.

    private static $singular_name = 'Theme Customisation';

Consider using a different property name as you override a private property of the parent class.

The property $singular_name is not used and could be removed.

    function i18n_singular_name()

It is generally recommended to explicitly declare the visibility for methods.

    {
        return _t('ThemeCustomiser.SINGULAR_NAME', 'Theme Customisation');
    }

    private static $plural_name = 'Theme Customisations';

Consider using a different property name as you override a private property of the parent class.

The property $plural_name is not used and could be removed.

    function i18n_plural_name()

It is generally recommended to explicitly declare the visibility for methods.

    {
        return _t('ThemeCustomiser.PLURAL_NAME', 'Theme Customisations');
    }

    private static $db = [

Consider using a different property name as you override a private property of the parent class.

The property $db is not used and could be removed.

        'BackgroundColour' => 'Color',
        'FontColour' => 'Color',
        'Accent1Colour' => 'Color',
        'Accent2Colour' => 'Color',
        'MenuBarBackgroundColour' => 'Color',
        'LinkColour' => 'Color',
        'ActiveColour' => 'Color',
        'HeaderFont' => 'Varchar(50)',
        'TextFont' => 'Varchar(50)',
        'MonoFont' => 'Varchar(50)'
    ];

    private static $has_one = [

Consider using a different property name as you override a private property of the parent class.

The property $has_one is not used and could be removed.

        'LargeLogo' => 'Image',
        'SmallLogo' => 'Image'
    ];

    private static $summary_fields = [

Consider using a different property name as you override a private property of the parent class.

The property $summary_fields is not used and could be removed.

        'LargeLogo.Stripthumbnail' => 'Name'
    ];

    private static $field_labels = [

Consider using a different property name as you override a private property of the parent class.

The property $field_labels is not used and could be removed.

        'MonoFont' => 'Mono spaced font'
    ];

    private static $field_labels_right = [

The property $field_labels_right is not used and could be removed.

        'MonoFont' => 'Font similar to courier with identical width used for each character - great for numbers.'
    ];


    public function CMSEditLink()
    {
        $controller = singleton("ThemeCustomiser");

        return $controller->Link().$this->ClassName."/EditForm/field/".$this->ClassName."/item/".$this->ID."/edit";
    }

    public function CMSAddLink()
    {
        $controller = singleton("ThemeCustomiser");

        return $controller->Link().$this->ClassName."/EditForm/field/".$this->ClassName."/item/new";
    }

    public function getCMSFields()
    {
        $fields = parent::getCMSFields();

        $fontList = Injector::inst()->get('GoogleFontProvider')->fullList();
        $fontFields = $this->Config()->get('font_fields');

$fontFields is not used, you could remove the assignment.

        $labels = $this->FieldLabels();
        foreach($this->fontFields() as $fontField) {
            $fields->replaceField(
                $fontField,
                DropdownField::create(
                    $fontField,
                    $labels[$fontField],
                    ['' => '-- select --'] + $fontList
                )
            );
        }
        foreach($this->colourFields() as $colourField) {
            $fields->replaceField(
                $colourField,
                ColorField::create(
                    $colourField,
                    $labels[$colourField]
                )
            );
        }

        $rightFieldDescriptions = $this->Config()->get('field_labels_right');
        foreach($rightFieldDescriptions as $field => $desc) {
            $field = $fields->DataFieldByName($field);
            if($field) {
                $field->setDescription($desc);
            }
        }

        return $fields;
    }

    /**
     * exports to variable SCSS file ...
     */
    function exportToThemeSCSS()

It is generally recommended to explicitly declare the visibility for methods.

    {

        $location = Director::baseFolder() .'/'. $this->Config()->get('location_for_scss_file');
        $data = $this->renderWith('ThemeCustomisationSCSSOutput');
        file_put_contents($location, $data);
    }

    /**
     * stuff to be inserted into head of html
     * - custom css
     * - link to google fonts ...
     */
    function htmlForPageHeader()

The return type could not be reliably inferred; please add a @return annotation.

It is generally recommended to explicitly declare the visibility for methods.

    {
        $list = [];
        foreach($this->fontFields() as $fontField) {
            $list[$this->$fontField] = $this->$fontField;
        }
        $fontList = Injecton::inst()->get('GoogleFontProvider')->getLink($list);

        return $fontList;
    }

    function canCreate($member = null)

It is generally recommended to explicitly declare the visibility for methods.

    {
        if(ThemeCustomisation::get()->count()) {
            return false;
        }

        return parent::canCreate($member);
    }

    function canDelete($member = null)

It is generally recommended to explicitly declare the visibility for methods.

    {
        return false;
    }

    protected function fontFields()
    {
        return $this->fieldsPerType('Font');
    }

    protected function colourFields()
    {
        return $this->fieldsPerType('Colour');
    }

    protected function fieldsPerType($name)
    {
        $list = $this->Config()->get('db');
        foreach($list as $key => $type) {
            if(substr($key, strlen($name) * -1) === $name) {
                $newList[$key] = $key;

$newList was never initialized. Although not strictly required by PHP, it is generally a good practice to add $newList = array(); before regardless.

            }
        }
        return $newList;

The variable $newList does not seem to be defined for all execution paths leading up to this point.

    }

}