Alpha Framework 4.0.0 API Documentation

CacheProviderRedis
in package
implements CacheProviderInterface

An implementation of the CacheProviderInterface interface that uses Redis as the target store.

Tags
since
1.2.4
author

John Collins dev@alphaframework.org

license

http://www.opensource.org/licenses/bsd-license.php The BSD License

copyright

Copyright (c) 2021, John Collins (founder of Alpha Framework). All rights reserved.

Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the
following conditions are met:

* Redistributions of source code must retain the above
  copyright notice, this list of conditions and the
  following disclaimer.
* Redistributions in binary form must reproduce the above
  copyright notice, this list of conditions and the
  following disclaimer in the documentation and/or other
  materials provided with the distribution.
* Neither the name of the Alpha Framework nor the names
  of its contributors may be used to endorse or promote
  products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Table of Contents

Interfaces

CacheProviderInterface
An interface that contains the methods for a cache implementation for storing business objects and other less complex values.

Properties

$appPrefix  : string
Cache key prefix to use, based on the application title, to prevent key clashes between different apps using the same cache provider.
$connection  : Redis
Connection to the cache server.
$logger  : Logger
Trace logger.

Methods

__construct()  : mixed
Constructor.
check()  : bool
Check the cache for the existance of the given $key. Returns true if the $key is set, false otherwise.
delete()  : void
Attempt to delete the value from the cache for the given $key.
get()  : mixed
Attempt to get the value from the cache for the given $key.
set()  : void
Attempt to set the value in the cache for the given $key. Old values on the same key will be overwritten.

Properties

$appPrefix

Cache key prefix to use, based on the application title, to prevent key clashes between different apps using the same cache provider.

private string $appPrefix
Tags
since
3.0.0

$connection

Connection to the cache server.

private Redis $connection
Tags
since
1.2.4

Methods

check()

Check the cache for the existance of the given $key. Returns true if the $key is set, false otherwise.

public check(mixed $key) : bool
Parameters
$key : mixed
Return values
bool

delete()

Attempt to delete the value from the cache for the given $key.

public delete(mixed $key) : void
Parameters
$key : mixed

get()

Attempt to get the value from the cache for the given $key.

public get(mixed $key) : mixed
Parameters
$key : mixed

set()

Attempt to set the value in the cache for the given $key. Old values on the same key will be overwritten.

public set(mixed $key, mixed $value[, mixed $expiry = 0 ]) : void
Parameters
$key : mixed
$value : mixed
$expiry : mixed = 0

Optional, some cache implementations will support an expiry value in seconds.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results