0 follower

CMemCacheServerConfiguration

Package system.caching
Inheritance class CMemCacheServerConfiguration » CComponent
Since 1.0
Source Code framework/caching/CMemCache.php
CMemCacheServerConfiguration represents the configuration data for a single memcache server.

See https://www.php.net/manual/en/function.Memcache-addServer.php for detailed explanation of each configuration property.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
host string memcache server hostname or IP address CMemCacheServerConfiguration
persistent boolean whether to use a persistent connection CMemCacheServerConfiguration
port integer memcache server port CMemCacheServerConfiguration
retryInterval integer how often a failed server will be retried (in seconds) CMemCacheServerConfiguration
status boolean if the server should be flagged as online upon a failure CMemCacheServerConfiguration
timeout integer value in seconds which will be used for connecting to the server CMemCacheServerConfiguration
weight integer probability of using this server among all servers. CMemCacheServerConfiguration

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. CComponent
__construct() Constructor. CMemCacheServerConfiguration
__get() Returns a property value, an event handler list or a behavior based on its name. CComponent
__isset() Checks if a property value is null. CComponent
__set() Sets value of a component property. CComponent
__unset() Sets a component property to be null. CComponent
asa() Returns the named behavior object. CComponent
attachBehavior() Attaches a behavior to this component. CComponent
attachBehaviors() Attaches a list of behaviors to the component. CComponent
attachEventHandler() Attaches an event handler to an event. CComponent
canGetProperty() Determines whether a property can be read. CComponent
canSetProperty() Determines whether a property can be set. CComponent
detachBehavior() Detaches a behavior from the component. CComponent
detachBehaviors() Detaches all behaviors from the component. CComponent
detachEventHandler() Detaches an existing event handler. CComponent
disableBehavior() Disables an attached behavior. CComponent
disableBehaviors() Disables all behaviors attached to this component. CComponent
enableBehavior() Enables an attached behavior. CComponent
enableBehaviors() Enables all behaviors attached to this component. CComponent
evaluateExpression() Evaluates a PHP expression or callback under the context of this component. CComponent
getEventHandlers() Returns the list of attached event handlers for an event. CComponent
hasEvent() Determines whether an event is defined. CComponent
hasEventHandler() Checks whether the named event has attached handlers. CComponent
hasProperty() Determines whether a property is defined. CComponent
raiseEvent() Raises an event. CComponent

Property Details

host property
public string $host;

memcache server hostname or IP address

persistent property
public boolean $persistent;

whether to use a persistent connection

port property
public integer $port;

memcache server port

retryInterval property
public integer $retryInterval;

how often a failed server will be retried (in seconds)

status property
public boolean $status;

if the server should be flagged as online upon a failure

timeout property
public integer $timeout;

value in seconds which will be used for connecting to the server

weight property
public integer $weight;

probability of using this server among all servers.

Method Details

__construct() method
public void __construct(array $config)
$config array list of memcache server configurations.
Source Code: framework/caching/CMemCache.php#288 (show)
public function __construct($config)
{
    if(is_array($config))
    {
        foreach($config as $key=>$value)
            $this->$key=$value;
        if($this->host===null)
            throw new CException(Yii::t('yii','CMemCache server configuration must have "host" value.'));
    }
    else
        throw new CException(Yii::t('yii','CMemCache server configuration must be an array.'));
}

Constructor.