SugarCRM Ult 6.5.4

Package: SugarCRM

Stub class for the future of SugarEvents

Properties


                 $attendees= 'array()'

Default valuearray()Details

Type: n/a


                 $date_created= ''

Details

Type: n/a


                 $date_end= ''

Details

Type: n/a


                 $date_modified= ''

Details

Type: n/a


                 $date_start= ''

Details

Type: n/a


                 $description= ''

Details

Type: n/a


                 $location= ''

Details

Type: n/a


                 $name= ''

Details

Type: n/a


                 $sequence= ''

Details

Type: n/a


                 $status= ''

Details

Type: n/a


                 $type= ''Event''

Default value'Event'Details

Type: n/a


                 $uid= ''

Details

Type: n/a


                 $url= ''

Details

Type: n/a

Package:

Methods

cleanEmail(
          string $var
          )
        
        :
          void

Clean up email - uppercase and remove mailto: prefix

Parameters

Name	Type	Description
$var	string

createSugarEvents(
          \SugarBean $parent
              =
              NULL
          )
        
        :
          void

Create Sugar meetings from calendar events

Parameters

Name	Type	Description
$parent	\SugarBean	related object to associate with meetings

parse(
          STRING $str
          )
        
        :

parses a STRING represeting an iCalendar (vCalendar 2)

Parameters

Name	Type	Description
$str	STRING	iCalendar formatted String

Package:

Base class for all vObjects

Parent(s): \vBasic

Properties


                 $parent= 'null'

inheritedInherited from: \vBasic::$$parent

Default valuenullDetails

Type: n/a
Inherited_from: \vBasic::$$parent


                 $properties= 'array()'

inheritedInherited from: \vBasic::$$properties

Default valuearray()Details

Type: n/a
Inherited_from: \vBasic::$$properties


                 $stack= 'array()'

inheritedInherited from: \vBasic::$$stack

Default valuearray()Details

Type: n/a
Inherited_from: \vBasic::$$stack

Methods

__construct(
          
          )
        
        :
          void

inherited

Inherited from: \vBasic::__construct()

generateVCal(
          
          )
        
        :
          STRING

inherited

returns the VCal String for the given object

Inherited from: \vBasic::generateVCal()

Returns

Type	Description
STRING

getProperties(
          
          )
        
        :
          ARRAY

inherited

returns the properties for the given object

Inherited from: \vBasic::getProperties()

Returns

Type	Description
ARRAY	of properties

getStack(
          
          )
        
        :
          ARRAY

inherited

returns the stack of events/todos/journals/FreeBusy/alarms/timezones for the given object

Inherited from: \vBasic::getStack()

Returns

Type	Description
ARRAY	of events

parseDate(
          object $key, object $date
          )
        
        :
          \date

inherited

Takes in a vCalendar formatted date and generates a (Y-m-d H:i:s) formatted date string

Inherited from: \vBasic::parseDate()

Parameters

Name	Type	Description
$key	object	this is parsed to determine any timezone information
$date	object	the date in vCal format (Ymd\THis\Z)

Returns

Type	Description
\date	formated string (Y-m-d H:i:s)

process(
          object $key, object $value
          )
        
        :
          void

inherited

default process action is to just set the properties

Inherited from: \vBasic::process()

Parameters

Name	Type	Description
$key	object
$value	object

toVCalDate(
          STRING $date
          )
        
        :
          STRING

inherited

Takes in a Sugar Formatted date (Y-m-d H:i:s) and changes it to a VCal Formatted one (Ymd\THis\Z)

Inherited from: \vBasic::toVCalDate()

Parameters

Name	Type	Description
$date	STRING	date in (Y-m-d H:i:s)

Returns

Type	Description
STRING	date - vCal Formatted

Package: SugarCRM

Base class for all vObjects

Children: \vEvent; \vAlarm; \vTimeZone; \vCalendar

Properties


                 $parent= 'null'

Default valuenullDetails

Type: n/a


                 $properties= 'array()'

Default valuearray()Details

Type: n/a


                 $stack= 'array()'

Default valuearray()Details

Type: n/a

Methods

__construct(
          
          )
        
        :
          void

generateVCal(
          
          )
        
        :
          STRING

returns the VCal String for the given object

Returns

Type	Description
STRING

getProperties(
          
          )
        
        :
          ARRAY

returns the properties for the given object

Returns

Type	Description
ARRAY	of properties

getStack(
          
          )
        
        :
          ARRAY

returns the stack of events/todos/journals/FreeBusy/alarms/timezones for the given object

Returns

Type	Description
ARRAY	of events

parseDate(
          object $key, object $date
          )
        
        :
          \date

Takes in a vCalendar formatted date and generates a (Y-m-d H:i:s) formatted date string

Parameters

Name	Type	Description
$key	object	this is parsed to determine any timezone information
$date	object	the date in vCal format (Ymd\THis\Z)

Returns

Type	Description
\date	formated string (Y-m-d H:i:s)

process(
          object $key, object $value
          )
        
        :
          void

default process action is to just set the properties

Parameters

Name	Type	Description
$key	object
$value	object

toVCalDate(
          STRING $date
          )
        
        :
          STRING

Takes in a Sugar Formatted date (Y-m-d H:i:s) and changes it to a VCal Formatted one (Ymd\THis\Z)

Parameters

Name	Type	Description
$date	STRING	date in (Y-m-d H:i:s)

Returns

Type	Description
STRING	date - vCal Formatted

Package: SugarCRM

Calendar events set class

Parent(s): \vBasic

Properties


                 $cur= 'null'

Default valuenullDetails

Type: n/a


                 $parent= 'null'

inheritedInherited from: \vBasic::$$parent

Default valuenullDetails

Type: n/a
Inherited_from: \vBasic::$$parent


                 $properties= 'array()'

Default valuearray()Details

Type: n/a


                 $stack= 'array()'

Default valuearray()Details

Type: n/a

Methods

__construct(
          
          )
        
        :
          void

inherited

Inherited from: \vBasic::__construct()

addEvent(
          \SugarEvent $event
          )
        
        :
          void

add a SugarEvent to the vCalendar Object

Parameters

Name	Type	Description
$event	\SugarEvent

generateVCal(
          
          )
        
        :
          STRING

Generates the VCalendar format for this object

Returns

Type	Description
STRING

getProperties(
          
          )
        
        :
          ARRAY

inherited

returns the properties for the given object

Inherited from: \vBasic::getProperties()

Returns

Type	Description
ARRAY	of properties

getStack(
          
          )
        
        :
          ARRAY

inherited

returns the stack of events/todos/journals/FreeBusy/alarms/timezones for the given object

Inherited from: \vBasic::getStack()

Returns

Type	Description
ARRAY	of events

parseDate(
          object $key, object $date
          )
        
        :
          \date

inherited

Takes in a vCalendar formatted date and generates a (Y-m-d H:i:s) formatted date string

Inherited from: \vBasic::parseDate()

Parameters

Name	Type	Description
$key	object	this is parsed to determine any timezone information
$date	object	the date in vCal format (Ymd\THis\Z)

Returns

Type	Description
\date	formated string (Y-m-d H:i:s)

process(
          object $key, object $value
          )
        
        :

parses the vCalendar

Parameters

Name	Type	Description
$key	object
$value	object

toVCalDate(
          STRING $date
          )
        
        :
          STRING

inherited

Takes in a Sugar Formatted date (Y-m-d H:i:s) and changes it to a VCal Formatted one (Ymd\THis\Z)

Inherited from: \vBasic::toVCalDate()

Parameters

Name	Type	Description
$date	STRING	date in (Y-m-d H:i:s)

Returns

Type	Description
STRING	date - vCal Formatted

Package: SugarCRM

Base class for all vObjects

Parent(s): \vBasic
Children: \vToDo; \vJournal; \vFreeBusy

Properties


                 $parent= 'null'

inheritedInherited from: \vBasic::$$parent

Default valuenullDetails

Type: n/a
Inherited_from: \vBasic::$$parent


                 $properties= 'array()'

inheritedInherited from: \vBasic::$$properties

Default valuearray()Details

Type: n/a
Inherited_from: \vBasic::$$properties


                 $stack= 'array()'

inheritedInherited from: \vBasic::$$stack

Default valuearray()Details

Type: n/a
Inherited_from: \vBasic::$$stack

Methods

__construct(
          
          )
        
        :
          void

inherited

Inherited from: \vBasic::__construct()

generateVCal(
          
          )
        
        :

Generates the VCAL for the event

getProperties(
          
          )
        
        :
          ARRAY

inherited

returns the properties for the given object

Inherited from: \vBasic::getProperties()

Returns

Type	Description
ARRAY	of properties

getStack(
          
          )
        
        :
          ARRAY

inherited

returns the stack of events/todos/journals/FreeBusy/alarms/timezones for the given object

Inherited from: \vBasic::getStack()

Returns

Type	Description
ARRAY	of events

parseAttendee(
          string $key, string $value
          )
        
        :
          array

Parse attendee string into key/value pairs

Parameters

Name	Type	Description
$key	string
$value	string

Returns

Type	Description
array	key/value pairs contanding attendee information

parseDate(
          object $key, object $date
          )
        
        :
          \date

inherited

Takes in a vCalendar formatted date and generates a (Y-m-d H:i:s) formatted date string

Inherited from: \vBasic::parseDate()

Parameters

Name	Type	Description
$key	object	this is parsed to determine any timezone information
$date	object	the date in vCal format (Ymd\THis\Z)

Returns

Type	Description
\date	formated string (Y-m-d H:i:s)

process(
          object $key, object $value
          )
        
        :
          void

Handles the parsing of the vCalendar

Parameters

Name	Type	Description
$key	object
$value	object

setEvent(
          object $event
          )
        
        :

converts a Sugar Event into a vEvent

Parameters

Name	Type	Description
$event	object

toVCalDate(
          STRING $date
          )
        
        :
          STRING

inherited

Takes in a Sugar Formatted date (Y-m-d H:i:s) and changes it to a VCal Formatted one (Ymd\THis\Z)

Inherited from: \vBasic::toVCalDate()

Parameters

Name	Type	Description
$date	STRING	date in (Y-m-d H:i:s)

Returns

Type	Description
STRING	date - vCal Formatted

Package:

Base class for all vObjects

Parent(s): \vEvent < \vBasic

Properties


                 $parent= 'null'

inheritedInherited from: \vBasic::$$parent \vEvent::$$parent

Default valuenullDetails

Type: n/a
Inherited_from: \vBasic::$$parent
Inherited_from: \vEvent::$$parent


                 $properties= 'array()'

inheritedInherited from: \vBasic::$$properties \vEvent::$$properties

Default valuearray()Details

Type: n/a
Inherited_from: \vBasic::$$properties
Inherited_from: \vEvent::$$properties


                 $stack= 'array()'

inheritedInherited from: \vBasic::$$stack \vEvent::$$stack

Default valuearray()Details

Type: n/a
Inherited_from: \vBasic::$$stack
Inherited_from: \vEvent::$$stack

Methods

__construct(
          
          )
        
        :
          void

inherited

Inherited from: \vBasic::__construct()\vEvent::__construct()

generateVCal(
          
          )
        
        :

inherited

Generates the VCAL for the event

Inherited from: \vEvent::generateVCal()

getProperties(
          
          )
        
        :
          ARRAY

inherited

returns the properties for the given object

Inherited from: \vBasic::getProperties()\vEvent::getProperties()

Returns

Type	Description
ARRAY	of properties

getStack(
          
          )
        
        :
          ARRAY

inherited

returns the stack of events/todos/journals/FreeBusy/alarms/timezones for the given object

Inherited from: \vBasic::getStack()\vEvent::getStack()

Returns

Type	Description
ARRAY	of events

parseAttendee(
          string $key, string $value
          )
        
        :
          array

inherited

Parse attendee string into key/value pairs

Inherited from: \vEvent::parseAttendee()

Parameters

Name	Type	Description
$key	string
$value	string

Returns

Type	Description
array	key/value pairs contanding attendee information

parseDate(
          object $key, object $date
          )
        
        :
          \date

inherited

Takes in a vCalendar formatted date and generates a (Y-m-d H:i:s) formatted date string

Inherited from: \vBasic::parseDate()\vEvent::parseDate()

Parameters

Name	Type	Description
$key	object	this is parsed to determine any timezone information
$date	object	the date in vCal format (Ymd\THis\Z)

Returns

Type	Description
\date	formated string (Y-m-d H:i:s)

process(
          object $key, object $value
          )
        
        :
          void

inherited

Handles the parsing of the vCalendar

Inherited from: \vEvent::process()

Parameters

Name	Type	Description
$key	object
$value	object

setEvent(
          object $event
          )
        
        :

inherited

converts a Sugar Event into a vEvent

Inherited from: \vEvent::setEvent()

Parameters

Name	Type	Description
$event	object

toVCalDate(
          STRING $date
          )
        
        :
          STRING

inherited

Takes in a Sugar Formatted date (Y-m-d H:i:s) and changes it to a VCal Formatted one (Ymd\THis\Z)

Inherited from: \vBasic::toVCalDate()\vEvent::toVCalDate()

Parameters

Name	Type	Description
$date	STRING	date in (Y-m-d H:i:s)

Returns

Type	Description
STRING	date - vCal Formatted

Package:

Base class for all vObjects

Parent(s): \vEvent < \vBasic

Properties


                 $parent= 'null'

inheritedInherited from: \vBasic::$$parent \vEvent::$$parent

Default valuenullDetails

Type: n/a
Inherited_from: \vBasic::$$parent
Inherited_from: \vEvent::$$parent


                 $properties= 'array()'

inheritedInherited from: \vBasic::$$properties \vEvent::$$properties

Default valuearray()Details

Type: n/a
Inherited_from: \vBasic::$$properties
Inherited_from: \vEvent::$$properties


                 $stack= 'array()'

inheritedInherited from: \vBasic::$$stack \vEvent::$$stack

Default valuearray()Details

Type: n/a
Inherited_from: \vBasic::$$stack
Inherited_from: \vEvent::$$stack

Methods

__construct(
          
          )
        
        :
          void

inherited

Inherited from: \vBasic::__construct()\vEvent::__construct()

generateVCal(
          
          )
        
        :

inherited

Generates the VCAL for the event

Inherited from: \vEvent::generateVCal()

getProperties(
          
          )
        
        :
          ARRAY

inherited

returns the properties for the given object

Inherited from: \vBasic::getProperties()\vEvent::getProperties()

Returns

Type	Description
ARRAY	of properties

getStack(
          
          )
        
        :
          ARRAY

inherited

returns the stack of events/todos/journals/FreeBusy/alarms/timezones for the given object

Inherited from: \vBasic::getStack()\vEvent::getStack()

Returns

Type	Description
ARRAY	of events

parseAttendee(
          string $key, string $value
          )
        
        :
          array

inherited

Parse attendee string into key/value pairs

Inherited from: \vEvent::parseAttendee()

Parameters

Name	Type	Description
$key	string
$value	string

Returns

Type	Description
array	key/value pairs contanding attendee information

parseDate(
          object $key, object $date
          )
        
        :
          \date

inherited

Takes in a vCalendar formatted date and generates a (Y-m-d H:i:s) formatted date string

Inherited from: \vBasic::parseDate()\vEvent::parseDate()

Parameters

Name	Type	Description
$key	object	this is parsed to determine any timezone information
$date	object	the date in vCal format (Ymd\THis\Z)

Returns

Type	Description
\date	formated string (Y-m-d H:i:s)

process(
          object $key, object $value
          )
        
        :
          void

inherited

Handles the parsing of the vCalendar

Inherited from: \vEvent::process()

Parameters

Name	Type	Description
$key	object
$value	object

setEvent(
          object $event
          )
        
        :

inherited

converts a Sugar Event into a vEvent

Inherited from: \vEvent::setEvent()

Parameters

Name	Type	Description
$event	object

toVCalDate(
          STRING $date
          )
        
        :
          STRING

inherited

Takes in a Sugar Formatted date (Y-m-d H:i:s) and changes it to a VCal Formatted one (Ymd\THis\Z)

Inherited from: \vBasic::toVCalDate()\vEvent::toVCalDate()

Parameters

Name	Type	Description
$date	STRING	date in (Y-m-d H:i:s)

Returns

Type	Description
STRING	date - vCal Formatted

Package:

Base class for all vObjects

Parent(s): \vBasic

Properties


                 $parent= 'null'

inheritedInherited from: \vBasic::$$parent

Default valuenullDetails

Type: n/a
Inherited_from: \vBasic::$$parent


                 $properties= 'array()'

inheritedInherited from: \vBasic::$$properties

Default valuearray()Details

Type: n/a
Inherited_from: \vBasic::$$properties


                 $section= '""'

Default value""Details

Type: n/a


                 $stack= 'array()'

inheritedInherited from: \vBasic::$$stack

Default valuearray()Details

Type: n/a
Inherited_from: \vBasic::$$stack


                 $timezones= 'array()'

static

Default valuearray()Details

Type: n/a


                 $winZones= 'array()'

static

Default valuearray()Details

Type: n/a

Methods

__construct(
          
          )
        
        :
          void

inherited

Inherited from: \vBasic::__construct()

generateVCal(
          
          )
        
        :
          STRING

inherited

returns the VCal String for the given object

Inherited from: \vBasic::generateVCal()

Returns

Type	Description
STRING

getProperties(
          
          )
        
        :
          ARRAY

inherited

returns the properties for the given object

Inherited from: \vBasic::getProperties()

Returns

Type	Description
ARRAY	of properties

getStack(
          
          )
        
        :
          ARRAY

inherited

returns the stack of events/todos/journals/FreeBusy/alarms/timezones for the given object

Inherited from: \vBasic::getStack()

Returns

Type	Description
ARRAY	of events

guessTimezone(
          string $tz
          )
        
        :
          \DateTimeZone

static

Guess custom timezone by name

Parameters

Name	Type	Description
$tz	string	TZ name

Returns

Type	Description
\DateTimeZone

parseDate(
          object $key, object $date
          )
        
        :
          \date

inherited

Takes in a vCalendar formatted date and generates a (Y-m-d H:i:s) formatted date string

Inherited from: \vBasic::parseDate()

Parameters

Name	Type	Description
$key	object	this is parsed to determine any timezone information
$date	object	the date in vCal format (Ymd\THis\Z)

Returns

Type	Description
\date	formated string (Y-m-d H:i:s)

process(
          string $key, string $value
          )
        
        :
          void

Process TimeZone tags

Parameters

Name	Type	Description
$key	string
$value	string

toVCalDate(
          STRING $date
          )
        
        :
          STRING

inherited

Takes in a Sugar Formatted date (Y-m-d H:i:s) and changes it to a VCal Formatted one (Ymd\THis\Z)

Inherited from: \vBasic::toVCalDate()

Parameters

Name	Type	Description
$date	STRING	date in (Y-m-d H:i:s)

Returns

Type	Description
STRING	date - vCal Formatted

Package:

Base class for all vObjects

Parent(s): \vEvent < \vBasic

Properties


                 $parent= 'null'

inheritedInherited from: \vBasic::$$parent \vEvent::$$parent

Default valuenullDetails

Type: n/a
Inherited_from: \vBasic::$$parent
Inherited_from: \vEvent::$$parent


                 $properties= 'array()'

inheritedInherited from: \vBasic::$$properties \vEvent::$$properties

Default valuearray()Details

Type: n/a
Inherited_from: \vBasic::$$properties
Inherited_from: \vEvent::$$properties


                 $stack= 'array()'

inheritedInherited from: \vBasic::$$stack \vEvent::$$stack

Default valuearray()Details

Type: n/a
Inherited_from: \vBasic::$$stack
Inherited_from: \vEvent::$$stack

Methods

__construct(
          
          )
        
        :
          void

inherited

Inherited from: \vBasic::__construct()\vEvent::__construct()

generateVCal(
          
          )
        
        :

inherited

Generates the VCAL for the event

Inherited from: \vEvent::generateVCal()

getProperties(
          
          )
        
        :
          ARRAY

inherited

returns the properties for the given object

Inherited from: \vBasic::getProperties()\vEvent::getProperties()

Returns

Type	Description
ARRAY	of properties

getStack(
          
          )
        
        :
          ARRAY

inherited

returns the stack of events/todos/journals/FreeBusy/alarms/timezones for the given object

Inherited from: \vBasic::getStack()\vEvent::getStack()

Returns

Type	Description
ARRAY	of events

parseAttendee(
          string $key, string $value
          )
        
        :
          array

inherited

Parse attendee string into key/value pairs

Inherited from: \vEvent::parseAttendee()

Parameters

Name	Type	Description
$key	string
$value	string

Returns

Type	Description
array	key/value pairs contanding attendee information

parseDate(
          object $key, object $date
          )
        
        :
          \date

inherited

Takes in a vCalendar formatted date and generates a (Y-m-d H:i:s) formatted date string

Inherited from: \vBasic::parseDate()\vEvent::parseDate()

Parameters

Name	Type	Description
$key	object	this is parsed to determine any timezone information
$date	object	the date in vCal format (Ymd\THis\Z)

Returns

Type	Description
\date	formated string (Y-m-d H:i:s)

process(
          object $key, object $value
          )
        
        :
          void

inherited

Handles the parsing of the vCalendar

Inherited from: \vEvent::process()

Parameters

Name	Type	Description
$key	object
$value	object

setEvent(
          object $event
          )
        
        :

inherited

converts a Sugar Event into a vEvent

Inherited from: \vEvent::setEvent()

Parameters

Name	Type	Description
$event	object

toVCalDate(
          STRING $date
          )
        
        :
          STRING

inherited

Takes in a Sugar Formatted date (Y-m-d H:i:s) and changes it to a VCal Formatted one (Ymd\THis\Z)

Inherited from: \vBasic::toVCalDate()\vEvent::toVCalDate()

Parameters

Name	Type	Description
$date	STRING	date in (Y-m-d H:i:s)

Returns

Type	Description
STRING	date - vCal Formatted

modules/SNIP/iCalParser.php

\Event
jump to top

Properties

\iCalendar
jump to top

Methods

\vAlarm
jump to top

Properties

Methods

\vBasic
jump to top

Properties

Methods

\vCalendar
jump to top

Properties

Methods

\vEvent
jump to top

Properties

Methods

\vFreeBusy
jump to top

Properties

Methods

\vJournal
jump to top

Properties

Methods

\vTimeZone
jump to top

Properties

Methods

\vToDo
jump to top

Properties

Methods

modules/SNIP/iCalParser.php

\Eventjump to top

Properties

\iCalendarjump to top

Methods

\vAlarmjump to top

Properties

Methods

\vBasicjump to top

Properties

Methods

\vCalendarjump to top

Properties

Methods

\vEventjump to top

Properties

Methods

\vFreeBusyjump to top

Properties

Methods

\vJournaljump to top

Properties

Methods

\vTimeZonejump to top

Properties

Methods

\vToDojump to top

Properties

Methods

\Event
jump to top

\iCalendar
jump to top

\vAlarm
jump to top

\vBasic
jump to top

\vCalendar
jump to top

\vEvent
jump to top

\vFreeBusy
jump to top

\vJournal
jump to top

\vTimeZone
jump to top

\vToDo
jump to top