https://github.com/khalyomede/fetch
Quickly retrieve your PHP data
https://github.com/khalyomede/fetch
config configuration data fetch php php7
Last synced: over 1 year ago
JSON representation
Quickly retrieve your PHP data
- Host: GitHub
- URL: https://github.com/khalyomede/fetch
- Owner: khalyomede
- Created: 2018-02-28T21:29:24.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-03-07T23:29:37.000Z (over 8 years ago)
- Last Synced: 2025-03-15T03:47:37.751Z (over 1 year ago)
- Topics: config, configuration, data, fetch, php, php7
- Language: PHP
- Homepage: https://packagist.org/packages/khalyomede/fetch
- Size: 47.9 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Fetch
Quickly retrieve your PHP data.
From
```
/config
/database
database.php
option.php
app.php
```
To
```php
$fetch = new Fetch('config');
$command = $fetch->from('database.option.initial-command');
```
## Summary
- [Prerequistes](#prerequisites)
- [Installation](#installation)
- [Examples of uses](#examples-of-uses)
- [Prototype ready](#prototype-ready)
- [Methods definitions](#methods-definitions)
- [MIT licence](#mit-licence)
## Prerequisites
- PHP version >= 7.0.0
## Installation
In your project folder:
```bash
composer require khalyomede/fetch:1.*
```
## Examples of uses
All the examples below assume we are on the root (inside the `index.php` file) and we have the following arborescence:
```
/config
/database
database.php
option.php
app.php
index.php
```
- [Example 1: fetching a data from a simple file](#example-1-fetching-a-data-from-a-single-file)
- [Example 2: fetching a data by traversing multiple folders](#example-2-fetching-a-data-by-traversing-multiple-folders)
- [Example 3: fetching a data inside nested keys](#example-3-fetching-a-data-inside-nested-keys)
- [Example 4: fetching some data using a specific key](#example-4-fetching-some-data-using-a-specific-key)
- [Example 5: fetching faster using cache](#example-5-fetching-faster-using-cache)
- [Example 6: using a function before actually fetching the data](#example-6-using-a-function-before-actually-fetching-the-data)
### Example 1: fetching a data from a simple file
All the configuration file should return a PHP array.
Let us assume the file `app.php` contains:
```php
return [
'name' => 'My app',
'charset' => 'utf-8'
];
```
We can fetch the charset using:
```php
use Khalyomede\Fetch;
$fetch = new Fetch( __DIR__ . '/config' );
$charset = $fetch->from('app.charset');
print_r($charset);
```
This will display
```
utf-8
```
### Example 2: fetching a data by traversing multiple folders
All the configuration files should return a PHP array.
Let us assume the file `option.php` contains:
```php
return [
'initial-command' => "SET names 'utf-8'"
];
```
```php
use Khalyomede\Fetch;
$fetch = new Fetch( __DIR__ . '/config' );
$initial_command = $fetch->from('database.option.initial-command');
print_r($initial_command);
```
Will display
```
SET names 'utf-8'
```
### Example 3: fetching a data inside nested keys
All configuration files should return a PHP array.
Let us assume the file `option.php` contains:
```php
return [
'cache' => [
'strategy' => 'cache-first'
]
];
```
```php
use Khalyomede\Fetch;
$fetch = new Fetch( __DIR__ . '/config' );
$strategy = $fetch->from('database.option.cache.strategy');
print_r($stategy);
```
Will display:
```
cache-first
```
### Example 4: fetching some data using a specific key
All configuration files should return PHP array.
Let us assume the file `option.php` contains:
```php
return [
'cache' => [
'strategy' => 'cache-first'
],
'timeout' => 12.5
];
```
```php
use Khalyomede\Fetch;
$fetch = new Fetch( __DIR__ . '/config' );
$data = $fetch->from('database.option');
print_r($data);
```
Will display:
```php
Array
(
[cache] => Array
(
[strategy] => cache-first
)
[timeout] => 12.5
)
```
### Example 5: fetching faster using cache
Let us assume a new folder has been created, called `cache`. Here is the updated arborescence:
```
/config
/database
option.php
app.php
/cache
index.php
```
```php
use Khalyomede\Fetch;
$fetch = new Fetch( __DIR__ . '/config' );
$fetch->usingCache( __DIR__ . '/cache' );
$charset = $fetch->from('app.charset');
```
The first fetching might be slow, but the subsequent fetches will be much more faster while the cached data is not removed.
**Note**
This library will not handles the cache removing.
**Tips**
Think to disable the cache when you are in development mode as your configuration file will changed a lot and might be outdated without updating to the new value. This tips features Laravel 5 debug helper.
```php
use Khalyomede\Fetch;
// ...
$fetch = new Fetch( base_path() . '/config' );
if( config('app.debug') !== true ) {
$fetch->usingCache( base_path() . '/' )
}
$language = $fetch->from('app.locale');
```
**Warning**
The cache might be outdated if you use it without clearing it after an update of your configuration data.
### Example 6: using a function before actually fetching the data
You can apply "middleware" function before fetching/caching the data if needed.
```php
use Khalyomede\Fetch;
$fetch = new Fetch( __DIR__ . '/config' );
$remove_dashes = function ($data) {
return str_replace('-', '', $data);
};
$charset = $fetch->across($remove_dashes)->from('app.charset');
print_r($charset);
```
Will display
```
utf8
```
**Note**
The anonymous takes only one parameter and it can be frustrating. Use `use` statement to help you pass more arguments and overcome this constraint:
```php
use Khalyomede\Fetch;
$fetch = new Fetch( __DIR__ . '/config' );
$now = (new DateTime())->format('Y-m-d');
$charset = $fetch->across(function($data) use($now) {
return "$data ($now)";
})->from('app.charset');
print_r($charset);
```
Will display
```
utf-8 (2018-03-03)
```
**Note 2**
Once the function is set, it is applyied for any further fetches. If you want to remove the function, you can use `uncross()` to do so:
```php
use Khalyomede\Fetch;
$fetch = new Fetch( __DIR__ . '/config' );
$fetch->across(function($data) {
return str_replace('-', '', $data);
});
$charset = $fetch->from('app.charset');
print_r($charset);
$fetch->uncross(); // or $fetch->uncross()->from('...');
$timeout = $fetch->from('database.option.timeout');
print_r($timeout);
```
Will display
```
utf8
12.5
```
## Prototype ready
This class lets you extend its functionality to your needs without having to dive into the source code. For example:
```php
$fetch->prototype('exists', function($path) {
$exists = false;
try {
$this->from($path);
$exists = true;
}
catch(Exception $e) {}
return $exists;
});
if($fetch->exists('test')) {
echo $fetch->from('test');
}
else {
echo 'this configuration does not exists';
}
```
For more information, check [khalyomede/prototype](https://github.com/khalyomede/prototype) documentation.
## Methods definitions
- [across()](#across)
- [construct()](#construct)
- [crypt()](#crypt)
- [decrypt()](#decrypt)
- [disableCache()](#disablecache)
- [enableCache()](#enablecache)
- [from()](#from)
- [uncross()](#uncross)
- [usingCache()](#usingcache)
### construct()
Sets the default folder to fetch the data from.
```php
public function __construct(string $folder_path): Fetch
```
**Exceptions**
`InvalidArgumentException`:
- If the folder path does not exists
- If the folder path is not a folder
### from()
Fetch the data from the given path.
```php
public function from(string $path): mixed
```
**Exceptions**
`InvalidArgumentException`:
- If the path is empty
- If one of the key is empty (for example: "database.option.")
- If the targeted configuration file does not return an array
- If the path targets an non existing key
`UnexpectedValueException`:
- If the cache folder has not been specifyied when the cache mode has been enabled
`RuntimeException`:
- If the targeted configuration file is not available is read mode
- If the cached data file is not available in read mode
### usingCache()
Specify the folder for storing the cached data and enable the cache mode.
```php
public function usingCache(string $cache_folder_path): Fetch
```
**Exceptions**
`InvalidArgumentException`:
- If the folder does not exists
- If the path does not target a folder
### enableCache()
Enable the cache mode.
```php
public function enableCache(): Fetch
```
### disableCache()
Disable the cache mode.
```php
public function disableCache(): Fetch
```
### encrypt()
Useful when you need to get the same files name to perform additional processes from a path.
```php
public function encrypt(string $string): string
```
### decrypt()
Useful when you want to get the original path used for storing the cached file using the cached file name.
```php
public function decrypt(string $string): string
```
**Note**
Do not include the file extension (`.php`) when decrypting using the file name.
### across()
Apply a function (which should be an anonymous, i.e. a closure) before fetching or caching the data.
The function should have only one parameter, which will be filled with the fetched data.
```php
public function across(callable $function): Fetch
```
**Exceptions**
`InvalidArgumentException`:
- If the function is not an anonymous function (i.e. a closure)
- If the function does not have exactly one parameter
- If the function does not have exactly one required parameter
`ReflectionException`:
- Check the [package website](http://php.net/manual/en/reflectionfunction.construct.php#refsect1-reflectionfunction.construct-errors) for more information
### uncross()
Removes the previously set function (made by `Fetch::across`).
```php
public function uncross(): Fetch
```
## MIT Licence
Fetch
Copyright © 2018 Khalyomede
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the oftware, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN CTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.