{"id":20338213,"url":"https://github.com/openclassrooms/cache","last_synced_at":"2025-04-11T23:11:46.412Z","repository":{"id":16194168,"uuid":"18940847","full_name":"OpenClassrooms/Cache","owner":"OpenClassrooms","description":"Cache library","archived":false,"fork":false,"pushed_at":"2024-12-11T17:41:47.000Z","size":65,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":27,"default_branch":"master","last_synced_at":"2025-04-11T23:11:44.594Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OpenClassrooms.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2014-04-19T12:40:08.000Z","updated_at":"2024-12-11T17:41:23.000Z","dependencies_parsed_at":"2024-11-14T21:12:16.343Z","dependency_job_id":"ccf1c106-2707-4b49-bb87-39e69a36f2c7","html_url":"https://github.com/OpenClassrooms/Cache","commit_stats":{"total_commits":63,"total_committers":3,"mean_commits":21.0,"dds":"0.19047619047619047","last_synced_commit":"7e7bdfd1b1503384f59ff6d5d29ba741a0e18ad6"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenClassrooms%2FCache","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenClassrooms%2FCache/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenClassrooms%2FCache/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenClassrooms%2FCache/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OpenClassrooms","download_url":"https://codeload.github.com/OpenClassrooms/Cache/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248492877,"owners_count":21113163,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-14T21:12:03.191Z","updated_at":"2025-04-11T23:11:46.388Z","avatar_url":"https://github.com/OpenClassrooms.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Cache\n[![Build Status](https://travis-ci.org/OpenClassrooms/Cache.svg?branch=master)](https://travis-ci.org/OpenClassrooms/Cache)\n[![SensioLabsInsight](https://insight.sensiolabs.com/projects/cb725585-b433-4a21-96aa-30a0148ecd9f/mini.png)](https://insight.sensiolabs.com/projects/cb725585-b433-4a21-96aa-30a0148ecd9f)\n[![Coverage Status](https://coveralls.io/repos/OpenClassrooms/Cache/badge.png?branch=master)](https://coveralls.io/r/OpenClassrooms/Cache?branch=master)\n\nCache adds features to Doctrine Cache implementation\n- Default lifetime\n- Fetch with a namespace\n- Save with a namespace\n- Cache invalidation through namespace strategy\n- CacheProvider Builder\n\n## Installation\nThe easiest way to install Cache is via [composer](http://getcomposer.org/).\n\nCreate the following `composer.json` file and run the `php composer.phar install` command to install it.\n\n```json\n{\n    \"require\": {\n        \"openclassrooms/cache\": \"*\"\n    }\n}\n```\n```php\n\u003c?php\nrequire 'vendor/autoload.php';\n\nuse OpenClassrooms\\Cache\\Cache\\Cache;\n\n//do things\n```\n\u003ca name=\"install-nocomposer\"/\u003e\n\n## Usage\n### Instantiation\nOC Cache needs a Doctrine CacheProvider to be instantiate.\n```php\n$cacheProvider = new ArrayCache();\n\n$cache = new Cache($cacheProvider);\n```\nA Cache builder can be used.\n```php\n// Default builder, build a cache using ArrayCache Provider\n$cache = new CacheBuilderImpl()-\u003ebuild();\n\n// Using a CacheProvider\n$cache = new CacheBuilderImpl()\n    -\u003ewithCacheProvider($redisCache)\n    -\u003ebuild();\n\n// Optional default lifetime\n$cache = new CacheBuilderImpl()\n    -\u003ewithCacheProvider($redisCache)\n    -\u003ewithDefaultLifetime(300)\n    -\u003ebuild();\n```\n\n### Default lifetime\n```php\n$cache-\u003esetDefaultLifetime(300);\n$cache-\u003esave($id, $data);\n```\n\n### Fetch with namespace\n```php\n$data = $cache-\u003efetchWithNamespace($id, $namespaceId);\n```\n\n### Save with namespace\n```php\n// Namespace and life time can be null\n$data = $cache-\u003esaveWithNamespace($id, $data, $namespaceId, $lifeTime);\n```\n\n### Cache invalidation\n```php\n$cache-\u003einvalidate($namespaceId);\n```\n### CacheProvider Builder\nThe library provides a CacheProvider Builder\n\n```php\n// Memcache\n$cacheProvider = new CacheProviderBuilderImpl()\n    -\u003ecreate(CacheProviderType::MEMCACHE)\n    -\u003ewithHost('127.0.0.1')\n    -\u003ewithPort(11211) // Default 11211\n    -\u003ewithTimeout(1) // Default 1\n    -\u003ebuild();\n\n// Memcached\n$cacheProvider = new CacheProviderBuilderImpl()\n    -\u003ecreate(CacheProviderType::MEMCACHED)\n    -\u003ewithHost('127.0.0.1')\n    -\u003ewithPort(11211) // Default 11211\n    -\u003ebuild();\n\n// Redis\n$cacheProvider = new CacheProviderBuilderImpl()\n    -\u003ecreate(CacheProviderType::REDIS)\n    -\u003ewithHost('127.0.0.1')\n    -\u003ewithPort(6379) // Default 6379\n    -\u003ewithTimeout(0.0) // Default 0.0\n    -\u003ebuild();\n\n// Array\n$cacheProvider = new CacheProviderBuilderImpl()\n    -\u003ecreate(CacheProviderType::ARRAY_CACHE)\n    -\u003ebuild();\n\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenclassrooms%2Fcache","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenclassrooms%2Fcache","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenclassrooms%2Fcache/lists"}