wernerkrauss / silverstripe-onepage

code/OnePageSlide.php

<?php

class OnePageSlide extends DataExtension

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

{

    private static $db = array(

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

        'BackgroundColor' => 'Varchar',
        'HeadingColor' => 'Varchar',
        'TextColor' => 'Varchar',
        'AdditionalCSSClass' => 'Varchar'
    );

    private static $has_one = array(

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

        'BackgroundImage' => 'Image'
    );

    private static $background_color_palette = array(

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

        '#fff',
        '#444',
        '#000'
    );
    private static $heading_color_palette = array(

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

        '#000',
        '#fff'
    );
    private static $text_color_palette = array(

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

        '#000',
        '#fff'
    );

    /**
     * Should we modify the link to represent anchors?
     *
     * @var bool
     */
    private static $do_modify_link = true;

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

    /**
     * limit the generated form fields to slides (direct children of a OnePageHolder)
     * @var bool
     */
    private static $use_only_on_onepage_slides = false;

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

    /**
     * do not require colors to be set
     * @var bool
     */
    private static $colors_can_be_empty = false;

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

    /**
     * @inheritdoc
     */
    public function updateFieldLabels(&$labels)
    {
        $labels = parent::updateFieldLabels($labels);

Are you sure the assignment to $labels is correct as parent::updateFieldLabels($labels) (which targets DataExtension::updateFieldLabels()) seems to always return null.

        $labels['Title'] = _t('OnePageSlide.db_Title', 'Title');
        $labels['BackgroundColor'] = _t('OnePageSlide.db_BackgroundColor', 'Background Color');
        $labels['HeadingColor'] = _t('OnePageSlide.db_HeadingColor', 'Heading Color');
        $labels['TextColor'] = _t('OnePageSlide.db_TextColor', 'Text Color');
        $labels['AdditionalCSSClass'] = _t('OnePageSlide.db_AdditionalCSSClass', 'Additional CSS class');

        $labels['BackgroundImage'] = _t('OnePageSlide.has_many_BackgroundImage', 'Background Image');
    }


    /**
     * @inheritdoc
     */
    public function updateCMSFields(FieldList $fields)
    {
        if (Config::inst()->get($this->class, 'use_only_on_onepage_slides')
            && !$this->owner->isOnePageSlide()) {
            return;
        }

        $image = UploadField::create('BackgroundImage', $this->owner->fieldLabel('BackgroundImage'))
            ->setAllowedFileCategories('image')
            ->setAllowedMaxFileNumber(1);
        if ($this->owner->hasMethod('getRootFolderName')) {
            $image->setFolderName($this->owner->getRootFolderName());
        }

        $colorFields = array(
            'BackgroundColor' => 'background_color_palette',
            'HeadingColor' => 'heading_color_palette',
            'TextColor' => 'text_color_palette'
        );

        $layout = $fields->findOrMakeTab('Root.Layout', _t('OnePageSlide.TABLAYOUT', 'Layout'));
        $layout->push($image);

        foreach ($colorFields as $fieldName => $palette) {
            $layout->push($this->generateColorPalette($fieldName, $palette));
        }
        $layout->push(TextField::create('AdditionalCSSClass', $this->owner->fieldLabel('AdditionalCSSClass')));
    }

    protected function generateColorPalette($fieldName, $paletteSetting)

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

    {
        $palette = $this->owner->config()->get($paletteSetting)
            ? $this->owner->config()->get($paletteSetting)
            : Config::inst()->get($this->class, $paletteSetting);

        $field = ColorPaletteField::create(
            $fieldName,
            $this->owner->fieldLabel($fieldName),
            ArrayLib::valuekey($palette)
        );

        if (Config::inst()->get($this->class, 'colors_can_be_empty')) {
            $field= $field->setEmptyString('none');
        }

        return $field;
    }

    //@todo: if Parent is a OnePageHolder modify $Link to show to $Parent->Link() / #$URLSegment
    //@todo: if Parent is a OnePageHolder disable ShowInMenus
    //@todo: don't show slide in google sitempap

    /**
     * @todo: use customCSS?
     * @return string
     */
    public function getOnePageSlideStyle()
    {
        $style = '';

        $style .= $this->owner->BackgroundColor
            ? 'background-color: ' . $this->owner->BackgroundColor . '; '
            : '';

        $style .= $this->owner->TextColor
            ? ' color: ' . $this->owner->TextColor. ' !important; '
            : '';

        $this->owner->extend('updateOnePageSlideStyle', $style);

        return $style;
    }

    /**
     * get's fired on ContentController::init()
     *
     * check if this is a OnePageSlide and redirect to parent if
     *  - controller has no action
     *  - request isn't an ajax request
     */
    public function contentcontrollerInit(&$controller)
    {
        if ($this->owner->isOnePageSlide() && $this->isCMSPreview()) {
            //redirect and pass current ID by param, as anchor tags re not sent to the server
            $url = Controller::join_links(
                $this->owner->RelativeLink(),
                '?EditPageID=' . $this->owner->ID,
                '?Stage=' . Versioned::current_stage(),
                '?CMSPreview=1'
            );
            $controller->redirect($url);
        }

        if ($this->owner->isOnePageSlide()
                && !$controller->urlParams['Action']
                && !Director::is_ajax()
                && !$this->isCMSPreview()
            ) {
            $controller->redirect($this->owner->RelativeLink(), 301);
        }
    }


    /**
     * Updates RelativeLink()
     *
     * If no $action is given it changes /path/to/URLSegment into /path/to#URLSegment
     *
     * @param $base
     * @param $action
     */
    public function updateRelativeLink(&$base, &$action)
    {
        //we need to call the redirection for cms preview
        if (Controller::curr() instanceof LeftAndMain) {
            return;
        }

        if (Config::inst()->get('OnePageSlide', 'do_modify_link') == false) {
            return;
        }

        if($this->owner->isNestedOnePageSlide()) {
            $base = $this->owner->Parent()->RelativeLink($action) . '-' . $this->owner->URLSegment;
            return;
        }

        if ($this->owner->isOnePageSlide()) {
            //			$base = $this->owner->Parent()->RelativeLink('#' . $this->owner->URLSegment); //e.g. /home/#urlsegment :(

52% of this comment could be valid code. Did you maybe forget this after debugging?

            $base = Controller::join_links($this->owner->Parent()->RelativeLink($action), '#' . $this->owner->URLSegment); // just /#urlsegment
        }
    }

    /**
     * Helper to get a unmofified link if a slide should represent a classical page, not a "block" inside a OnePageHolder
     *
     * @param null $action
     * @return mixed
     */
    public function UnmodifiedRelativeLink($action = null)
    {
        Config::inst()->update('OnePageSlide', 'do_modify_link', false);
        $link = $this->owner->RelativeLink($action);
        Config::inst()->update('OnePageSlide', 'do_modify_link', true);

        return $link;
    }

    /**
     * Checks, if the current page is a slide of a one-page by checking if the parent page is a OnePageHolder
     *
     * @return bool
     */
    public function isOnePageSlide()
    {
        return ($this->owner->Parent() instanceof OnePageHolder);
    }

    /**
     * Checks if the current page is a nested one-page slide
     *
     * @return bool
     */
    public function isNestedOnePageSlide() {
        return $this->owner->ParentID
            ? $this->owner->Parent()->isOnePageSlide()
            : false;
    }

    /**
     * Helper to check if we're previewing the current page in CMS
     *
     * @return bool
     */
    public function isCMSPreview()
    {
        $isCMSPreview = Controller::curr()->getRequest()->getVar('CMSPreview');

        return (bool) $isCMSPreview;
    }

    /**
     * renders the current page using the ClassName_onepage template,
     * e.g. Page_onepage
     *
     * The suffix is generated by @link getOnePageTemplateSuffix
     *
     * @return HTMLText
     */
    public function getOnePageContent()
    {
        $templateName = SSViewer::get_templates_by_class($this->owner->Classname, $this->getOnePageTemplateSuffix(), 'SiteTree')
            ?: 'Page_onepage';

        $controller = ModelAsController::controller_for($this->owner);

        return $controller->renderWith($templateName);
    }


    /**
     * Helper function to generate the template suffix for the current page.
     * Calls page's "generateOnePageTemplateSuffix" method if it exists.
     * This way your page can define the template suffix to be e.g. '_layout1_onepage' instead of just '_onepage'
     *
     * @return string
     */
    public function getOnePageTemplateSuffix()
    {
        return $this->owner->hasMethod('generateOnePageTemplateSuffix')
            ? $this->owner->generateOnePageTemplateSuffix()
            : '_onepage';
    }

}