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
  • Net
  • None
  • PHP
  • system
    • base
    • caching
      • dependencies
    • collections
    • console
    • db
      • ar
      • schema
        • cubrid
        • mssql
        • mysql
        • oci
        • pgsql
        • sqlite
    • i18n
      • gettext
    • logging
    • test
    • utils
    • validators
    • web
      • actions
      • auth
      • filters
      • form
      • helpers
      • renderers
      • services
      • widgets
        • captcha
        • pagers
  • Text
    • Highlighter
  • zii
    • behaviors
    • widgets
      • grid
      • jui

Classes

  • CAction
  • CInlineAction
  • CreateWebFormAction
  • CViewAction
  • GetActionsBetweenAction
  • MobileAction
  • MobileActivityAction
  • MobileCreateAction
  • MobileDeleteAction
  • MobileIndexAction
  • MobileProfileViewAction
  • MobilePublisherAction
  • MobileResetPasswordAction
  • MobileTopicsCreateAction
  • MobileTopicsDeleteReplyAction
  • MobileTopicsIndexAction
  • MobileTopicsUpdateAction
  • MobileTopicsUpdateReplyAction
  • MobileTopicsViewAction
  • MobileUpdateAction
  • MobileViewAction
  • MobileViewEventAction
  • RecordAliasesCreateAction
  • RecordAliasesDeleteAction
  • WebFormAction
  • X2GridViewMassActionAction
  • X2ModelConversionAction
  • Overview
  • Package
  • Class
  • Tree

Class CAction

CAction is the base class for all controller action classes.

CAction provides a way to divide a complex controller into smaller actions in separate class files.

Derived classes must implement run() which is invoked by controller when the action is requested.

An action instance can access its controller via getController controller property.

CComponent
Extended by CAction implements IAction

Direct known subclasses

AjaxGetModelAutocompleteAction, CCaptchaAction, RecordAliasesCreateAction, RecordAliasesDeleteAction, TestEmailAction, WebFormAction, WebUpdaterAction, X2GridViewMassActionAction, X2ModelConversionAction, CInlineAction, CreateWebFormAction, CViewAction, CWebServiceAction, GetActionsBetweenAction, GetItemsAction, InlineEmailAction, MobileAction

Indirect known subclasses

DatabaseBackupAction, MobileActivityAction, MobileTopicsIndexAction, MobileTopicsUpdateAction, MobileTopicsUpdateReplyAction, MobileTopicsViewAction, MobileUpdateAction, MobileViewAction, MobileViewEventAction, UpdaterAction, UpdateStageAction, MobileCreateAction, MobileDeleteAction, MobileIndexAction, MobileProfileViewAction, MobilePublisherAction, MobileResetPasswordAction, MobileTopicsCreateAction, MobileTopicsDeleteReplyAction
Abstract
Package: system\web\actions
Copyright: 2008-2013 Yii Software LLC
License: http://www.yiiframework.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 1.0
Located at x2engine/framework/web/actions/CAction.php
Methods summary
public
# __construct( CController $controller, string $id )

Constructor.

Constructor.

Parameters

$controller
CController
$controller the controller who owns this action.
$id
string
$id id of the action.
public CController
# getController( )

Returns

CController
the controller who owns this action.

Implementation of

IAction::getController()
public string
# getId( )

Returns

string
id of this action

Implementation of

IAction::getId()
public boolean
# runWithParams( array $params )

Runs the action with the supplied request parameters. This method is internally called by CController::runAction().

Runs the action with the supplied request parameters. This method is internally called by CController::runAction().

Parameters

$params
array
$params the request parameters (name=>value)

Returns

boolean
whether the request parameters are valid

Since

1.1.7
protected boolean
# runWithParamsInternal( mixed $object, ReflectionMethod $method, array $params )

Executes a method of an object with the supplied named parameters. This method is internally used.

Executes a method of an object with the supplied named parameters. This method is internally used.

Parameters

$object
mixed
$object the object whose method is to be executed
$method
ReflectionMethod
$method the method reflection
$params
array
$params the named parameters

Returns

boolean
whether the named parameters are valid

Since

1.1.7
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()
Magic methods summary
public mixed
# run( )

executes action

executes action

Returns

mixed
Magic properties summary
public CController $controller
#

The controller who owns this action.

The controller who owns this action.

public string $id
#

Id of this action.

Id of this action.

API documentation generated by ApiGen 2.8.0