Skip Navigation

UNL_UCBCN API Documentation

Developers, developers, developers, devel…

Class UNL_UCBCN_Calendar

Description
Description | Vars (details) | Methods (details)

ORM for a record within the database.

Located in /UNL/UCBCN/Calendar.php (line 30) 

DB_DataObject
   |
   --UNL_UCBCN_Calendar
Variable Summary
Description | Vars (details) | Methods (details)
mixed $account_id
mixed $calendardaterange
mixed $calendarstatus
mixed $datecreated
mixed $datelastupdated
mixed $emaillists
mixed $eventreleasepreference
mixed $externalforms
mixed $fb_enumFields
mixed $fb_enumOptions
mixed $fb_fieldLabels
mixed $fb_hiddenFields
mixed $fb_linkDisplayFields
mixed $formatcalendardata
mixed $id
mixed $name
mixed $recommendationswithinaccount
mixed $shortname
mixed $uidcreated
mixed $uidlastupdated
mixed $uploadedcss
mixed $uploadedxsl
mixed $website
mixed $__table
Method Summary
Description | Vars (details) | Methods (details)
static UNL_UCBCN_Calendar getByShortname (string $shortname)
int addEvent (UNL_UCBCN_Event $event, string $status, UNL_UCBCN_User $user, [string $source = null])
void addUser (UNL_UCBCN_User $user)
void keys ()
void links ()
void postGenerateForm ( &$form,  &$formBuilder)
void preGenerateForm ( &$fb)
void processSubscriptions ()
bool removeEvent (UNL_UCBCN_Event $event)
void removeUser (UNL_UCBCN_User $user)
void sequenceKey ()
void staticGet ( $k, [ $v = NULL])
void table ()
Variables
Description | Vars (details) | Methods (details)
mixed $account_id (line 37)
  • access: public
mixed $calendardaterange (line 42)
  • access: public
mixed $calendarstatus (line 47)
  • access: public
mixed $datecreated (line 48)
  • access: public
mixed $datelastupdated (line 50)
  • access: public
mixed $emaillists (line 46)
  • access: public
mixed $eventreleasepreference (line 41)
  • access: public
mixed $externalforms (line 52)
  • access: public
mixed $fb_enumFields = array('eventreleasepreference') (line 76)
  • access: public
mixed $fb_enumOptions = array('eventreleasepreference'=>array('Immediate','Pending')) (line 77)
  • access: public
mixed $fb_fieldLabels = array('eventreleasepreference' => 'Event Release Preference',
'shortname' => 'Short Name (this will change your calendar web address)',
'emaillists' => 'Email Lists (separated by commas)',
'recommendationswithinaccount' => 'Allow event recommendations within this account') (line 72)
  • access: public
mixed $fb_hiddenFields = array( 'account_id',
'uploadedcss',
'uploadedxsl',
'calendarstatus',
'formatcalendardata',
'calendardaterange',
'datecreated',
'uidcreated',
'datelastupdated',
'uidlastupdated',
'externalforms') (line 61)
  • access: public
mixed $fb_linkDisplayFields = array('name','shortname') (line 78)
  • access: public
mixed $formatcalendardata (line 43)
  • access: public
mixed $id (line 36)
  • access: public
mixed $name (line 38)
  • access: public
mixed $recommendationswithinaccount (line 53)
  • access: public
mixed $shortname (line 39)
  • access: public
mixed $uidcreated (line 49)
  • access: public
mixed $uidlastupdated (line 51)
  • access: public
mixed $uploadedcss (line 44)
  • access: public
mixed $uploadedxsl (line 45)
  • access: public
mixed $website (line 40)
  • access: public
mixed $__table = 'calendar' (line 35)
  • access: public
Methods
Description | Vars (details) Methods (details)
static method getByShortname (line 177)

Gets a calendar by shortname.

static UNL_UCBCN_Calendar getByShortname (string $shortname)
  • string $shortname: The shortname of the calendar you wish to get.
addEvent (line 216)

Adds the event to the current calendar.

  • return: > 0 on success.
  • access: public
int addEvent (UNL_UCBCN_Event $event, string $status, UNL_UCBCN_User $user, [string $source = null])
  • UNL_UCBCN_Event $event
  • string $status: posted | pending | archived
  • UNL_UCBCN_User $user: the user adding this event
  • string $source: create event form, subscription.
addUser (line 154)

Adds a user to the calendar. Grants all permissions to the user for the current calendar.

  • access: public
void addUser (UNL_UCBCN_User $user)
keys (line 104)
void keys ()
links (line 116)
void links ()
postGenerateForm (line 131)
  • access: public
void postGenerateForm ( &$form,  &$formBuilder)
  • &$form
  • &$formBuilder
preGenerateForm (line 123)
  • access: public
void preGenerateForm ( &$fb)
  • &$fb
processSubscriptions (line 260)

Finds the subscriptions this calendar has, and processes them.

  • access: public
void processSubscriptions ()
removeEvent (line 243)

Removes the given event from the calendar_has_event table.

  • access: public
bool removeEvent (UNL_UCBCN_Event $event)
removeUser (line 195)

Removes a user from the current calendar.

Basically removes all permissions for the user on the current calendar.

  • access: public
void removeUser (UNL_UCBCN_User $user)
sequenceKey (line 111)
void sequenceKey ()
staticGet (line 56)
void staticGet ( $k, [ $v = NULL])
  • $k
  • $v
table (line 80)
void table ()

Documentation generated on Wed, 12 Aug 2009 13:00:42 -0500 by phpDocumentor 1.4.2