/code/groupview/SilvercartGroupViewHandler.php

<?php
/**
 * Copyright 2010, 2011 pixeltricks GmbH
 *
 * This file is part of SilverCart.
 *
 * SilverCart is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * SilverCart is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with SilverCart.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @package Silvercart
 * @subpackage Groupview
 */

/**
 * handles the base logic for product- and productgroup-visualisation
 *
 * @package Silvercart
 * @subpackage Groupview
 * @author Sebastian Diel <sdiel@pixeltricks.de>
 * @copyright 2010 pixeltricks GmbH
 * @since 14.02.2011
 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License
 */
class SilvercartGroupViewHandler {

    /**
     * a list of possible group view types
     *
     * @var array
     */
    protected static $groupViews = array();

    /**
     * a list of possible group view types
     *
     * @var array
     */
    protected static $groupHolderViews = array();

    /**
     * a list of removed group view types. It is implemented to provide the
     * configuration example in _config.php of silvercart.
     *
     * @var array
     */
    protected static $removedGroupViews = array();

    /**
     * a list of removed group view types. It is implemented to provide the
     * configuration example in _config.php of silvercart.
     *
     * @var array
     */
    protected static $removedGroupHolderViews = array();

    /**
     * the code of the group view which is choosen by default
     *
     * @var string
     */
    protected static $defaultGroupView = null;

    /**
     * the code of the group view which is choosen by default
     *
     * @var string
     */
    protected static $defaultGroupHolderView = null;

    /**
     * adds a new group view type for product lists to the handler.
     *
     * @param string $groupView the class name of the group view to add
     *
     * @return void
     *
     * @author Sebastian Diel <sdiel@pixeltricks.de>
     * @since 14.02.2011
     */
    public static function addGroupView($groupView) {
        if (in_array($groupView, self::$removedGroupViews)) {
            return;
        }
        if (class_exists($groupView)) {
            $gv = new $groupView();
            self::$groupViews[$gv->getCode()] = $groupView;
        }
    }

    /**
     * adds a new group view type for product group lists to the handler.
     *
     * @param string $groupHolderView the class name of the group view to add
     *
     * @return void
     *
     * @author Sebastian Diel <sdiel@pixeltricks.de>
     * @since 14.02.2011
     */
    public static function addGroupHolderView($groupHolderView) {
        if (in_array($groupHolderView, self::$removedGroupHolderViews)) {
            return;
        }
        if (class_exists($groupHolderView)) {
            $gv = new $groupHolderView();
            self::$groupHolderViews[$gv->getCode()] = $groupHolderView;
        }
    }

    /**
     * removes a group view for product lists from the handler
     *
     * @param string $groupView the class name of the group view to remove
     *
     * @return void
     *
     * @author Sebastian Diel <sdiel@pixeltricks.de>
     * @since 14.02.2011
     */
    public static function removeGroupView($groupView) {
        if (in_array($groupView, self::$removedGroupViews)) {
            return;
        }
        self::$removedGroupViews[] = $groupView;
        if (in_array($groupView, self::$groupViews)) {
            foreach (self::$groupViews as $index => $value) {
                if ($groupView == $value) {
                    unset (self::$groupViews[$index]);
                }
            }
        }
    }

    /**
     * removes a group view for product group lists from the handler
     *
     * @param string $groupHolderView the class name of the group view to remove
     *
     * @return void
     *
     * @author Sebastian Diel <sdiel@pixeltricks.de>
     * @since 14.02.2011
     */
    public static function removeGroupHolderView($groupHolderView) {
        if (in_array($groupHolderView, self::$removedGroupHolderViews)) {
            return;
        }
        self::$removedGroupHolderViews[] = $groupHolderView;
        if (in_array($groupHolderView, self::$groupHolderViews)) {
            foreach (self::$groupHolderViews as $index => $value) {
                if ($groupHolderView == $value) {
                    unset (self::$groupHolderViews[$index]);
                }
            }
        }
    }

    /**
     * set the group view to use by default for product lists
     *
     * @param string $defaultGroupView the class name of the group view to use by default
     *
     * @return void
     */
    public static function setDefaultGroupView($defaultGroupView = null) {
        if (is_null($defaultGroupView)
         || !in_array($defaultGroupView, self::$groupViews)) {
            foreach (self::$groupViews as $code => $groupView) {
                self::$defaultGroupView = $code;
                return;
            }
            self::addGroupView($defaultGroupView);
        }
        $tmp = array_flip(self::$groupViews);
        self::$defaultGroupView = $tmp[$defaultGroupView];
    }

    /**
     * set the group view to use by default for product group lists
     *
     * @param string $defaultGroupHolderView the class name of the group view to use by default
     *
     * @return void
     */
    public static function setDefaultGroupHolderView($defaultGroupHolderView = null) {
        if (is_null($defaultGroupHolderView)
         || !in_array($defaultGroupHolderView, self::$groupHolderViews)) {
            foreach (self::$groupHolderViews as $code => $groupHolderView) {
                self::$defaultGroupHolderView = $code;
                return;
            }
            self::addGroupHolderView($defaultGroupHolderView);
        }
        $tmp = array_flip(self::$groupHolderViews);
        self::$defaultGroupHolderView = $tmp[$defaultGroupHolderView];
    }

    /**
     * returns the class name of the default group view
     *
     * @return string
     */
    public static function getDefaultGroupView() {
        return self::$defaultGroupView;
    }

    /**
     * returns the class name of the default group view
     *
     * @return string
     */
    public static function getDefaultGroupHolderView() {
        return self::$defaultGroupHolderView;
    }

    /**
     * sets the group view to the given type
     *
     * @param string $groupView the code of the group view to set
     *
     * @return void
     *
     * @author Sebastian Diel <sdiel@pixeltricks.de>
     * @since 10.02.2011
     * @see self::$groupViews
     */
    public static function setGroupView($groupView) {
        if (array_key_exists($groupView, self::$groupViews)) {
            Session::set('SilvercartGroupView', $groupView);
            Session::save();
        }
    }

    /**
     * sets the group view to the given type
     *
     * @param string $groupHolderView the code of the group view to set
     *
     * @return void
     *
     * @author Sebastian Diel <sdiel@pixeltricks.de>
     * @since 10.02.2011
     * @see self::$groupHolderViews
     */
    public static function setGroupHolderView($groupHolderView) {
        if (array_key_exists($groupHolderView, self::$groupHolderViews)) {
            Session::set('SilvercartGroupHolderView', $groupHolderView);
            Session::save();
        }
    }

    /**
     * returns all group views
     *
     * @return string
     */
    public static function getGroupViews() {
        return self::$groupViews;
    }

    /**
     * returns all group views
     *
     * @return string
     */
    public static function getGroupHolderViews() {
        return self::$groupHolderViews;
    }

    /**
     * returns the class name of a group view by its code
     *
     * @param string $code the code of the group view
     *
     * @return string
     */
    public static function getGroupView($code) {
        if (array_key_exists($code, self::$groupViews)) {
            return self::$groupViews[$code];
        }
        return false;
    }

    /**
     * returns the class name of a group view by its code
     *
     * @param string $code the code of the group view
     *
     * @return string
     */
    public static function getGroupHolderView($code) {
        if (array_key_exists($code, self::$groupHolderViews)) {
            return self::$groupHolderViews[$code];
        }
        return false;
    }

    /**
     * return the actual group view
     *
     * @return string
     */
    public static function getActiveGroupView() {
        if (is_null(Session::get('SilvercartGroupView'))) {
            if (is_null(self::getDefaultGroupView())) {
                self::setDefaultGroupView();
            }
            self::setGroupView(self::getDefaultGroupView());
        }
        return Session::get('SilvercartGroupView');
    }

    /**
     * return the actual group view
     *
     * @return string
     */
    public static function getActiveGroupHolderView() {
        if (is_null(Session::get('SilvercartGroupHolderView'))) {
            if (is_null(self::getDefaultGroupHolderView())) {
                self::setDefaultGroupHolderView();
            }
            self::setGroupHolderView(self::getDefaultGroupHolderView());
        }
        return Session::get('SilvercartGroupHolderView');
    }

    /**
     * returns the actual group view type as UpperCamelCase
     *
     * @return string
     */
    public static function getActiveGroupViewAsUpperCamelCase() {
        return strtoupper(substr(self::getActiveGroupView(), 0, 1)) . strtolower(substr(self::getActiveGroupView(), 1));
    }

    /**
     * returns the actual group view type as UpperCamelCase
     *
     * @return string
     */
    public static function getActiveGroupHolderViewAsUpperCamelCase() {
        return strtoupper(substr(self::getActiveGroupHolderView(), 0, 1)) . strtolower(substr(self::getActiveGroupHolderView(), 1));
    }
}