SilverCart\View\GroupView\GroupViewHandler
Handles the base logic for product- and productgroup-visualisation.
- Author: Sebastian Diel <sdiel@pixeltricks.de>
- Copyright: 2017 pixeltricks GmbH
- License: see license file in modules root directory
Synopsis
class GroupViewHandler
{
- // members
- protected static array $groupViews = ;
- protected static array $groupHolderViews = ;
- protected static array $removedGroupViews = ;
- protected static array $removedGroupHolderViews = ;
- protected static $defaultGroupView = NULL;
- protected static $defaultGroupHolderView = NULL;
- // methods
- public static void addGroupView()
- public static void addGroupHolderView()
- public static void removeGroupView()
- public static void removeGroupHolderView()
- public static void setDefaultGroupView()
- public static void setDefaultGroupHolderView()
- public static string getDefaultGroupView()
- public static string getDefaultGroupViewInherited()
- public static string getDefaultGroupHolderView()
- public static void setGroupView()
- public static void setGroupHolderView()
- public static string getGroupViews()
- public static string getGroupHolderViews()
- public static string getGroupView()
- public static string getGroupHolderView()
- public static string getActiveGroupView()
- public static string getActiveGroupHolderView()
- public static string getActiveGroupViewAsUpperCamelCase()
- public static string getActiveGroupHolderViewAsUpperCamelCase()
- public static DropdownField getGroupViewDropdownField()
- public static string getProductGroupPageTemplateNameFor()
Members
protected
- $defaultGroupHolderView
—
string
the code of the group view which is choosen by default - $defaultGroupView
—
string
the code of the group view which is choosen by default - $groupHolderViews
—
array
a list of possible group view types - $groupViews
—
array
a list of possible group view types - $removedGroupHolderViews
—
array
a list of removed group view types. It is implemented to provide the configuration example in _config.php of silvercart. - $removedGroupViews
—
array
a list of removed group view types. It is implemented to provide the configuration example in _config.php of silvercart.
Methods
public
- addGroupHolderView() — adds a new group view type for product group lists to the handler.
- addGroupView() — adds a new group view type for product lists to the handler.
- getActiveGroupHolderView() — return the actual group view
- getActiveGroupHolderViewAsUpperCamelCase() — returns the actual group view type as UpperCamelCase
- getActiveGroupView() — return the actual group view
- getActiveGroupViewAsUpperCamelCase() — returns the actual group view type as UpperCamelCase
- getDefaultGroupHolderView() — returns the class name of the default group view
- getDefaultGroupView() — returns the class name of the default group view
- getDefaultGroupViewInherited() — returns the class name of the default group view
- getGroupHolderView() — returns the class name of a group view by its code
- getGroupHolderViews() — returns all group views
- getGroupView() — returns the class name of a group view by its code
- getGroupViewDropdownField() — Creates and returns a dropdown field to choose an available GroupView
- getGroupViews() — returns all group views
- getProductGroupPageTemplateNameFor() — returns the required template name
- removeGroupHolderView() — removes a group view for product group lists from the handler
- removeGroupView() — removes a group view for product lists from the handler
- setDefaultGroupHolderView() — set the group view to use by default for product group lists
- setDefaultGroupView() — set the group view to use by default for product lists
- setGroupHolderView() — sets the group view to the given type
- setGroupView() — sets the group view to the given type