class CalendarStyleInfo in Calendar 8

Defines a calendar style info object.

Hierarchy

• class \Drupal\calendar\CalendarStyleInfo

1 file declares its use of CalendarStyleInfo

Calendar.php in src/Plugin/views/style/Calendar.php

File

src/CalendarStyleInfo.php, line 8

Namespace

Drupal\calendar

class CalendarStyleInfo {

  /**
   * Defines whether or not to show this calendar in a popup.
   *
   * @var bool
   *   TRUE to show the calendar in a popup, FALSE otherwise.
   */
  protected $calendarPopup;

  /**
   * Defines whether or not this is a mini calendar.
   *
   * @var bool
   *   TRUE if the calendar is shown in mini, FALSE otherwise.
   */
  protected $mini;

  /**
   * The size of the month name.
   *
   * @var int
   *   The size of the month name.
   */
  protected $monthNameSize;

  /**
   * The size of the calendar name.
   *
   * @var int
   *   The size of the calendar name.
   */
  protected $nameSize;

  /**
   * Defines whether or not to display the title.
   *
   * @var bool
   *   TRUE to display the title, FALSE otherwise.
   */
  protected $showTitle;

  /**
   * Defines whether or not to display the navigation.
   *
   * @var bool
   *   TRUE to display the navigation, FALSE otherwise.
   */
  protected $showNavigation;

  /**
   * Defines whether or not to display the week numbers.
   *
   * @var bool
   *   TRUE to display the week numbers, FAlSE otherwise.
   */
  protected $showWeekNumbers;

  /**
   * Defines whether or not to display empty times.
   *
   * @var bool
   */
  protected $showEmptyTimes;

  /**
   * Defines the way of grouping items.
   *
   * @var string
   *   The way of grouping items (e.g. 'hour', 'half').
   */
  protected $groupByTimes;

  /**
   * Defines a custom way of grouping by times.
   *
   * @var string
   *   The grouping by times.
   */
  protected $customGroupByTimes;

  /**
   * Defines a custom group by field.
   *
   * @var string
   *   A field to group items by.
   */
  protected $customGroupByField;

  /**
   * The maximum amount of items to show.
   *
   * @var int
   *   The maximum amount.
   */
  protected $maxItems;

  /**
   * Defines what the maximum items style is.
   *
   * @var string
   *   The maximum items style (e.g. 'hide').
   */
  protected $maxItemsStyle;

  /**
   * Defines what the theme style is.
   *
   * @var int
   *   The index number of the theme style.
   */
  protected $themeStyle;

  /**
   * Defines what the multi day theme is.
   *
   * @var int
   *   The index number of the multiday theme.
   */
  protected $multiDayTheme;

  /**
   * Getter for the calendar popup variable.
   *
   * @return bool
   *   TRUE to show the calendar in a popup, FALSE otherwise.
   */
  public function isCalendarPopup() {
    return $this->calendarPopup;
  }

  /**
   * Setter for the calendar popup variable.
   *
   * @param bool $calendarPopup
   *   TRUE to show the calendar in a popup, FALSE otherwise.
   */
  public function setCalendarPopup($calendarPopup) {
    $this->calendarPopup = $calendarPopup;
  }

  /**
   * Getter for the mini format variable.
   *
   * @return bool
   *   TRUE if the calendar is shown in mini, FALSE otherwise.
   */
  public function isMini() {
    return $this->mini;
  }

  /**
   * Setter for the mini format variable.
   *
   * @param bool $mini
   *   TRUE if the calendar is shown in mini, FALSE otherwise.
   */
  public function setMini($mini) {
    $this->mini = $mini;
  }

  /**
   * Getter for the month name size.
   *
   * @return int
   *   The month name size.
   */
  public function getMonthNameSize() {
    return $this->monthNameSize;
  }

  /**
   * Setter for the month name size.
   *
   * @param int $nameSize
   *   The month name size.
   */
  public function setMonthNameSize($nameSize) {
    $this->monthNameSize = $nameSize;
  }

  /**
   * Getter for the name size.
   *
   * @return int
   *   The name size.
   */
  public function getNameSize() {
    return $this->nameSize;
  }

  /**
   * Setter for the name size.
   *
   * @param int $nameSize
   *   The name size.
   */
  public function setNameSize($nameSize) {
    $this->nameSize = $nameSize;
  }

  /**
   * Getter for the show title variable.
   *
   * @return bool
   *   TRUE to display the title, FALSE otherwise.
   */
  public function isShowTitle() {
    return $this->showTitle;
  }

  /**
   * Setter for the show title variable.
   *
   * @param bool $showTitle
   *   TRUE to display the title, FALSE otherwise.
   */
  public function setShowTitle($showTitle) {
    $this->showTitle = $showTitle;
  }

  /**
   * Getter for the show navigation variable.
   *
   * @return bool
   *   TRUE to show the navigation, FALSE otherwise.
   */
  public function isShowNavigation() {
    return $this->showNavigation;
  }

  /**
   * Setter for the show navigation variable.
   *
   * @param bool $showNavigation
   *   TRUE to show the navigation, FALSE otherwise.
   */
  public function setShowNavigation($showNavigation) {
    $this->showNavigation = $showNavigation;
  }

  /**
   * Getter for the show week numbers variable.
   *
   * @return bool
   *   TRUE to display the week numbers, FAlSE otherwise.
   */
  public function isShowWeekNumbers() {
    return $this->showWeekNumbers;
  }

  /**
   * Setter for the show week numbers variable.
   *
   * @param bool $showWeekNumbers
   *   TRUE to display the week numbers, FAlSE otherwise.
   */
  public function setShowWeekNumbers($showWeekNumbers) {
    $this->showWeekNumbers = $showWeekNumbers;
  }

  /**
   * Getter for the show empty times variable.
   *
   * @return bool
   *   TRUE to show empty times, FALSE otherwise.
   */
  public function isShowEmptyTimes() {
    return $this->showEmptyTimes;
  }

  /**
   * Setter for the show empty times variable.
   *
   * @param bool $showEmptyTimes
   *   TRUE to show empty times, FALSE otherwise.
   */
  public function setShowEmptyTimes($showEmptyTimes) {
    $this->showEmptyTimes = $showEmptyTimes;
  }

  /**
   * Getter for the group by times property.
   *
   * @return string
   *   The group by time property.
   */
  public function getGroupByTimes() {
    return $this->groupByTimes;
  }

  /**
   * Setter for the group by times property.
   *
   * @param string $groupByTimes
   *   The group by time property.
   */
  public function setGroupByTimes($groupByTimes) {
    $this->groupByTimes = $groupByTimes;
  }

  /**
   * Getter for the custom group by times variable.
   *
   * @return string
   *   The custom grouping by times.
   */
  public function getCustomGroupByTimes() {
    return $this->customGroupByTimes;
  }

  /**
   * Setter for the custom group by times variable.
   *
   * @param string $customGroupByTimes
   *   The custom grouping by times.
   */
  public function setCustomGroupByTimes($customGroupByTimes) {
    $this->customGroupByTimes = $customGroupByTimes;
  }

  /**
   * Getter for the custom group by field variable.
   *
   * @return string
   *   The custom group by field.
   */
  public function getCustomGroupByField() {
    return $this->customGroupByField;
  }

  /**
   * Setter for the custom group by field variable.
   *
   * @param string $customGroupByField
   *   The custom group field.
   */
  public function setCustomGroupByField($customGroupByField) {
    $this->customGroupByField = $customGroupByField;
  }

  /**
   * Getter for the max items variable.
   *
   * @return int
   *   The maximum amount of items to show.
   */
  public function getMaxItems() {
    return $this->maxItems;
  }

  /**
   * Setter for the max items variable.
   *
   * @param int $maxItems
   *   The maximum amount of items to show.
   */
  public function setMaxItems($maxItems) {
    $this->maxItems = $maxItems;
  }

  /**
   * Getter for the max items style.
   *
   * @return string
   *   The maximum items style.
   */
  public function getMaxItemsStyle() {
    return $this->maxItemsStyle;
  }

  /**
   * Setter for the maximum items style.
   *
   * @param string $maxItemsStyle
   *   The maximum items style.
   */
  public function setMaxItemsStyle($maxItemsStyle) {
    $this->maxItemsStyle = $maxItemsStyle;
  }

  /**
   * Getter for the multiday theme.
   *
   * @return int
   *   The index number of the multiday theme.
   */
  public function getMultiDayTheme() {
    return $this->multiDayTheme;
  }

  /**
   * Setter for the multi day theme variable.
   *
   * @param int $multiDayTheme
   *   The index number of the multiday theme.
   */
  public function setMultiDayTheme($multiDayTheme) {
    $this->multiDayTheme = $multiDayTheme;
  }

  /**
   * Getter for the theme style variable.
   *
   * @return int
   *   The index number of the theme style.
   */
  public function getThemeStyle() {
    return $this->themeStyle;
  }

  /**
   * Setter for the theme style variable.
   *
   * @param int $themeStyle
   *   The index number of the theme style.
   */
  public function setThemeStyle($themeStyle) {
    $this->themeStyle = $themeStyle;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CalendarStyleInfo::$calendarPopup	protected	property	Defines whether or not to show this calendar in a popup.
CalendarStyleInfo::$customGroupByField	protected	property	Defines a custom group by field.
CalendarStyleInfo::$customGroupByTimes	protected	property	Defines a custom way of grouping by times.
CalendarStyleInfo::$groupByTimes	protected	property	Defines the way of grouping items.
CalendarStyleInfo::$maxItems	protected	property	The maximum amount of items to show.
CalendarStyleInfo::$maxItemsStyle	protected	property	Defines what the maximum items style is.
CalendarStyleInfo::$mini	protected	property	Defines whether or not this is a mini calendar.
CalendarStyleInfo::$monthNameSize	protected	property	The size of the month name.
CalendarStyleInfo::$multiDayTheme	protected	property	Defines what the multi day theme is.
CalendarStyleInfo::$nameSize	protected	property	The size of the calendar name.
CalendarStyleInfo::$showEmptyTimes	protected	property	Defines whether or not to display empty times.
CalendarStyleInfo::$showNavigation	protected	property	Defines whether or not to display the navigation.
CalendarStyleInfo::$showTitle	protected	property	Defines whether or not to display the title.
CalendarStyleInfo::$showWeekNumbers	protected	property	Defines whether or not to display the week numbers.
CalendarStyleInfo::$themeStyle	protected	property	Defines what the theme style is.
CalendarStyleInfo::getCustomGroupByField	public	function	Getter for the custom group by field variable.
CalendarStyleInfo::getCustomGroupByTimes	public	function	Getter for the custom group by times variable.
CalendarStyleInfo::getGroupByTimes	public	function	Getter for the group by times property.
CalendarStyleInfo::getMaxItems	public	function	Getter for the max items variable.
CalendarStyleInfo::getMaxItemsStyle	public	function	Getter for the max items style.
CalendarStyleInfo::getMonthNameSize	public	function	Getter for the month name size.
CalendarStyleInfo::getMultiDayTheme	public	function	Getter for the multiday theme.
CalendarStyleInfo::getNameSize	public	function	Getter for the name size.
CalendarStyleInfo::getThemeStyle	public	function	Getter for the theme style variable.
CalendarStyleInfo::isCalendarPopup	public	function	Getter for the calendar popup variable.
CalendarStyleInfo::isMini	public	function	Getter for the mini format variable.
CalendarStyleInfo::isShowEmptyTimes	public	function	Getter for the show empty times variable.
CalendarStyleInfo::isShowNavigation	public	function	Getter for the show navigation variable.
CalendarStyleInfo::isShowTitle	public	function	Getter for the show title variable.
CalendarStyleInfo::isShowWeekNumbers	public	function	Getter for the show week numbers variable.
CalendarStyleInfo::setCalendarPopup	public	function	Setter for the calendar popup variable.
CalendarStyleInfo::setCustomGroupByField	public	function	Setter for the custom group by field variable.
CalendarStyleInfo::setCustomGroupByTimes	public	function	Setter for the custom group by times variable.
CalendarStyleInfo::setGroupByTimes	public	function	Setter for the group by times property.
CalendarStyleInfo::setMaxItems	public	function	Setter for the max items variable.
CalendarStyleInfo::setMaxItemsStyle	public	function	Setter for the maximum items style.
CalendarStyleInfo::setMini	public	function	Setter for the mini format variable.
CalendarStyleInfo::setMonthNameSize	public	function	Setter for the month name size.
CalendarStyleInfo::setMultiDayTheme	public	function	Setter for the multi day theme variable.
CalendarStyleInfo::setNameSize	public	function	Setter for the name size.
CalendarStyleInfo::setShowEmptyTimes	public	function	Setter for the show empty times variable.
CalendarStyleInfo::setShowNavigation	public	function	Setter for the show navigation variable.
CalendarStyleInfo::setShowTitle	public	function	Setter for the show title variable.
CalendarStyleInfo::setShowWeekNumbers	public	function	Setter for the show week numbers variable.
CalendarStyleInfo::setThemeStyle	public	function	Setter for the theme style variable.