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

  • ActionsController
  • Overview
  • Package
  • Class
  • Tree

Class ActionsController

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

Returns a list of behaviors that this controller should behave as. The return value should be an array of behavior configurations indexed by behavior names. Each behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName'=>array(
    'class'=>'path.to.BehaviorClass',
    'property1'=>'value1',
    'property2'=>'value2',
)

Returns a list of behaviors that this controller should behave as. The return value should be an array of behavior configurations indexed by behavior names. Each behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName'=>array(
    'class'=>'path.to.BehaviorClass',
    'property1'=>'value1',
    'property2'=>'value2',
)

Note, the behavior classes must implement IBehavior or extend from CBehavior. Behaviors declared in this method will be attached to the controller when it is instantiated.

For more details about behaviors, see CComponent.

Returns

array
the behavior configurations (behavior name=>behavior configuration)

Overrides

x2base::behaviors()
public array
# accessRules( )

Specifies the access control rules. This method is used by the 'accessControl' filter.

Specifies the access control rules. This method is used by the 'accessControl' filter.

Returns

array
access control rules

Overrides

CController::accessRules()
public array
# actions( )

Returns a list of external action classes. Array keys are action IDs, and array values are the corresponding action class in dot syntax (e.g. 'edit'=>'application.controllers.article.EditArticle') or arrays representing the configuration of the actions, such as the following,

return array(
    'action1'=>'path.to.Action1Class',
    'action2'=>array(
        'class'=>'path.to.Action2Class',
        'property1'=>'value1',
        'property2'=>'value2',
    ),
);

Derived classes may override this method to declare external actions.

Returns a list of external action classes. Array keys are action IDs, and array values are the corresponding action class in dot syntax (e.g. 'edit'=>'application.controllers.article.EditArticle') or arrays representing the configuration of the actions, such as the following,

return array(
    'action1'=>'path.to.Action1Class',
    'action2'=>array(
        'class'=>'path.to.Action2Class',
        'property1'=>'value1',
        'property2'=>'value2',
    ),
);

Derived classes may override this method to declare external actions.

Note, in order to inherit actions defined in the parent class, a child class needs to merge the parent actions with child actions using functions like array_merge().

You may import actions from an action provider (such as a widget, see CWidget::actions), like the following:

return array(
    ...other actions...
    // import actions declared in ProviderClass::actions()
    // the action IDs will be prefixed with 'pro.'
    'pro.'=>'path.to.ProviderClass',
    // similar as above except that the imported actions are
    // configured with the specified initial property values
    'pro2.'=>array(
        'class'=>'path.to.ProviderClass',
        'action1'=>array(
            'property1'=>'value1',
        ),
        'action2'=>array(
            'property2'=>'value2',
        ),
    ),
)

In the above, we differentiate action providers from other action declarations by the array keys. For action providers, the array keys must contain a dot. As a result, an action ID 'pro2.action1' will be resolved as the 'action1' action declared in the 'ProviderClass'.

Returns

array
list of external action classes

See

CController::createAction()

Overrides

x2base::actions()
public
# actionSaveShowActions( )
public
# actionView( integer $id )

Displays a particular model.

Displays a particular model.

Parameters

$id
integer
$id the ID of the model to be displayed
public
# actionViewEmail( mixed $id )
public
# actionViewAction( mixed $id, mixed $publisher = false )
public
# actionShareAction( mixed $id )
public
# create( mixed $model, mixed $oldAttributes, mixed $api )

Creates a new model. If creation is successful, the browser will be redirected to the 'view' page.

Creates a new model. If creation is successful, the browser will be redirected to the 'view' page.

Overrides

x2base::create()
public
# actionCreate( )

Creates a new model. If creation is successful, the browser will be redirected to the 'view' page.

Creates a new model. If creation is successful, the browser will be redirected to the 'view' page.

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

Create a menu for Actions

Create a menu for Actions

Parameters

$selectOptions
array
Menu options to remove
$model
X2Model
Model object passed to the view
$menuParams
array
Additional menu parameters
public
# update( integer $model, mixed $oldAttributes, mixed $api )

Updates a particular model. If update is successful, the browser will be redirected to the 'view' page.

Updates a particular model. If update is successful, the browser will be redirected to the 'view' page.

Parameters

$model
integer
$id the ID of the model to be updated
$oldAttributes
$api

Overrides

x2base::update()
public
# actionUpdate( integer $id )

Updates a particular model. If update is successful, the browser will be redirected to the 'view' page.

Updates a particular model. If update is successful, the browser will be redirected to the 'view' page.

Parameters

$id
integer
$id the ID of the model to be updated
public
# actionCopyEvent( mixed $id )
public
# actionQuickUpdate( mixed $id )
public
# actionToggleSticky( mixed $id )
public
# delete( integer $id )

API method to delete an action

API method to delete an action

Parameters

$id
integer
$id The id of the action
public
# actionDelete( integer $id )

Deletes an action

Deletes an action

Parameters

$id
integer
$id The id of the action
public
# actionComplete( integer $id )

Marks an action as complete and redirects back to the page it was completed on.

Marks an action as complete and redirects back to the page it was completed on.

Parameters

$id
integer
$id The id of the action
public
# actionUncomplete( integer $id )

Marks an action as incomplete and clears the completedBy field.

Marks an action as incomplete and clears the completedBy field.

Parameters

$id
integer
$id The id of the action
public
# actionEmailOpened( integer $uid, string $type )

Called when a Contact opens an email sent from Inline Email Form. Inline Email Form appends an image to the email with src pointing to this function. This function creates an action associated with the Contact indicating that the email was opened.

Called when a Contact opens an email sent from Inline Email Form. Inline Email Form appends an image to the email with src pointing to this function. This function creates an action associated with the Contact indicating that the email was opened.

Parameters

$uid
integer
$uid The unique id of the recipient
$type
string
$type 'open', 'click', or 'unsub'
public
# actionIndex( )
public
# actionViewAll( )

List all public actions

List all public actions

public
# actionViewGroup( )
public
# actionInvalid( )
public
# actionParseType( )
public
# getAssociation( mixed $type, mixed $id )
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
# actionGetItems( mixed $term )
protected
# performAjaxValidation( CModel $model )

Performs AJAX validation.

Performs AJAX validation.

Parameters

$model
CModel
the model to be validated

Overrides

x2base::performAjaxValidation()
Methods inherited from x2base
actionDeleteNote(), actionGetX2ModelInput(), actionQuickView(), actionSearch(), admin(), ajaxResponse(), appLockout(), beforeAction(), checkPermissions(), cleanUpTags(), convertUrls(), decodeQuotes(), denied(), encodeQuotes(), filterSetPortlets(), filters(), getCurrentWorkflow(), getDetailView(), getHistory(), getModelFromTypeAndId(), getModelsFromTypeAndId(), getModuleObj(), getPageTitle(), getPhpMailer(), index(), mailingListToString(), parseEmailTo(), prepareMenu(), render(), renderLayout(), renderPartialAjax(), sendUserEmail(), setPageTitle(), throwException(), 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 'Actions'
#
public mixed $showActions null
#
Properties inherited from x2base
$actionMenu, $breadcrumbs, $layout, $leftPortlets, $leftWidgets, $menu, $noBackdrop, $portlets
Properties inherited from CController
$defaultAction
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