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

  • EmailAccount
  • EmailDropboxSettings
  • GMailAccount
  • GoogleProject
  • JSONEmbeddedModel
  • MailgunAccount
  • MailjetAccount
  • MandrillAccount
  • OutlookEmailAccount
  • SendgridAccount
  • SESAccount
  • TwitterApp
  • WidgetLayout
  • YahooEmailAccount
  • Overview
  • Package
  • Class
  • Tree

Class EmailDropboxSettings

Settings for the email dropbox.

CComponent
Extended by CModel implements IteratorAggregate, ArrayAccess
Extended by JSONEmbeddedModel
Extended by EmailDropboxSettings
Package: application\models\embedded
Author: Demitri Morgan <demitri@x2engine.com>
Located at x2engine/protected/models/embedded/EmailDropboxSettings.php
Methods summary
public array
# attributeLabels( )

Returns the attribute labels. Attribute labels are mainly used in error messages of validation. By default an attribute label is generated using CModel::generateAttributeLabel(). This method allows you to explicitly specify attribute labels.

Returns the attribute labels. Attribute labels are mainly used in error messages of validation. By default an attribute label is generated using CModel::generateAttributeLabel(). This method allows you to explicitly specify attribute labels.

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

Returns

array
attribute labels (name=>label)

See

CModel::generateAttributeLabel()

Overrides

CModel::attributeLabels()
public array
# rules( )

Returns the validation rules for attributes.

Returns the validation rules for attributes.

This method should be overridden to declare validation rules. Each rule is an array with the following structure:

array('attribute list', 'validator name', 'on'=>'scenario name', ...validation parameters...)
where
  • attribute list: specifies the attributes (separated by commas) to be validated;
  • validator name: specifies the validator to be used. It can be the name of a model class method, the name of a built-in validator, or a validator class (or its path alias). A validation method must have the following signature:
    // $params refers to validation parameters given in the rule
    function validatorName($attribute,$params)
    
    A built-in validator refers to one of the validators declared in CValidator::builtInValidators. And a validator class is a class extending CValidator.
  • on: this specifies the scenarios when the validation rule should be performed. Separate different scenarios with commas. If this option is not set, the rule will be applied in any scenario that is not listed in "except". Please see scenario for more details about this option.
  • except: this specifies the scenarios when the validation rule should not be performed. Separate different scenarios with commas. Please see scenario for more details about this option.
  • additional parameters are used to initialize the corresponding validator properties. Please refer to individual validator class API for possible properties.

The following are some examples:

array(
    array('username', 'required'),
    array('username', 'length', 'min'=>3, 'max'=>12),
    array('password', 'compare', 'compareAttribute'=>'password2', 'on'=>'register'),
    array('password', 'authenticate', 'on'=>'login'),
);

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

Returns

array
validation rules to be applied when CModel::validate() is called.

See

scenario

Overrides

CModel::rules()
public array
# attributeNames( )

Returns the list of attribute names of the model.

Returns the list of attribute names of the model.

Returns

array
list of attribute names.

Overrides

JSONEmbeddedModel::attributeNames()
public
# detailView( )

Child classes implementing this should override this function to generate a detail view. The resulting markup should be echoed out, not returned.

Child classes implementing this should override this function to generate a detail view. The resulting markup should be echoed out, not returned.

Overrides

JSONEmbeddedModel::detailView()
public type
# labelOptions( type $name, type $htmlOptions )

Generate HTML options for attribute labels.

Generate HTML options for attribute labels.

Parameters

$name
type
$name
$htmlOptions
type
$htmlOptions

Returns

type
public
# modelLabel( )

A UI-friendly name that the model should be called.

A UI-friendly name that the model should be called.

Overrides

JSONEmbeddedModel::modelLabel()
public
# renderInputs( )

Child classes implementing this should generate all necessary input form elements for modifying fields of the embedded model. The resulting markup should be echoed out, not returned.

Child classes implementing this should generate all necessary input form elements for modifying fields of the embedded model. The resulting markup should be echoed out, not returned.

Overrides

JSONEmbeddedModel::renderInputs()
Methods inherited from JSONEmbeddedModel
getMetaData(), getProtectedFieldPlaceholder(), getProtectedFields(), htmlOptions(), renderForm(), renderInput(), renderProtectedInput(), resolveName(), setAttributes()
Methods inherited from CModel
addError(), addErrors(), afterConstruct(), afterValidate(), beforeValidate(), behaviors(), clearErrors(), createValidators(), generateAttributeLabel(), getAttributeLabel(), getAttributes(), getError(), getErrors(), getIterator(), getSafeAttributeNames(), getScenario(), getValidatorList(), getValidators(), hasErrors(), isAttributeRequired(), isAttributeSafe(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), onAfterConstruct(), onAfterValidate(), onBeforeValidate(), onUnsafeAttribute(), setScenario(), unsetAttributes(), validate()
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 mixed $alias null
#
public integer $createContact 1
#
public integer $zapLineBreaks 0
#
public integer $emptyContact 1
#
public integer $logging 0
#
public integer $ignoreEmptyName 0
#
public string $caseFlag 'case #'
#
Properties inherited from JSONEmbeddedModel
$_attributeNames, $exoAttr, $exoFormName, $exoModel, $requiresAdmin
Magic properties inherited from CModel
$attributes, $errors, $iterator, $safeAttributeNames, $scenario, $validatorList, $validators
X2CRM Documentation API documentation generated by ApiGen 2.8.0