README

Get the fork lift - Manage data repositories with cache and database layers in the Codeigniter framework.

Requirements

• PHP >= 7.1.0
• CodeIgnitor 3.x

Installation

Install the library via composer:

composer require tfhinc/ci-warehouse

Run the post install command to publish the helper and class files to the appropriate CI directories:

composer --working-dir=vendor/tfhinc/ci-warehouse/ run-script publish-files

Loading the Library

There are a few available options for loading the Warehouse library:

Using the warehouse() helper function

The Warehouse helper function will resolve the warehouse class via the CI instance. It will either load the class or return the existing class instance:

$this->load->helper('warehouse');

Using the Warehouse Class

The Warehouse class can be instantiated when you require it:

$redis = new TFHInc/Warehouse/Warehouse();

Using the Warehouse CI Library

The Warehouse class can be loaded like any other CI library:

$this->load->library('Warehouse');

Usage

// Use the helper method

$this->CI->load->helper('warehouse');

$books = warehouse()->load('Books');

// Use the Warehouse class

$warehouse = new TFHInc\Warehouse\Warehouse();

$books = $warehouse->load('Books');

// Use the Warehouse CI Library

$this->load->library('Warehouse');

$books = $warehouse->load('Books');

Contributing

Feel free to create a GitHub issue or send a pull request with any bug fixes. Please see the GutHub issue tracker for isses that require help.

Acknowledgements

• Colin Rafuse
• All Contributors

License

The MIT License (MIT). Please see License File for more information.