Overview

Packages

  • application
    • commands
    • components
      • actions
      • filters
      • leftWidget
      • permissions
      • sortableWidget
      • util
      • webupdater
      • x2flow
        • actions
        • triggers
      • X2GridView
      • X2Settings
    • controllers
    • models
      • embedded
    • modules
      • accounts
        • controllers
        • models
      • actions
        • controllers
        • models
      • calendar
        • controllers
        • models
      • charts
        • models
      • contacts
        • controllers
        • models
      • docs
        • components
        • controllers
        • models
      • groups
        • controllers
        • models
      • marketing
        • components
        • controllers
        • models
      • media
        • controllers
        • models
      • mobile
        • components
      • opportunities
        • controllers
        • models
      • products
        • controllers
        • models
      • quotes
        • controllers
        • models
      • services
        • controllers
        • models
      • template
        • models
      • users
        • controllers
        • models
      • workflow
        • controllers
        • models
      • x2Leads
        • controllers
        • models
  • None
  • system
    • base
    • caching
    • console
    • db
      • ar
      • schema
    • validators
    • web
      • actions
      • auth
      • helpers
      • widgets
        • captcha
        • pagers
  • zii
    • widgets
      • grid

Classes

  • CalendarController
  • Overview
  • Package
  • Class
  • Tree

Class CalendarController

Calendar lets you create calendar events, view actions from other modules, and sync to google calendar.

CComponent
Extended by CBaseController
Extended by CController
Extended by X2Controller
Extended by x2base
Extended by CalendarController
Package: application\modules\calendar\controllers
Located at x2engine/protected/modules/calendar/controllers/CalendarController.php
Methods summary
public array
# accessRules( )

Returns the access rules for this controller. Override this method if you use the filterAccessControl accessControl filter.

Returns the access rules for this controller. Override this method if you use the filterAccessControl accessControl filter.

Returns

array
list of access rules. See CAccessControlFilter for details about rule specification.

Overrides

CController::accessRules()
public
# actionIndex( )

Show Calendar

Show Calendar

public
# actionAdmin( )

Show Calendar

Show Calendar

public
# actionView( mixed $id )
public
# actionMyCalendarPermissions( )

Set who can view/edit current user's calendar

Set who can view/edit current user's calendar

public
# actionUserCalendarPermissions( )

Admin can set calendar permissions for all users

Admin can set calendar permissions for all users

public
# actionQuickView( mixed $id )

Overrides

x2base::actionQuickView()
public
# actionCreate( )

Create shared calendar

Create shared calendar

public
# actionUpdate( mixed $id )

update calendar with id $id

update calendar with id $id

public
# actionList( )
public
# actionDelete( mixed $id )

Delete shared Calendar

Delete shared Calendar

public
# actionJsonFeed( string $user, integer $start, integer $end )

Parameters

$user
string
$user username to fetch events for
$start
integer
$start unix time to for start of window
$end
integer
$end unix ending time
public
# actionJsonFeedGroup( mixed $groupId, mixed $start, mixed $end )
public
# actionJsonFeedGoogle( mixed $calendarId )
public
# formatActionToEvent( mixed $action, mixed $id )
public
# feedAll( integer $start = null, integer $end = null )

Retrives all checked calendar events

Retrives all checked calendar events

Parameters

$start
integer
$start starting unix time to fetch events between
$end
integer
$end ending unix time to fetch events between
public array
# feedUser( string $user, integer $start, integer $end )

Fetches events assigned to a user between two timestamps

Fetches events assigned to a user between two timestamps

Parameters

$user
string
$user username to fetch events for
$start
integer
$start UNIX timestamp for the beginning time
$end
integer
$end UNIX timestamp for the end time

Returns

array
an array of fetched events
public array
# feedGroup( integer $groupId, integer $start, integer $end )

See CalendarController::feedUser()

See CalendarController::feedUser()

Parameters

$groupId
integer
$groupId ID of the group assigned
$start
integer
$start UNIX timestamp for the beginning time
$end
integer
$end UNIX timestamp for the end time

Returns

array
An array of fetched events
public
# feedGoogle( mixed $calendarId )
public
# actionEditAction( )

Ajax requests call this function, which returns a form filled with the event data.
The form is then appended to a dialog in the users browser.

Ajax requests call this function, which returns a form filled with the event data. The form is then appended to a dialog in the users browser.

public
# actionViewAction( )

Ajax requests call this function, which returns read only action data.
The data is then appended to a dialog in the users browser.

Ajax requests call this function, which returns read only action data. The data is then appended to a dialog in the users browser.

public
# actionViewGoogleEvent( )
public
# actionEditGoogleEvent( )
public
# actionMoveAction( )
public
# actionMoveGoogleEvent( mixed $calendarId )
public
# actionResizeAction( )
public
# actionResizeGoogleEvent( mixed $calendarId )
public
# actionSaveGoogleEvent( mixed $calendarId )
public
# actionDeleteGoogleEvent( mixed $calendarId )
public
# actionCompleteAction( )
public
# actionUncompleteAction( )
public
# actionDeleteAction( )
public
# initCheckedCalendars( )
public
# actionSaveCheckedCalendar( )
public
# actionSaveCheckedCalendarFilter( )
public
# actionSyncActionsToGoogleCalendar( )
public
# actionToggleUserCalendarsVisible( )
public
# actionTogglePortletVisible( mixed $portlet )
public
# loadModel( integer $id )

Returns the data model based on the primary key given in the GET variable. If the data model is not found, an HTTP exception will be raised.

Returns the data model based on the primary key given in the GET variable. If the data model is not found, an HTTP exception will be raised.

Parameters

$id
integer
the ID of the model to be loaded
public array
# calendarActions( string|integer $calendarUser, type $start, type $end )

Retrieve calendar events for a given user happening between two specified dates.

Retrieve calendar events for a given user happening between two specified dates.

Parameters

$calendarUser
string|integer
$calendarUser Username or group ID whose calendar events are to be loaded and returned
$start
type
$start Beginning time range
$end
type
$end End time range

Returns

array
An array of action records
public type
# getCurrentUser( )

Getter function for $currentUser

Getter function for $currentUser

Returns

type
public
# insertMenu( array $selectOptions = array(), X2Model $model = null, array $menuParams = null )

Create a menu for the Calendar

Create a menu for the Calendar

Parameters

$selectOptions
array
Menu options to remove
$model
X2Model
Model object passed to the view
$menuParams
array
Additional menu parameters
Methods inherited from x2base
actionDeleteNote(), actionGetX2ModelInput(), actionSearch(), actions(), admin(), ajaxResponse(), appLockout(), beforeAction(), behaviors(), checkPermissions(), cleanUpTags(), convertUrls(), create(), decodeQuotes(), denied(), encodeQuotes(), filterSetPortlets(), filters(), getCurrentWorkflow(), getDetailView(), getHistory(), getModelFromTypeAndId(), getModelsFromTypeAndId(), getModuleObj(), getPageTitle(), getPhpMailer(), index(), mailingListToString(), parseEmailTo(), performAjaxValidation(), prepareMenu(), render(), renderLayout(), renderPartialAjax(), sendUserEmail(), setPageTitle(), throwException(), update(), view(), widget()
Methods inherited from X2Controller
badRequest(), badRequestException(), getBehaviorActions(), isAjaxRequest(), redirectToLogin(), resolveViewFile(), runBehaviorBeforeActionHandlers(), setFileFields(), validateMobileRequest()
Methods inherited from CController
__construct(), afterAction(), afterRender(), beforeRender(), clearPageStates(), createAbsoluteUrl(), createAction(), createActionFromMap(), createUrl(), filterAccessControl(), filterAjaxOnly(), filterPostOnly(), forward(), getAction(), getActionParams(), getCachingStack(), getClips(), getId(), getLayoutFile(), getModule(), getPageState(), getRoute(), getUniqueId(), getViewFile(), getViewPath(), init(), invalidActionParams(), isCachingStackEmpty(), loadPageStates(), missingAction(), processDynamicOutput(), processOutput(), recordCachingAction(), redirect(), refresh(), renderClip(), renderDynamic(), renderDynamicInternal(), renderPartial(), renderText(), replaceDynamicOutput(), run(), runAction(), runActionWithFilters(), savePageStates(), setAction(), setPageState()
Methods inherited from CBaseController
beginCache(), beginClip(), beginContent(), beginWidget(), createWidget(), endCache(), endClip(), endContent(), endWidget(), renderFile(), renderInternal()
Methods inherited from CComponent
__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()
Constants inherited from CController
STATE_INPUT_NAME
Properties summary
public string $modelClass 'X2Calendar'
#
public mixed $calendarUsers null
#
public mixed $groupCalendars null
#
public mixed $sharedCalendars null
#
public mixed $googleCalendars null
#
public mixed $calendarFilter null
#
Properties inherited from x2base
$actionMenu, $breadcrumbs, $layout, $leftPortlets, $leftWidgets, $menu, $noBackdrop, $portlets
Properties inherited from CController
$defaultAction
Magic properties summary
public User $currentUser
#

The currently logged-in user who is accessing the calendar

The currently logged-in user who is accessing the calendar

Magic properties inherited from CController
$action, $actionParams, $cachingStack, $clips, $id, $module, $pageTitle, $route, $uniqueId, $viewPath
X2CRM Documentation API documentation generated by ApiGen 2.8.0