SublimeSnippets for CodeIgniter4

That project was started for my own needs, but some real documentation will follow and the rest of the usefull tags.

Install

Sublime Text - Package Control or Clone/Download

When i’ll add more snippets, the repo will be proposed as a Sublime Package, but until then you can clone or download it and place the folder inside ‘SublimeText3\Packages\User‘ folder.

ci- here we go…

[ci-m]+Tab Model File

Usual models location: App/Models/

The meaning of the config settings are in the docs at CI4 Docs> Modeling Data> Using CodeIgniter’s Model.

The exemple function is from the official “News section” tutorial.

Tab steps:

• ${1:App} : In case you changed your app namespace.
• ${2:News} : The name of your Model file (always uppercase first letter).
• ${3:news} : The corresponding database table (lowercase).
• ${4:id} : In case you changed the primary_key
• ${0} : The mouse cursor will end here after last tab.

<?php namespace ${1:App}\Models;
use CodeIgniter\Model;
class ${2:News}Model extends Model
{
    protected \$table = '${3:news}';  
    protected \$primaryKey = '${4:id}';
    protected $returnType = 'array';
    protected $useSoftDeletes = false;
    protected \$allowedFields = ['title', 'slug'];
    // protected $useTimestamps = false;
    // protected $createdField  = 'created_at';
    // protected $updatedField  = 'updated_at';
    // protected $deletedField  = 'deleted_at';
    // protected $validationRules    = [];
    // protected $validationMessages = [];
    // protected $skipValidation     = false;
    // Exemple function to retrive data
    public function get${2:News}(\$slug = false)
    {
        if (\$slug === false)
        {
            return \$this->orderBy('id', 'desc')->findAll();  // Get all records
        }
        return \$this->asArray()
                     ->where(['slug' => \$slug])
                     ->first();
        ${0}                                            // or Get one record
    }
}

To follow along with the official tutorial, create the news table as follow:

Within phpMyAdmin

CREATE TABLE news (
        id int(11) NOT NULL AUTO_INCREMENT,
        title varchar(128) NOT NULL,
        slug varchar(128) NOT NULL,
        body text NOT NULL,
        PRIMARY KEY (id),
        KEY slug (slug)
);
INSERT INTO news VALUES
(1,'Elvis sighted','elvis-sighted','Elvis was sighted at the Podunk internet cafe. It looked like he was writing a CodeIgniter app.'),
(2,'Say it isn\'t so!','say-it-isnt-so','Scientists conclude that some programmers have a sense of humor.'),
(3,'Caffeination, Yes!','caffeination-yes','World\'s largest coffee shop open onsite nested coffee shop for staff only.');

In the .env file from CI root folder:

database.default.hostname = localhost
database.default.database = ci4tutorial
database.default.username = root
database.default.password = root
database.default.DBDriver = MySQLi

… that will create a basic news table.

[ci-c]+Tab Controller File

Usual controllers location: App/Controllers/

Keeped (commented) the basic stuff needed to get data from a Model,
the exemple works with the News model from the official tutorial.

Read the Controllers Doc for more details.

Tab steps:

• ${1:App} : In case you changed your app namespace.
• ${2:News} : The name of your Controller file (always uppercase first letter).
• ${3:news} : The corresponding database table (lowercase).
• ${4:id} : In case you changed the primary_key
• ${0} : The mouse cursor will end here after last tab.

<?php namespace ${1:App}\Controllers;
use CodeIgniter\Controller;
//use App\Models\NewsModel;
class ${2:News} extends Controller
{
    public function index()
    {
        //\$model = new NewsModel();
            \$data = [
                //'news'  => $model->getNews(),
                'title' => 'Some title',
            ];
         echo view('${3:news}/${4:index}', $data);        
    }      
}

[ci-l]+Tab Layouts

Usual layouts location: App/Views/Layouts/

Basically an HTML skeleton with at least one ‘section’ inside,
acting like a placeholder into the views extended from the layout.

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8"/>
    <title>Layout</title>
</head>
<body>
    <?= $this->renderSection('content') ?>
</body>
</html>

[ci-v]+Tab View

Snippet file: CI4-Snippets/ci4-view.sublime-snippet

Usual models location: App/Views/

Filling up the sections defined into the layout.

<?= \$this->extend('${1:layouts/main}') ?>
<?= \$this->section('${2:content}') ?>    
${3:content goes here}
<?= \$this->endSection() ?>

License

Copyright 2019, Andrei Curelaru andrei@andikod.fr

MIT