PHP Class yii2fullcalendar\models\Event

Inheritance: extends yii\base\Model
Show file Open project: philippfrenzel/yii2fullcalendar

Public Properties

Property Type Description
$allDay boolean If this value is not explicitly specified, allDayDefault will be used if it is defined. If all else fails, FullCalendar will try to guess. If either the start or end value has a "T" as part of the ISO8601 date string, allDay will become false. Otherwise, it will be true. Don't include quotes around your true/false. This value is a boolean, not a string!
$backgroundColor [type] Sets an event's background color just like the calendar-wide eventBackgroundColor option.
$borderColor [type] Sets an event's border color just like the the calendar-wide eventBorderColor option.
$className [type] A CSS class (or array of classes) that will be attached to this event's element.
$color [type] Sets an event's background and border color just like the calendar-wide eventColor option.
$description string The description text for an event
$dow array Day of Week settings for repeating events. Enter the numerical days of the week ex. [1,4] would repeat on Monday and Thursday.
$durationEditable [type] Overrides the master eventDurationEditable option for this single event.
$editable boolean Overrides the master editable option for this single event.
$end datetime A Moment-ish input, like an ISO8601 string. Throughout the API this will become a real Moment object. It is the moment immediately after the event has ended. For example, if the last full day of an event is Thursday, the exclusive end of the event will be 00:00:00 on Friday!
$id integer the id of the shown event
$ranges range Used with a function to check the dates in eventRender against the range and only render the dates that fall within the range.
$resourceId the unique resource for the event
$source [type] A reference to the event source that this event came from.
$start datetime A Moment-ish input, like an ISO8601 string. Throughout the API this will become a real Moment object.
$startEditable [type] Overrides the master eventStartEditable option for this single event.
$textColor [type] Sets an event's text color just like the calendar-wide eventTextColor option.
$title string The text on an event's element
$url [type] A URL that will be visited when this event is clicked by the user. For more information on controlling this behavior, see the eventClick callback.

Public Methods

Method Description
rules ( )

Method Details

rules() public method

public rules ( )

Property Details

$allDay public property

If this value is not explicitly specified, allDayDefault will be used if it is defined. If all else fails, FullCalendar will try to guess. If either the start or end value has a "T" as part of the ISO8601 date string, allDay will become false. Otherwise, it will be true. Don't include quotes around your true/false. This value is a boolean, not a string!
public bool $allDay
return boolean

$backgroundColor public property

Sets an event's background color just like the calendar-wide eventBackgroundColor option.
public [type] $backgroundColor
return [type]

$borderColor public property

Sets an event's border color just like the the calendar-wide eventBorderColor option.
public [type] $borderColor
return [type]

$className public property

A CSS class (or array of classes) that will be attached to this event's element.
public [type] $className
return [type]

$color public property

Sets an event's background and border color just like the calendar-wide eventColor option.
public [type] $color
return [type]

$description public property

The description text for an event
public string $description
return string

$dow public property

Day of Week settings for repeating events. Enter the numerical days of the week ex. [1,4] would repeat on Monday and Thursday.
public array $dow
return array

$durationEditable public property

Overrides the master eventDurationEditable option for this single event.
public [type] $durationEditable
return [type]

$editable public property

Overrides the master editable option for this single event.
public bool $editable
return boolean

$end public property

A Moment-ish input, like an ISO8601 string. Throughout the API this will become a real Moment object. It is the moment immediately after the event has ended. For example, if the last full day of an event is Thursday, the exclusive end of the event will be 00:00:00 on Friday!
public datetime $end
return datetime

$id public property

the id of the shown event
public int $id
return integer

$ranges public property

Used with a function to check the dates in eventRender against the range and only render the dates that fall within the range.
public range $ranges
return range

$resourceId public property

the unique resource for the event
public $resourceId

$source public property

A reference to the event source that this event came from.
public [type] $source
return [type]

$start public property

A Moment-ish input, like an ISO8601 string. Throughout the API this will become a real Moment object.
public datetime $start
return datetime

$startEditable public property

Overrides the master eventStartEditable option for this single event.
public [type] $startEditable
return [type]

$textColor public property

Sets an event's text color just like the calendar-wide eventTextColor option.
public [type] $textColor
return [type]

$title public property

The text on an event's element
public string $title
return string

$url public property

A URL that will be visited when this event is clicked by the user. For more information on controlling this behavior, see the eventClick callback.
public [type] $url
return [type]