Custom

Custom Directory

The custom directory is so that you can easily extend the base open source install of Nilai. You can easily overwrite models, controllers, routes, etc. All you need to do is mirror the directory and files you want to override from the /applications folder. The custom loader will check under /custom for the file first. If found, use that. If not move to /application folder. So if you want to load anything custom please create a /custom folder.

Any config/route files will load both. Meaning if you redefine /custom/configs/routes.php, the loader will load the application version first and then your custom one. That way you can just overwrite or add what you need to configuration files and not have to redefine the entire file.

If you want controllers, models or libraries to extend application version just make it so. If you rather they extend the base CI_Controller you can do that too.

Routes

The core application has default routes. If you wish to change these routes or add new one you can by adding a routes.php file to your /custom/config folder. If you are using ENVIRONMENT folders in configs you can do that as well, IE: /custom/config/development/routes.php.

You don't need to redefine every route, just create your own routes file and add or update the routes you need. The core application's routes load first, then the custom routes. So you can keep the application routes, change a few of them, add new ones or a combination of all those.

Paths

/custom/config/routes.php
/custom/config/{ENV}/routes.php

Autoloading

Autoloading works just like routes except nothing in the default autoload file is overwritten. The application itself needs items to load automatically, if you custom app does, just create your own autoload file under /custom/config/autoload.php. You don't need to redefine anything in the core one, just add what you need. We will merge the two files at runtime.

Paths

/custom/config/autoload.php
/custom/config/{ENV}/autoload.php

Configs

Configs work the same way as routes. We load the core application's configs first then any custom ones. This way you can override, add or append other items to existing application configs. Let's say your application was adding a new error code. The core application has these defined in /application/config/all/app.php. You want to add error code 702 for Random error. Simply create custom/config/all/app.php and add $config['error_codes'][702] = 'Random Error' and it will be appended to the existing error codes.

It knows if it should append or overwrite a config. If you need to load any custom configs just for your application please add them to your autoload file.

Paths

/custom/config/{CONFIG}.php
/custom/config/{ENV}/{CONFIG}.php

Hooks

Hooks are already enabled by default. If you want to add any hooks to your custom app simply add them to /custom/config/hooks.php just as you would for a default CodeIgniter install. After that just place your files in /custom/hooks folder and you should be set.

Paths

/custom/config/hooks.php
/custom/hooks/{FILE}.php

Migrations

You can add your own migration files as well. In order to try and limit merge conflicts we have updated the naming convention of migration files from NNN_Migration_name.php to YYYYMMDDHHIISS_Migration_name.php. You should use the latter. This way it will limit the amount of conflicts you get when you download a new core version of Unmark that has new migrations.

Path

/custom/migrations/YYYYMMDDHHIISS_My_Migration.php

In order to run this you will have to define your own migration config.

Path: /custom/config/migration.php
Code: $config['migration_version'] = {MIGRATION_NUMBER};

We will figure out who has the newest migration file (core or custom) and set that as the current latest migration.

Now run the update:

$ php index.php migrations latest

Helpers, Libraries, Controllers, Models & Views

You can redefine any of the core application's files just by placing them in the same folder structure and file name in your custom folder. If you do this for any of the above it will be loaded instead of the application's. This way when we update the core application you don't end up with bunch of merge conflicts.

Helper Paths

/custom/helpers/{NAME}_helper.php

Library Paths

/custom/libraries/{LIBRARY}.php

Model Paths

/custom/models/{MODEL}.php

Controller Paths

You can use folders just like you would in default CodeIgniter or place files directly in the folder.

/custom/controllers/{CONTROLLER}.php
/custom/controllers/{FOLDER}/{CONTROLLER}.php

View Paths

You can use folders just like you would in default CodeIgniter or place files directly in the folder.

/custom/views/{VIEW}.php
/custom/views/{FOLDER}/{VIEW}.php

Static Assets

You can also override any static assets using your custom folder. In order to do this you must be using either apache or nginx (you can use something else but you are on your own for the configs). If using Apache there is already a .htaccess file in the /assets folder that will look for a match in your /custom folder. If found it uses it, if not if uses the original file.

For nginx you can use this small configuration:

location ~* ^/assets/(.*)$ {
   try_files /custom/assets/$1 $uri =404;
}

Apache .htacess if using this:

<IfModule mod_rewrite.c>
    RewriteEngine On
    RewriteCond %{DOCUMENT_ROOT}/custom/%{REQUEST_URI}  -f
    RewriteRule ^(.*) /custom/assets/$1 [L,QSA]
</IfModule>

Remember

If you are loading any custom files, then you need to load them either in your custom application or in yoru autoload file. For custom controllers, you will need to add a route when applicable.

Security

It's wise on your part to add any level of security you wish. Below are a few methods:

PHP

Add this to the top of every file in the custom directory.

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

.htaccess

Deny from all

nginx

location ~* ^/custom {
    deny all;
}