Memcached::set

    (PECL memcached >= 0.1.0)

    Memcached::set — Store an item

    Description

    public Memcached::set(string $key, mixed $value, int $expiration = 0): bool

    Memcached::set() stores the value on a memcache server under the specified key. The expiration parameter can be used to control when the value is considered expired.

    The value can be any valid PHP type except for resources, because those cannot be represented in a serialized form. If the Memcached::OPT_COMPRESSION option is turned on, the serialized value will also be compressed before storage.

    Parameters

    key

    The key under which to store the value.

    value

    The value to store.

    expiration

    The expiration time, defaults to 0. See Expiration Times for more info.

    Return Values

    Returns true on success or false on failure. Use Memcached::getResultCode() if necessary.

    Examples

    Example #1 Memcached::set() example

    <?php
    $m     = new Memcached();
    $m->addServer('localhost', 11211);

    $m->set('int', 99);
    $m->set('string', 'a simple string');
    $m->set('array', array(11, 12));
    /* expire 'object' key in 5 minutes */
    $m->set('object', new stdClass, time() + 300);


    var_dump($m->get('int'));
    var_dump($m->get('string'));
    var_dump($m->get('array'));
    var_dump($m->get('object'));
    ?>

    The above example will output something similar to:

    int(99)
string(15) "a simple string"
array(2) {
  [0]=>
  int(11)
  [1]=>
  int(12)
}
object(stdClass)#1 (0) {
}

    See Also

    Improve This Page

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 5 notes

    up
    12
    HaxxxxaH
    8 years ago
    @PeterN

    You said that this was wrong:
    $m->set('object', new stdclass, time() + 300);

    And instead this is the correct way:
    $m->set('object', new stdclass, 300);

    When actually, they are both correct. Expiration looks at the time given, if the number is less than or equal to 30 days(60 * 60 * 24 * 30 = 2,592,000), then it expires in that many seconds. If the number is greater than 30 days, then it expires at that UNIX time.
    up
    9
    PeterN
    8 years ago
    In the example it shows:

    /* expire 'object' key in 5 minutes */
    $m->set('object', new stdclass, time() + 300);

    But this is wrong.
    It will not expire, at least, not for a long long time.
    So instead of time() + seconds, you use:
    $m->set('object', new stdclass, 300);
    And it will correctly expire after 5 minutes.

    Note: Using memcached 2.1.0 stable through PECL.
    up
    6
    Matthew Minix
    10 years ago
    Unlike Memcache, Memcached will not replace spaces in keys with underscores for you, and will instead send the key as provided which will cause an error that can result in keys and values being mismatched. You can avoid this problem by removing/replacing spaces before storage or setting the option Memcached::OPT_BINARY_PROTOCOL to true.
    up
    7
    Anonymous
    10 years ago
    00 = MEMCACHED_SUCCESS
    01 = MEMCACHED_FAILURE
    02 = MEMCACHED_HOST_LOOKUP_FAILURE // getaddrinfo() and getnameinfo() only
    03 = MEMCACHED_CONNECTION_FAILURE
    04 = MEMCACHED_CONNECTION_BIND_FAILURE // DEPRECATED see MEMCACHED_HOST_LOOKUP_FAILURE
    05 = MEMCACHED_WRITE_FAILURE
    06 = MEMCACHED_READ_FAILURE
    07 = MEMCACHED_UNKNOWN_READ_FAILURE
    08 = MEMCACHED_PROTOCOL_ERROR
    09 = MEMCACHED_CLIENT_ERROR
    10 = MEMCACHED_SERVER_ERROR // Server returns "SERVER_ERROR"
    11 = MEMCACHED_ERROR // Server returns "ERROR"
    12 = MEMCACHED_DATA_EXISTS
    13 = MEMCACHED_DATA_DOES_NOT_EXIST
    14 = MEMCACHED_NOTSTORED
    15 = MEMCACHED_STORED
    16 = MEMCACHED_NOTFOUND
    17 = MEMCACHED_MEMORY_ALLOCATION_FAILURE
    18 = MEMCACHED_PARTIAL_READ
    19 = MEMCACHED_SOME_ERRORS
    20 = MEMCACHED_NO_SERVERS
    21 = MEMCACHED_END
    22 = MEMCACHED_DELETED
    23 = MEMCACHED_VALUE
    24 = MEMCACHED_STAT
    25 = MEMCACHED_ITEM
    26 = MEMCACHED_ERRNO
    27 = MEMCACHED_FAIL_UNIX_SOCKET // DEPRECATED
    28 = MEMCACHED_NOT_SUPPORTED
    29 = MEMCACHED_NO_KEY_PROVIDED /* Deprecated. Use MEMCACHED_BAD_KEY_PROVIDED! */
    30 = MEMCACHED_FETCH_NOTFINISHED
    31 = MEMCACHED_TIMEOUT
    32 = MEMCACHED_BUFFERED
    33 = MEMCACHED_BAD_KEY_PROVIDED
    34 = MEMCACHED_INVALID_HOST_PROTOCOL
    35 = MEMCACHED_SERVER_MARKED_DEAD
    36 = MEMCACHED_UNKNOWN_STAT_KEY
    37 = MEMCACHED_E2BIG
    38 = MEMCACHED_INVALID_ARGUMENTS
    39 = MEMCACHED_KEY_TOO_BIG
    40 = MEMCACHED_AUTH_PROBLEM
    41 = MEMCACHED_AUTH_FAILURE
    42 = MEMCACHED_AUTH_CONTINUE
    43 = MEMCACHED_PARSE_ERROR
    44 = MEMCACHED_PARSE_USER_ERROR
    45 = MEMCACHED_DEPRECATED
    46 = MEMCACHED_IN_PROGRESS
    47 = MEMCACHED_SERVER_TEMPORARILY_DISABLED
    48 = MEMCACHED_SERVER_MEMORY_ALLOCATION_FAILURE
    49 = MEMCACHED_MAXIMUM_RETURN /* Always add new error code before */
    11 = MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE = MEMCACHED_ERROR
    up
    4
    miha at hribar dot info
    15 years ago
    The method correctly returns false if you set the value to false. This means that in order to have proper fault checking mechanism in place you need to check the result code.

    <?php
    $Memcached     = new Memcached();
    $Memcached->addServer('localhost', 11211);
    $Memcached->set('key', false);
    var_dump($Memcached->get('key')); // boolean false
    var_dump($Memcached->getResultCode()); // int 0 which is Memcached::RES_SUCCESS
    ?>
    ＋add a note
    To Top