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

  • GridViewDbSettingsBehavior
  • GridViewSessionSettingsBehavior
  • X2Settings
  • Overview
  • Package
  • Class
  • Tree

Class X2Settings

Manages storage and retrieval of settings.

CComponent
Extended by CBehavior implements IBehavior
Extended by X2Settings

Direct known subclasses

GridViewDbSettingsBehavior, GridViewSessionSettingsBehavior
Abstract
Package: application\components\X2Settings
Located at x2engine/protected/components/X2Settings/X2Settings.php
Methods summary
abstract public boolean
# saveSetting( string $key, string $val )

Parameters

$key
string
key the setting name
$val
string
key the setting value

Returns

boolean
true for success, false otherwise
abstract public mixed
# getSetting( string $key )

Parameters

$key
string
key the setting name

Returns

mixed
The value of the gv setting
public string
# getStatePrefix( )

state prefix defaults to uid or uid constructed from path and model id. It might be better to call this getUID since the state prefix isn't actually a prefix, it is the key in its entirety.

state prefix defaults to uid or uid constructed from path and model id. It might be better to call this getUID since the state prefix isn't actually a prefix, it is the key in its entirety.

Returns

string
Methods inherited from CBehavior
attach(), detach(), events(), getEnabled(), getOwner(), setEnabled()
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|null $uid null
#

$uid Allows state prefix to be explicitly set

$uid Allows state prefix to be explicitly set

public string $modelClass
#

$modelClass class of model for which settings are being saved/retrieved

$modelClass class of model for which settings are being saved/retrieved

Magic properties inherited from CBehavior
$enabled, $owner
X2CRM Documentation API documentation generated by ApiGen 2.8.0