Skip to content

Latest commit

 

History

History
95 lines (71 loc) · 4.11 KB

CONTRIBUTING.md

File metadata and controls

95 lines (71 loc) · 4.11 KB
Raw

Aturan Umum

Aplikasi ini dikelompokkan dalam module. Setiap module memiliki nama menggunakan CamelCase. Jika beberapa module tergabung dalam satu topik yang sama (misal: Transkrip), gunakan topik tersebut menjadi kata pertama dalam nama module (misal: TranskripRequest dan TranskripManage.

Kelompokkanlah controller, view, model, config, nama tabel, migration script Anda menggunakan nama module atau topik yang Anda buat. Contohnya:

Gunakan nama module untuk mengelompokkan controller dan view. Gunakan nama module atau topik untuk mengelompokkan model, config, nama tabel pada basis data, serta migration script (pilihlah mana yang paling tepat, sesuai kasus Anda). Contohnya:

  • Controller: controllers/TranskripRequest.php, controllers/TranskripManage.php
  • View: views/TranskripRequest/*.php, views/TranskripManage/*.php
  • Model (opsional): models/Transkrip/*_model.php
  • Config file (opsional): config/Transkrip.php
  • Nama tabel (opsional): Transkrip
  • Migration script (opsional): migrations/20160222120000_Transkrip_initial.php

Buatlah model hanya jika fungsi-fungsinya digunakan lebih dari sekali. Jika hanya digunakan sekali, biarkan ada di controller saja.

Library bluetape berisi fungsi-fungsi yang umum digunakan, seperti konversi email ke NPM, semester, dll.

Hak Akses

Hak akses dan nama setiap module diatur pada file config/modules.php. Contoh:

$config['module-names'] = array(
    'TranskripRequest' => 'Permohonan Cetak Transkrip',
    'TranskripManage' => 'Manajemen Cetak Transkrip'
);

$config['modules'] = array(
    'TranskripRequest' => array('root', 'mahasiswa.ftis'),
    'TranskripManage' => array('root', 'tu.ftis')
);

$config['roles'] = array(
    'root' => 'pascal@unpar\\.ac\\.id',
    'tu.ftis' => '(shao\\.wei)@unpar\\.ac\\.id',
    'mahasiswa.ftis' => '7[123]\\d{5}@student\\.unpar\\.ac\\.id'
);

Jika diperlukan, tambahkan role baru pada array config "roles". Setiap elemen array memetakan role dengan alamat email yang tergabung dalam role tersebut, dengan notasi regular expression.

Autentikasi

Setiap module wajib memeriksa hak akses sebelum ditampilkan. Hal tersebut dilakukan dengan cara memanfaatkan template berikut pada controller:

<?php
defined('BASEPATH') OR exit('No direct script access allowed');
class NamaPage extends CI_Controller {

    public function __construct() {
        parent::__construct();
        try {
            $this->Auth_model->checkModuleAllowed(get_class());
        } catch (Exception $ex) {
            $this->session->set_flashdata('error', $ex->getMessage());
            header('Location: /');
        }
    }

    // ... implementasikan method-method Anda yang lain di sini...
}

View

Setiap view menggunakan template yang menampilkan nama module, menu navigasi, serta flash message (bila diperlukan). Untuk itu, setiap view membutuhkan parameter currentModule, selain parameter-parameter lainnya. Untuk sebagian besar kasus, Anda bisa menggunakan fungsi get_class() jika memanggil view dari controller. Berikut adalah cara memanggil view minimal:

$this->load->view('NamaPage/main', array('currentModule' => get_class()));

View Anda memanfaatkan HTML framework Zurb Foundation, dan mengandung template menu utama serta flash message (jika Ada). Oleh karena itu, gunakan kode berikut untuk memulai membuat view Anda:

<?php
defined('BASEPATH') OR exit('No direct script access allowed');
?><!doctype html>
<html class="no-js" lang="en">
    <?php $this->load->view('templates/head_loggedin'); ?>
    <body>
        <?php $this->load->view('templates/topbar_loggedin'); ?>
        <?php $this->load->view('templates/flashmessage'); ?>

        <!-- Tulislah isi view Anda di sini. -->

        <script src="/public/foundation-6/js/vendor/jquery.min.js"></script>
        <script src="/public/foundation-6/js/vendor/what-input.min.js"></script>
        <script src="/public/foundation-6/js/foundation.min.js"></script>
        <script src="/public/foundation-6/js/app.js"></script>
    </body>
</html>