Inheritance diagram for Sabre\VObject\Component\VJournal:

Collaboration diagram for Sabre\VObject\Component\VJournal:

Public Member Functions
	isInTimeRange (DateTimeInterface $start, DateTimeInterface $end)
	Returns true or false depending on if the event falls in the specified time-range. More...

	getValidationRules ()

Public Member Functions inherited from Sabre\VObject\Component
	__construct (Document $root, $name, array $children=[], $defaults=true)
	Creates a new component. More...

	add ()
	Adds a new property or component, and returns the new item. More...

	remove ($item)
	This method removes a component or property from this component. More...

	children ()
	Returns a flat list of all the properties and components in this component. More...

	getComponents ()
	This method only returns a list of sub-components. More...

	select ($name)
	Returns an array with elements that match the specified name. More...

	serialize ()
	Turns the object back into a serialized blob. More...

	jsonSerialize ()
	This method returns an array, with the representation as it should be encoded in JSON. More...

	xmlSerialize (Xml\Writer $writer)
	This method serializes the data into XML. More...

	__isset ($name)
	This method checks if a sub-element with the specified name exists. More...

	__set ($name, $value)
	Using the setter method you can add properties or subcomponents. More...

	__unset ($name)
	Removes all properties and components within this component with the specified name. More...

	__clone ()
	This method is automatically called when the object is cloned. More...

	getValidationRules ()

	validate ($options=0)
	Validates the node for correctness. More...

	destroy ()
	Call this method on a document if you're done using it. More...

Public Member Functions inherited from Sabre\VObject\Node
	serialize ()
	Serializes the node into a mimedir format. More...

	jsonSerialize ()
	This method returns an array, with the representation as it should be encoded in JSON. More...

	xmlSerialize (Xml\Writer $writer)
	This method serializes the data into XML. More...

	destroy ()
	Call this method on a document if you're done using it. More...

	getIterator ()
	Returns the iterator for this object. More...

	setIterator (ElementList $iterator)
	Sets the overridden iterator. More...

	validate ($options=0)
	Validates the node for correctness. More...

	count ()
	Returns the number of elements. More...

	offsetExists ($offset)
	Checks if an item exists through ArrayAccess. More...

	offsetGet ($offset)
	Gets an item through ArrayAccess. More...

	offsetSet ($offset, $value)
	Sets an item through ArrayAccess. More...

	offsetUnset ($offset)
	Sets an item through ArrayAccess. More...

Public Member Functions inherited from Sabre\Xml\XmlSerializable
	xmlSerialize (Writer $writer)
	The xmlSerialize method is called during xml writing. More...

Protected Member Functions
	getDefaults ()
	This method should return a list of default property values. More...

Protected Member Functions inherited from Sabre\VObject\Component
	getDefaults ()
	This method should return a list of default property values. More...

Additional Inherited Members
Data Fields inherited from Sabre\VObject\Component
	$name

Data Fields inherited from Sabre\VObject\Node
const	REPAIR = 1
	The following constants are used by the validate() method. More...

const	PROFILE_CARDDAV = 2
	If this option is set, the validator will operate on the vcards on the assumption that the vcards need to be valid for CardDAV. More...

const	PROFILE_CALDAV = 4
	If this option is set, the validator will operate on iCalendar objects on the assumption that the vcards need to be valid for CalDAV. More...

	$parent

Protected Attributes inherited from Sabre\VObject\Component
	$children = []

Protected Attributes inherited from Sabre\VObject\Node
	$iterator = null

	$root

Detailed Description

VJournal component.

This component contains some additional functionality specific for VJOURNALs.

Copyright: Copyright (C) fruux GmbH (https://fruux.com/)

Author: Evert Pot (http://evertpot.com/) http://sabre.io/license/ Modified BSD License

Definition at line 17 of file VJournal.php.

Member Function Documentation

◆ getDefaults()

Sabre\VObject\Component\VJournal::getDefaults ( )

protected

This method should return a list of default property values.

Returns: array

Definition at line 99 of file VJournal.php.

References Sabre\VObject\UUIDUtil\getUUID().

                                      {
 
         return [
             'UID'     => 'sabre-vobject-' . VObject\UUIDUtil::getUUID(),
             'DTSTAMP' => date('Ymd\\THis\\Z'),
         ];
 
     }

Here is the call graph for this function:

◆ getValidationRules()

Sabre\VObject\Component\VJournal::getValidationRules ( )

Definition at line 62 of file VJournal.php.

                                   {
 
         return [
             'UID'     => 1,
             'DTSTAMP' => 1,
 
             'CLASS'         => '?',
             'CREATED'       => '?',
             'DTSTART'       => '?',
             'LAST-MODIFIED' => '?',
             'ORGANIZER'     => '?',
             'RECURRENCE-ID' => '?',
             'SEQUENCE'      => '?',
             'STATUS'        => '?',
             'SUMMARY'       => '?',
             'URL'           => '?',
 
             'RRULE' => '?',
 
             'ATTACH'      => '*',
             'ATTENDEE'    => '*',
             'CATEGORIES'  => '*',
             'COMMENT'     => '*',
             'CONTACT'     => '*',
             'DESCRIPTION' => '*',
             'EXDATE'      => '*',
             'RELATED-TO'  => '*',
             'RDATE'       => '*',
         ];
 
     }

◆ isInTimeRange()

Sabre\VObject\Component\VJournal::isInTimeRange	(	DateTimeInterface	$start,
		DateTimeInterface	$end
	)

Returns true or false depending on if the event falls in the specified time-range.

This is used for filtering purposes.

The rules used to determine if an event falls within the specified time-range is based on the CalDAV specification.

Parameters

DateTimeInterface	$start
DateTimeInterface	$end

Returns: bool

Definition at line 31 of file VJournal.php.

Referenced by Sabre\VObject\Component\VJournalTest\testInTimeRange().

                                                                              {
 
         $dtstart = isset($this->DTSTART) ? $this->DTSTART->getDateTime() : null;
         if ($dtstart) {
             $effectiveEnd = $dtstart;
             if (!$this->DTSTART->hasTime()) {
                 $effectiveEnd = $effectiveEnd->modify('+1 day');
             }
 
             return ($start <= $effectiveEnd && $end > $dtstart);
 
         }
         return false;
 
     }

Here is the caller graph for this function:

The documentation for this class was generated from the following file:

libs/composer/vendor/sabre/vobject/lib/Component/VJournal.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getDefaults()

◆ getValidationRules()

◆ isInTimeRange()