sunnysideup / silverstripe-faqs

code/FaqHolderPage.php

<?php

/**
 *@author nicolaas[at]sunnysideup.co.nz
 *@description: holds FAQs and displays them nicely.
 *
 */
class FaqHolderPage extends Page

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

{
    private static $icon = "mysite/images/treeicons/FaqHolderPage";

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

    private static $description =  "A list of Frequently Asked Questions" ;

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

    //private static $default_parent = '';

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

    private static $default_child = 'FaqOnePage';

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

    private static $allowed_children = array('FaqHolderPage', 'FaqOnePage');

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

    /**
     * Standard SS variable.
     */
    private static $singular_name = "FAQ Holder Page";

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

    public function i18n_singular_name()
    {
        return _t("FAQHolderPage.SINGULARNAME", "FAQ Holder Page");
    }

    /**
     * Standard SS variable.
     */
    private static $plural_name = "FAQ Holder Pages";

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

    public function i18n_plural_name()
    {
        return _t("FAQHolderPage.PLURALNAME", "FAQ Holder Pages");
    }

    /**
     * The holder page class in use.
     * You can extends this Class and change this value.
     * @var String
     */
    protected $holderPage = "FAQHolderPage";

    /**
     * The item page class in use.
     * You can extends this Class and change this value.
     * @var String
     */
    protected $entryPage = "FAQOnePage";

    /**
     * Returns children FAQHolderPage pages of this FAQHolderPage.
     *
     * @param Int $maxRecursiveLevel - maximum depth , e.g. 1 = one level down - so no Child Groups are returned...
     * @param Int $numberOfRecursions - current level of depth. DONT provide this variable...
     * @return ArrayList (FAQHolderPages)
     */
    public function ChildGroups($maxRecursiveLevel = 99, $numberOfRecursions = 0)
    {
        $arrayList = ArrayList::create();
        if ($numberOfRecursions < $maxRecursiveLevel) {
            $className = $this->getHolderPage();
            $children = $className::get()->filter(array("ParentID" => $this->ID));
            if ($children->count()) {
                foreach ($children as $child) {
                    $arrayList->push($child);
                    $arrayList->merge($child->ChildGroups($maxRecursiveLevel, $numberOfRecursions++));
                }
            }
        }

        return $arrayList;
    }

    /**
     * sets the classname for pages that are holder pages
     * @param String $name
     */
    public function setHolderPage($name)
    {
        $this->holderPage = $name;
    }

    /**
     * gets the classname for pages that are holder pages
     * @return String
     */
    public function getHolderPage()
    {
        return $this->holderPage;
    }

    /**
     * sets the classname for pages that are individual items
     * @param String $name
     */
    public function setEntryName($name)
    {
        $this->entryPage;
    }

    /**
     * gets the classname for pages that are individual items
     * @return String
     */
    public function getEntryName()
    {
        return $this->entryPage;
    }
}

class FaqHolderPage_Controller extends Page_Controller

PSR1 recommends that each class should be in its own file to aid autoloaders.

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

{
    public function init()
    {
        parent::init();
        Requirements::javascript(THIRDPARTY_DIR."/jquery/jquery.js");
        Requirements::javascript("faqs/javascript/FaqHolderPage.js");
        Requirements::themedCSS("FaqHolderPage", "faqs");
    }

    /**
     * returns all underlying FaqOnePage pages...
     * for use in templates
     * @return DataList | Null
     */
    public function Entries()
    {
        $array = array($this->ID => $this->ID);
        if ($childGroups = $this->ChildGroups(4)) {
            if ($childGroups->count()) {
                foreach ($childGroups->map("ID", "ID") as $id) {
                    $array[$id] = $id;
                }
            }
        }
        $stage = '';
        if (Versioned::current_stage() == "Live") {
            $stage = "_Live";
        }
        $className = $this->dataRecord->getEntryName();
        return $className::get()
            ->filter(array("ParentID" => $array, "ShowInSearch" => 1))
            ->leftJoin("SiteTree".$stage, "SiteTree".$stage.".ParentID = MyParent.ID", "MyParent")
            ->leftJoin("SiteTree".$stage, "MyParent.ParentID = MyGrandParent.ID", "MyGrandParent")
            ->leftJoin("SiteTree".$stage, "MyGrandParent.ParentID = MyGreatGrandParent.ID", "MyGreatGrandParent")
            ->leftJoin("SiteTree".$stage, "MyGreatGrandParent.ParentID = MyGreatGreatGrandParent.ID", "MyGreatGreatGrandParent")
            ->sort(
                "
                MyGreatGreatGrandParent.Sort,
                MyGreatGrandParent.Sort,
                MyGrandParent.Sort,
                MyParent.Sort,
                SiteTree".$stage.".Sort"
            );
    }

    public function MyParentHolder()

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

    {
        $className = $this->dataRecord->getHolderPage();
        return $className::get()->byID($this->ParentID);
    }
}