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

  • ActionActiveForm
  • ActionActiveFormBase
  • CActiveForm
  • CalendarEventActiveForm
  • CallActiveForm
  • CClipWidget
  • CContentDecorator
  • CFilterWidget
  • CFlexWidget
  • CHtmlPurifier
  • CInputWidget
  • CMarkdown
  • CMaskedTextField
  • CMultiFileUpload
  • COutputCache
  • COutputProcessor
  • CStarRating
  • CTabView
  • CTextHighlighter
  • CTreeView
  • CWidget
  • EventActiveForm
  • MobileActiveForm
  • NoteActiveForm
  • TimeActiveForm
  • X2ActiveForm
  • X2StarRating
  • Overview
  • Package
  • Class
  • Tree

Class COutputProcessor

COutputProcessor transforms the content into a different format.

COutputProcessor captures the output generated by an action or a view fragment and passes it to its COutputProcessor::onProcessOutput() event handlers for further processing.

The event handler may process the output and store it back to the COutputEvent::$output property. By setting the CEvent::handled handled property of the event parameter to true, the output will not be echoed anymore. Otherwise (by default), the output will be echoed.

CComponent
Extended by CBaseController
Extended by CWidget
Extended by CFilterWidget implements IFilter
Extended by COutputProcessor

Direct known subclasses

CContentDecorator, CHtmlPurifier, CMarkdown, CTextHighlighter
Package: system\web\widgets
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/widgets/COutputProcessor.php
Methods summary
public
# init( )

Initializes the widget. This method starts the output buffering.

Initializes the widget. This method starts the output buffering.

Overrides

CWidget::init()
public
# run( )

Executes the widget. This method stops output buffering and processes the captured output.

Executes the widget. This method stops output buffering and processes the captured output.

Overrides

CWidget::run()
public
# processOutput( string $output )

Processes the captured output.

Processes the captured output.

The default implementation raises an COutputProcessor::onProcessOutput() event. If the event is not handled by any event handler, the output will be echoed.

Parameters

$output
string
$output the captured output to be processed
public
# onProcessOutput( COutputEvent $event )

Raised when the output has been captured.

Raised when the output has been captured.

Parameters

$event
COutputEvent
$event event parameter
Methods inherited from CFilterWidget
__construct(), filter(), getIsFilter()
Methods inherited from CWidget
actions(), getController(), getId(), getOwner(), getViewFile(), getViewPath(), render(), setId()
Methods inherited from CBaseController
beginCache(), beginClip(), beginContent(), beginWidget(), createWidget(), endCache(), endClip(), endContent(), endWidget(), renderFile(), renderInternal(), widget()
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 inherited from CFilterWidget
$stopAction
Properties inherited from CWidget
$actionPrefix, $skin
Magic properties inherited from CFilterWidget
$isFilter
Magic properties inherited from CWidget
$controller, $id, $owner, $viewPath
API documentation generated by ApiGen 2.8.0