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

  • CFilter
  • CFilterChain
  • CHttpCacheFilter
  • CInlineFilter
  • Overview
  • Package
  • Class
  • Tree

Class CInlineFilter

CInlineFilter represents a filter defined as a controller method.

CInlineFilter executes the 'filterXYZ($action)' method defined in the controller, where the name 'XYZ' can be retrieved from the CInlineFilter::$name property.

CComponent
Extended by CFilter implements IFilter
Extended by CInlineFilter
Package: system\web\filters
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/filters/CInlineFilter.php
Methods summary
public static CInlineFilter
# create( CController $controller, string $filterName )

Creates an inline filter instance. The creation is based on a string describing the inline method name and action names that the filter shall or shall not apply to.

Creates an inline filter instance. The creation is based on a string describing the inline method name and action names that the filter shall or shall not apply to.

Parameters

$controller
CController
$controller the controller who hosts the filter methods
$filterName
string
$filterName the filter name

Returns

CInlineFilter
the created instance

Throws

CException
if the filter method does not exist
public
# filter( CFilterChain $filterChain )

Performs the filtering. This method calls the filter method defined in the controller class.

Performs the filtering. This method calls the filter method defined in the controller class.

Parameters

$filterChain
CFilterChain
$filterChain the filter chain that the filter is on.

Overrides

CFilter::filter()
Methods inherited from CFilter
init(), postFilter(), preFilter()
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()
Properties summary
public string $name
#

name of the filter. It stands for 'XYZ' in the filter method name 'filterXYZ'.

name of the filter. It stands for 'XYZ' in the filter method name 'filterXYZ'.

API documentation generated by ApiGen 2.8.0