namemsile/caramel

Caramel is Codeigniter package

Caramel

, _(*1)

Caramel is codeigniter package. Delight for your web application., _(*2)

Caramel mixed with Illuminate Database library, Twig template engine and Sentry authorization and authentication package, _(*3)

Install

Install Codeigniter framework firstly. You can just simply download .zip package from Codeigniter website or via composer:, _(*4)

composer create-project bcit-ci/CodeIgniter

Once Codeigniter installed,, _(*5)

in application/config/config.php set Composer autoloader path:, _(*6)

$config['composer_autoload'] = FCPATH . 'vendor/autoload.php';

In composer.json file and add psr-4 autoload for models:, _(*7)

"autoload": { "psr-4": { "App\\Models\\": "application/models/" } },, _(*8)

then run composer require command:, _(*9)

composer require namesmile/caramel

Usage

Controller

Caramel shipped with abstract Caramel_Controller. Caramel controller can use templates and auth library., _(*10)

To enable templating for controller you need setup protected $templated to true. For auth acccess to controller, just change protected $guarded to true also., _(*11)

use Smartcat\Caramel\Controllers\Caramel_Controller;

    /**
     * Use template
     * @var bool
     */
    protected $templated = true;

    /**
     * Use garde
     * @var bool
     */
    protected $guarded = true;

    /**
     * Controller constructor
     */
    public function __construct()
    {
        parent::__construct();

        /**
         * Check auth
         */
        if (! $this->garde->check()) {
            $this->template->set_flash('Auth consroller');
            redirect('/');
        }
    }

    /**
     * Index controller method
     *
     * @return CI_Output
     */
    public function index()
    {
        return $this->template->render('app');
    }

You can also use only garde or template independently., _(*12)