iron-io / iron_cache
Client binding for IronCache (A key/value store in the cloud)
Installs: 14 798
Dependents: 2
Suggesters: 0
Security: 0
Stars: 15
Watchers: 17
Forks: 8
Open Issues: 3
Requires
- php: >=5.2.0
- iron-io/iron_core: *
This package is not auto-updated.
Last update: 2024-10-26 14:27:37 UTC
README
Getting Started
Get credentials
To start using iron_cache_php, you need to sign up and get an oauth token.
- Go to http://iron.io/ and sign up.
- Get an Oauth Token at http://hud.iron.io/tokens
Install iron_cache_php
There are two ways to use iron_cache_php:
Using precompiled phar archive:
Copy iron_cache.phar
to target directory and include it:
<?php require_once "phar://iron_cache.phar";
Please note, phar extension available by default only from php 5.3.0 For php 5.2 you should install phar manually or use second option.
Using classes directly
- Copy
IronCache.class.php
to target directory - Grab
IronCore.class.php
there and copy to target directory - Include both of them:
<?php require_once "IronCore.class.php" require_once "IronCache.class.php"
Configure
Three ways to configure IronCache:
- Passing array with options:
<?php $cache = new IronCache(array( 'token' => 'XXXXXXXXX', 'project_id' => 'XXXXXXXXX' ));
- Passing ini file name which stores your configuration options. Rename sample_config.ini to config.ini and include your Iron.io credentials (
token
andproject_id
):
<?php $cache = new IronCache('config.ini');
-
Automatic config search - pass zero arguments to constructor and library will try to find config file in following locations:
iron.ini
in current directoryiron.json
in current directoryIRON_CACHE_TOKEN
,IRON_CACHE_PROJECT_ID
and other environment variablesIRON_TOKEN
,IRON_PROJECT_ID
and other environment variables.iron.ini
in user's home directory.iron.json
in user's home directory
The Basics
Put an item in the cache:
<?php $res = $cache->put("mykey", "hello world!");
Get an item from the cache:
<?php $item = $cache->get("mykey");
Increment an item value in the cache:
<?php $res = $cache->increment("mykey", 1);
Delete an item from the cache:
<?php $res = $cache->delete("mykey");
Cache Selection
Select cache before interacting with items
- In constructor:
$cache = new IronCache('config.ini', 'my_cache');
- By method:
$cache->setCacheName('my_cache');
- Do it later when you need:
$cache->getItem('my_cache','my_key');
Using IronCache as session store
<?php $cache = new IronCache(); $cache->set_as_session_store(); # Use session as usual session_start(); ...
Troubleshooting
http error: 0
If you see Uncaught exception 'Http_Exception' with message 'http error: 0 | '
it most likely caused by misconfigured cURL https sertificates.
There are two ways to fix this error:
- Disable SSL sertificate verification - add this line after IronCache initialization:
$cache->ssl_verifypeer = false;
- Switch to http protocol - add this to configuration options:
protocol = http
andport = 80