README

REST Full Server for Codeigniter 3

Requirements

• PHP 5.3.x (Composer requirement)
• CodeIgniter 3.x

Installation

Step 1 Installation by Composer

Run composer

composer require maltyxx/restserver

Step 2 Create files

Create controller file in /application/core/MY_Controller.php.

<?php
defined('BASEPATH') OR exit('No direct script access allowed');

class MY_Controller extends CI_Controller
{
    public function __construct() {
        parent::__construct();
    }
}

require(FCPATH.'vendor/maltyxx/restserver/core/Restserver_controller.php');

Only if you use Form_validation.

<?php
defined('BASEPATH') OR exit('No direct script access allowed');
require(FCPATH.'vendor/maltyxx/restserver/libraries/MY_Form_validation.php');

Step 3 Configuration

Duplicate configuration file ./application/vendor/maltyxx/restserver/config/restserver.php in ./application/config/restserver.php.

Step 4 Rules

// Setting Rules Using an Array
$config = array(
    array(
            'field' => 'username',
            'label' => 'Username',
            'rules' => 'required'
    ),
    array(
            'field' => 'password',
            'label' => 'Password',
            'rules' => 'required',
            'errors' => array(
                    'required' => 'You must provide a %s.',
            ),
    ),
    array(
            'field' => 'passconf',
            'label' => 'Password Confirmation',
            'rules' => 'required'
    ),
    array(
            'field' => 'email',
            'label' => 'Email',
            'rules' => 'required'
    )
);

$this->restserver->set_rules($config);

// More exemples
https://www.codeigniter.com/user_guide/libraries/form_validation.html?highlight=form

Step 5 Examples

Controller file is located in ./application/controllers/Server.php.

<?php
defined('BASEPATH') OR exit('No direct script access allowed');

class Server extends Restserver_Controller {

    public function __construct() {
        parent::__construct();
        
        // Configuration
        $config = array(
            array(
                // Nom entrant (requis)
                'field' => 'lastname',

                // Modélisation interne (option)
                'alias' => 'user.lastname|famille.pere.nom',

                // Nom du champ (option)
                'label' => 'Nom',

                // Les règles (option)
                'rules' => 'required_post|alpha|min_length[2]|max_length[250]',

                // Documentation (option)
                'comment' =>
                    "Input: lastname".PHP_EOL.
                    "Label: Nom de famille".PHP_EOL.
                    "Type: string (min 2, max 250 caractères)".PHP_EOL.
                    "Requis: POST"
            )
        );
        
        $this->restserver->set_rules($config);
    }

    /**
     * Méthode POST
     */
    public function post() {
        // ---------- Exemple de récupération
        // Récupération du champ entrant
        $lastname = $this->restserver->post('lastname');
        
        // Récupération du champ modélisé
        $alias = $this->restserver->alias();
        
        // Espace de nom 1
        $lastname = $alias['user']['lastname'];
        
        // Espace de nom 2
        $lastname = $alias['famille']['pere']['nom'];
        
        // ---------- Réponse
        $response = $this->restserver->protocol();
        $response['status'] = TRUE;
        $response['error'] = NULL;
        $response['value'] = array(
            'lastname' => $lastname
        );
        
        // Envoi la réponse avec le code HTTP 201 Created
        $this->restserver->response($response, 201);
    }
    
    /**
     * Méthode GET
     */
    public function get() {        
        $this->restserver->response();
    }
        
    /**
     * Méthode PUT
     */
    public function put() {
        $this->restserver->response();
    }
    
    /**
     * Méthode DELETE
     */
    public function delete() {
        $this->restserver->response();
    }
}