SilverCart\View\GroupView\GroupViewBase
Provides the base logic for a group view type.
- Author: Sebastian Diel <sdiel@pixeltricks.de>
- Copyright: 2017 pixeltricks GmbH
- License: see license file in modules root directory
Synopsis
class GroupViewBase
extends ViewableData
{
- // members
- protected $Code;
- protected sring $Image;
- protected bool $active = NULL;
- protected bool $activeHolder = NULL;
- protected array $defaultPreferences = ;
- protected array $preferences = ;
- // methods
- public void __construct()
- protected array preferences()
- public string getCode()
- public void setCode()
- public string Image()
- public void setImage()
- public string getLabel()
- public bool getActive()
- public void setActive()
- public bool getActiveHolder()
- public void setActiveHolder()
- public bool isActive()
- public bool isActiveHolder()
Hierarchy
Extends
- SilverStripe\View\ViewableData
Members
protected
- $Code
—
string
Short code to use for the view - $Image
—
SilverCart\View\GroupView\sring
Image/icon to use for the view - $active
—
SilverCart\View\GroupView\bool
indicates whether the view is active - $activeHolder
—
SilverCart\View\GroupView\bool
indicates whether the view is the active one for holders - $defaultPreferences
—
array
Default preferences - $preferences
—
array
Extended preferences
Methods
protected
- preferences() — provides the default preferences. Must be overwritten by extensions.
public
- __construct() — default constructor. reads the preferences from extendet group views and initializes the group view object.
- Image() — returns the group views image
- getActive() — returns, wether the group view is active or not
- getActiveHolder() — returns, wether the group view is active or not
- getCode() — returns the group views code
- getLabel() — returns the group views label
- isActive() — returns, wether the group view is active or not
- isActiveHolder() — returns, wether the group view is active or not
- setActive() — sets, wether the group view is active or not
- setActiveHolder() — sets, wether the group view is active or not
- setCode() — sets the group views code
- setImage() — sets the group views image