Struktur Direktori

Setiap project yang menggunakan O2System Framework memiliki 5 struktur direktori dasar pada root-nya, yang terdiri dari:
1.Direktori App
2.Direktori Cache
3.Direktori Public
4.Direktori Storage
5.Direktori Vendor
Masing-masing direktori tersebut memiliki peruntukannya masing-masing.
Direktori App
Direktori aplikasi berisi semua source-code aplikasi anda yang tersusun rapi sesuai dengan peruntukkannya masing-masing. Secara default, direktori ini berada dalam namespace App dan di-autoload oleh Composer dan O2System Framework autoloader menggunakan standar autoloading PSR-4.
Hampir seluruh file class-class php pada folder app dapat digenerate menggunakan O2System Console Commands. Untuk mempelajari perintah-perintahnya, jalankan perintah:
php o2system make --help
Directory Structure
Seperti yang terlihat pada gambar diatas, struktur pada direktori app memiliki beberapa sub-direktori. Beberapa diantaranya merupakan sub-direktori yang memiliki fungsi penting dan tidak dapat anda gantikan nama sub-direktori tersebut dengan nama lain. Walaupun demikian anda tetap dapat menambahkan sub-direktori baru dengan nama lain sesuai dengan preferensi masing-masing namun harus tetap mematuhi standar penulisan nama direktori PSR-4.
Direktori Config
Tempat menyimpan semua file-file konfigurasi aplikasi anda. File Config diharuskan ber-format file PHP, yang berisikan variable bertipe array atau bertipe object dari class O2System\Kernel\Datastructures\Config, berlaku untuk turunannya. Penamaan nama variable harus ber-format camelcase dari nama filename Config tersebut, sedangkan untuk penulisan nama filename harus berstandar PSR-4 yaitu dengan format penulisan StudlyCase.
1
<?php
2
/**
3
 * $yourConfig
4
 *
5
 * Configuration example.
6
 *
7
 * @var array
8
 */
9
$yourConfig = [
10
    'key' => 'value'
11
];
12
// ------------------------------------------------------------------------
13
​
14
/**
15
 * $yourConfig
16
 *
17
 * Configuration example.
18
 *
19
 * @var \O2System\Kernel\Datastructures\Config
20
 */
21
$yourConfig = new \O2System\Kernel\Datastructures\Config([
22
    'key' => 'value'
23
]);
Copied!
Script diatas harus disimpan dengan filename 
app/Config/YourConfig.php
Direktori Controllers/Commanders
Tempat menyimpan semua file-file Controller/Commander class aplikasi anda. File Controller/Commander class diharuskan ber-format file PHP, yang berisikan script PHP class Controller. Penamaan class dan filename harus berstandar PSR-4 yaitu dengan format penulisan StudlyCase dan harus disertai dengan namespace.
1
<?php
2
namespace App\Controllers;
3
​
4
use O2System\Framework\Http\Controller;
5
​
6
/**
7
 * Class HelloWorld
8
 *
9
 * HelloWorld controller class example.
10
 *
11
 * @package App\Controllers
12
 */
13
class HelloWorld extends Controller
14
{
15
    /**
16
     * HelloWorld::index
17
     *
18
     * HelloWorld index.
19
     */
20
    public function index()
21
    {
22
        // write your business-logic here.
23
    }
24
}
Copied!
Script diatas harus disimpan dengan filename app/Controllers/HelloWorld.php
Direktori Helpers 
Tempat menyimpan semua file-file Helper aplikasi anda. File Helper diharuskan ber-format file PHP, yang berisikan script fungsi-fungsi yang anda tulis khusus untuk aplikasi anda. Setiap penulisan fungsi disarankan seperti sample dibawah ini dan harus berstandar PSR-1 dan PSR-2. Sedangkan untuk penulisan nama filename harus berstandar PSR-4 yaitu dengan format penulisan StudlyCase.
1
<?php
2
/**
3
 * Your Helper Collection
4
 *
5
 * Example helper collection.
6
 */
7
// ------------------------------------------------------------------------
8
​
9
if ( ! function_exists('my_function')) {
10
    /**
11
     * my_function
12
     *
13
     * Example helper function.
14
     *
15
     * @param array $parameter_1 First parameter of my function.
16
     *
17
     * @return mixed
18
     */
19
    function my_function(array $parameter_1 = [])
20
    {
21
// write your function-logic here.
22
    }
23
}
24
​
25
// ------------------------------------------------------------------------
Copied!
Script diatas harus disimpan dengan nama filename app/Helpers/YourHelper.php
Direktori Languages 
Tempat menyimpan semua file-file Language (bahasa) aplikasi anda. File-file tersebut diharuskan ber-format file INI. Dalam direktori Languages anda dapat mengelompokkan kembali setiap file-file bahasa ke dalam sub-direktori yang diberi nama sesuai dengan standar kode bahasa atau apabila anda merasa tidak perlu mengelompokkannya ke dalam sub-direktori anda dapat menamakan file Language dengan filename yang ditambahkan suffix (akhiran) kode bahasa.
1
;; Example INI Language file en-US
2
HELLO_WORLD = "Hello World"
Copied!
Disimpan didalam sub-direktori berdasarkan bahasa
app/Languages/en-US/nama-file.ini
Disimpan dengan tambahan suffix bahasa
app/Languages/nama-file_en-US.ini
1
;; Example INI Language file id-ID
2
HELLO_WORLD = "Halo Dunia"
Copied!
Disimpan didalam sub-direktori berdasarkan bahasa
app/Languages/id-ID/nama-file.ini
Disimpan dengan tambahan suffix bahasa
app/Languages/nama-file_id-ID.ini
Hal terpenting pertama dalam penulisan file Language adalah language key parameter harus dituliskan dengan format CAPSLOCK dan menggunakan underscore (_) sebagai pemisah kata. Hal terpenting kedua yaitu language key parameter pada setiap bahasa tidak boleh berubah seperti pada contoh diatas.
Tips and Trick
Jika anda menuliskan nama filename sama dengan salah satu controller/commander class maka secara otomatis file language tersebut akan diload oleh O2System Framework ketika controller/commander tersebut diakses.
Direktori Libraries 
Tempat menyimpan semua file-file Library class aplikasi anda. File Library class diharuskan ber-format file PHP yang berisikan script PHP class. Penamaan class dan filename harus berstandar PSR-4 yaitu dengan format penulisan StudlyCase dan harus disertai dengan namespace.
1
<?php
2
namespace App\Libraries;
3
​
4
/**
5
 * Class MyClass
6
 *
7
 * Library class example.
8
 *
9
 * @package App\Libraries
10
 */
11
class MyClass
12
{
13
    /**
14
     * MyClass::__construct
15
     *
16
     * MyClass constructor.
17
     */
18
    public function __construct()
19
    {
20
        // write your logic here
21
    }
22
}
Copied!
Script diatas harus disimpan dengan nama filename app/Libraries/MyClass.php
Direktori Models 
Tempat menyimpan semua file-file Model class aplikasi anda. File Model class diharuskan ber-format file PHP yang berisikan script PHP class. Penamaan class dan filename harus berstandar PSR-4 yaitu dengan format penulisan StudlyCase dan harus disertai dengan namespace.
1
<?php
2
namespace App\Models;
3
​
4
use O2System\Framework\Models\Sql\Model;
5
​
6
/**
7
 * Class HelloWorld
8
 *
9
 * HelloWorld model class example.
10
 *
11
 * @package App\Models
12
 */
13
class HelloWorld extends Model
14
{
15
    /**
16
     * HelloWorld::$table
17
     *
18
     * HelloWorld database table name
19
     *
20
     * @var string
21
     */
22
    public $table = 'hello_world';
23
}
Copied!
Script diatas harus disimpan dengan nama filename app/Models/HelloWorld.php
Tips and Trick
Jika anda menuliskan nama filename sama dengan salah satu controller class maka secara otomatis file Model class tersebut akan diload oleh O2System Framework ketika controller tersebut diakses.
Directory Pages
Tempat menyimpan file-file halaman statis aplikasi anda. File Page harus ber-format file PHTML yang berisikan gabungan HTML, PHP ataupun script yang sesuai dengan parser engine yang digunakan. Penulisan nama filename pada file Page diharuskan berformat StudlyCaps.
Direktori Views
Tempat menyimpan file-file View aplikasi anda. File View harus ber-format file HTML atau PHTML yang berisikan script gabungan HTML, PHP ataupun script yang sesuai dengan parser engine yang digunakan. Penulisan nama filename pada file View sebaiknya ber-format dash.
Direktori Cache
Direktori cache berfungsi sebagai tempat penyimpanan dari semua file cache dari template parser yang dikompilasi, sesi berbasis file, registri berbasis file, cache manipulasi gambar, file logging dan cache lainnya yang dihasilkan oleh aplikasi dan framework. Setiap file cache disimpan dalam folder yang dinamai sesuai dengan namanya.
Direktori Public
Direktori publik berfungsi sebagai root document dari web server anda, di mana semua file yang dapat diakses oleh publik akan ditempatkan di direktori ini seperti file javascript, css, gambar dan asset lainnya. Index.php yang berfungsi sebagai front-controller dari permintaan http aplikasi anda terletak di direktori ini. Asset dan tema yang digunakan oleh aplikasi Anda juga terletak di dalam direktori ini.
Direktori Storage
Direktori storage berfungsi sebagai tempat penyimpanan raw-files atau file-file yang di-upload dari aplikasi anda.
Direktori Vendor
Direktori vendor berisi library-library dari Composer Dependencies yang diperlukan oleh project aplikasi anda, termasuk didalamnya library-library dari O2System Framework.