CodeIgniter Application Development Standard
And we use internal standards. They are really useful:
- standards do not necessarily follow ;
- they allow faster and more comfortable to be mastered;
- they help to lose less in the creative process.
Historically, it happened so that we actively use CodeIgniter. The CodeIgniter application development standard is brought to your attention.
1. One controller must be responsible for one function module.
2. Cross-functional modules can be allocated to separate controllers, or attached to existing ones. In both cases, the architectural solution should be the same for the entire product.
3. In each controller method, the functional zones should be taken into account and, if possible, separated:
- access rights;
- receiving and processing data;
- data output.
In this case, both the use of the _remap () method, and the extension of the controller class, and duplication of functional zones in each method are allowed. It is important that actions are explicitly defined and divided.
4. You should not use routing if this can be avoided.
5. You should not do data output from the controller, bypassing the class Output (display), if it is not AMF.
6. It makes sense to use private functions to shorten code with identical functionality.
7. The code of public methods of controllers should be high-level, concise and concise. Obviously, it makes sense to perform all the routine actions in private methods of controllers, models, mappings, helpers, or libraries.
8. It makes sense to use clear and concise method names, which will give beautiful and obvious URLs, which among other things contributes to more comfortable program maintenance.
')
1. Each model performs actions only with its associated entity.
2. If possible, each entity should correspond to one table in the database. If, for servicing, for example, links, additional tables are required, it makes sense to consider the question: whether or not to make the link an additional entity with its model.
3. It makes sense to extend the class of models (example below).
4. It makes sense to use ORM.
5. It makes sense to avoid complex queries in favor of a series of simple queries that allow you to cache data and perform more flexible and faster processing.
6. Use Active Record.
7. You should not store in the database information that does not change when the program is executed.
1. It makes sense to create and use an alias for $ this-> load-> view ($ view, $ data, TRUE ) in a procedural context (example below).
2. Mappings can load other mappings. You should use this feature:
- for organizing a hierarchical output structure
- to separate functional output logic and routines from templates
- to separate design templates. For example, it allows you to quickly and literally switch design
- for formatting structural and functional output (HTML page, JSON, HTML fragment, dynamic data)
3. It is not necessary to generate files and non-dynamic data in mappings.
4. In the mappings, you can change the format of the data. But it is not necessary to change the contents of the data in the mappings - for this there is the OOP-power of controllers, models and libraries, and also procedural helpers.
5. It is not necessary to use JavaScript in mappings, unless there is an obvious need for the opposite.
1. It makes sense to create your own configuration files, since native ones tend to be updated along with the framework.
2. It makes sense to use subdirectories for functional configurations.
3. It is advisable to make in the configuration all the specific data and data that may change during the development of the project, rather than explicitly indicate them in the program code. This allows you to quickly find them, and comfortably modify.
4. For some configuration data that may change during the course of project development, it makes sense to provide a denormalization in the database to ensure the correctness of the history.
1. You should not create a library if the need to create it is not obvious. For example, instead of a library, you can create a controller.
2. Libraries use object context, and this must be considered before its design.
General remarks
1. It is very useful to study, follow and reread at least once a year Style Guide.
2. It makes sense to use the solutions available in the framework before creating your own alternatives.
3. The framework is reliably super lightweight. This is confirmed by many tests and studies. It makes no sense to optimize it.
4. It makes sense to use debugging tools built into the framework (profiler and error logging modes).
5. It makes sense to place the application and system directories, as well as other files that should not be accessible by default to users of the site, above the Virtual Root Document Root.
6. Before designing something fundamentally new, it makes sense to peep in Google, on GitHub and BitBucket, the implementation of similar tasks. With a probability of 99%, any arbitrary task has already been solved. All trivial tasks have several solutions for CodeIgniter.
7. It makes sense to specify in autoload what is reliably often used in the current and in subsequent applications.
8. It is not necessary to specify specific resources in autoload that can be loaded in controller constructors.
9. Comments are good when they are relevant, concise and written in English.
10. TODO must be marked with the TODO keyword.
11. Before using third-party libraries, make sure they are written in PHP5 (and not PHP4)
Extension option application / core / MY_Model.php
With this extension, the models look ascetic, and have a similar API for most actions.
The design () function in application / helpers / MY_html_helper.php, which is often lacking.
Hint if the material is like. Tell what is missing, which can be supplemented.
- standards do not necessarily follow ;
- they allow faster and more comfortable to be mastered;
- they help to lose less in the creative process.
Historically, it happened so that we actively use CodeIgniter. The CodeIgniter application development standard is brought to your attention.
Controllers
1. One controller must be responsible for one function module.
2. Cross-functional modules can be allocated to separate controllers, or attached to existing ones. In both cases, the architectural solution should be the same for the entire product.
3. In each controller method, the functional zones should be taken into account and, if possible, separated:
- access rights;
- receiving and processing data;
- data output.
In this case, both the use of the _remap () method, and the extension of the controller class, and duplication of functional zones in each method are allowed. It is important that actions are explicitly defined and divided.
4. You should not use routing if this can be avoided.
5. You should not do data output from the controller, bypassing the class Output (display), if it is not AMF.
6. It makes sense to use private functions to shorten code with identical functionality.
7. The code of public methods of controllers should be high-level, concise and concise. Obviously, it makes sense to perform all the routine actions in private methods of controllers, models, mappings, helpers, or libraries.
8. It makes sense to use clear and concise method names, which will give beautiful and obvious URLs, which among other things contributes to more comfortable program maintenance.
')
Models
1. Each model performs actions only with its associated entity.
2. If possible, each entity should correspond to one table in the database. If, for servicing, for example, links, additional tables are required, it makes sense to consider the question: whether or not to make the link an additional entity with its model.
3. It makes sense to extend the class of models (example below).
4. It makes sense to use ORM.
5. It makes sense to avoid complex queries in favor of a series of simple queries that allow you to cache data and perform more flexible and faster processing.
6. Use Active Record.
7. You should not store in the database information that does not change when the program is executed.
Mappings
1. It makes sense to create and use an alias for $ this-> load-> view ($ view, $ data, TRUE ) in a procedural context (example below).
2. Mappings can load other mappings. You should use this feature:
- for organizing a hierarchical output structure
- to separate functional output logic and routines from templates
- to separate design templates. For example, it allows you to quickly and literally switch design
- for formatting structural and functional output (HTML page, JSON, HTML fragment, dynamic data)
3. It is not necessary to generate files and non-dynamic data in mappings.
4. In the mappings, you can change the format of the data. But it is not necessary to change the contents of the data in the mappings - for this there is the OOP-power of controllers, models and libraries, and also procedural helpers.
5. It is not necessary to use JavaScript in mappings, unless there is an obvious need for the opposite.
Configuration
1. It makes sense to create your own configuration files, since native ones tend to be updated along with the framework.
2. It makes sense to use subdirectories for functional configurations.
3. It is advisable to make in the configuration all the specific data and data that may change during the development of the project, rather than explicitly indicate them in the program code. This allows you to quickly find them, and comfortably modify.
4. For some configuration data that may change during the course of project development, it makes sense to provide a denormalization in the database to ensure the correctness of the history.
Libraries
1. You should not create a library if the need to create it is not obvious. For example, instead of a library, you can create a controller.
2. Libraries use object context, and this must be considered before its design.
General remarks
1. It is very useful to study, follow and reread at least once a year Style Guide.
2. It makes sense to use the solutions available in the framework before creating your own alternatives.
3. The framework is reliably super lightweight. This is confirmed by many tests and studies. It makes no sense to optimize it.
4. It makes sense to use debugging tools built into the framework (profiler and error logging modes).
5. It makes sense to place the application and system directories, as well as other files that should not be accessible by default to users of the site, above the Virtual Root Document Root.
6. Before designing something fundamentally new, it makes sense to peep in Google, on GitHub and BitBucket, the implementation of similar tasks. With a probability of 99%, any arbitrary task has already been solved. All trivial tasks have several solutions for CodeIgniter.
7. It makes sense to specify in autoload what is reliably often used in the current and in subsequent applications.
8. It is not necessary to specify specific resources in autoload that can be loaded in controller constructors.
9. Comments are good when they are relevant, concise and written in English.
10. TODO must be marked with the TODO keyword.
11. Before using third-party libraries, make sure they are written in PHP5 (and not PHP4)
Extension option application / core / MY_Model.php
<?php class MY_Model extends CI_Model { protected $_table; protected $_primary_key = 'id'; protected $_active_key = 'is_active'; function __construct() { parent::__construct(); $this->_table = strtolower(get_class($this)); } function get_count($factors = FALSE) { if ($factors) { $this->db->where($factors); } return $this->db-> count_all_results($this->_table); } function get_item($id) { $id = intval($id); if ( ! $id) { return FALSE; } return $this->db-> where('id',$id)-> get($this->_table)-> row(); } function get_item_by($factors) // by some parameters { if ( ! $factors) { return FALSE; } return $this->db-> where($factors)-> get($this->_table)-> row(); } /** * Get list of items * * $all_items = $this->get_list(FALSE); * $all_active_items = $this->get_list(); * $all_active_items_by_pages = $this->get_list(TRUE,$from,$limit); * $all_deleted_items = $this->get_list('deleted'); * $some_items = $this->get_list(array( 'is_active' => TRUE, 'counter >=' => 10 ), $from, FALSE, 'created', 'desc' ); */ function get_list($factors = array('is_active' => 1),$from = FALSE, $limit = FALSE,$order = FALSE,$direction = 'asc') { if ( ! is_array($factors)) { if (TRUE === $factors) { $this->db->where($this->_active_key,1); } elseif ('deleted' == $factors) { $this->db->where($this->_active_key,NULL); } elseif ('active' == $factors) { $this->db->where($this->_active_key,1); } } elseif ($factors) { $this->db->where($factors); } if ($order) { $this->db-> order_by($order,$direction); } if ($limit == FALSE) { return $this->db-> get($this->_table)-> result(); } else { return $this->db-> get($this->_table, $limit, $from)-> result(); } } // Get active elements function get_active($from = FALSE, $limit = FALSE,$order = FALSE,$direction = 'asc') { return $this->get_list(TRUE,$from,$limit,$order,$direction); } // Get deleted elements function get_deleted($from = FALSE, $limit = FALSE,$order = FALSE,$direction = 'asc') { return $this->get_list('deleted',$from,$limit,$order,$direction); } // add item from post data function add($fields,$data = FALSE) { foreach ($fields as $field) { $this->db->set($field['field'],$this->input->post($field['field'])); } $this->accordion('add'); return $this->insert($data); } // data insert function insert($data = FALSE) { if ($data) { $this->db->set($data); } $this->db->insert($this->_table); return $this->db->insert_id(); } // edit record function edit($id,$fields,$data = FALSE) { foreach ($fields as $field) { $this->db->set($field['field'],$this->input->post($field['field'])); } $this->accordion('edit'); $this->update($id,$data); } // update record function update($id,$data = FALSE) // found by ID { $id = intval($id); if ( ! $id) { return FALSE; } if ($data) { $this->db-> where($this->_primary_key,$id)-> update($this->_table, $data); } else { $this->db-> where($this->_primary_key,$id)-> update($this->_table); } } // set records parameter function set_property($id, $key, $value) { $this->db-> where($this->_primary_key, $id)-> set($key, $value)-> update($this->_table); } // enable item function enable($item) { $active_key = $this->_active_key; if ($item->$active_key) { return; } $primary_key = $this->_primary_key; $this->set_property($item->$primary_key,$active_key,1); } // delete item function disable($item) { $active_key = $this->_active_key; if ( ! $item->$active_key) { return; } $primary_key = $this->_primary_key; $this->set_property($item->$primary_key,$active_key,NULL); } // related items var $list = array(); function set_related($data,$key = 'uid') { if ( ! $data) { return; } if (is_array($data)) { if (isset($data[$key])) { $this->list[$data[$key]] = FALSE; return; } foreach ($data as $row) { if (is_object($row)) { if (isset($row->$key)) { $this->list[$row->$key] = FALSE; } } elseif (is_array($row)) { if (isset($row[$key])) { $this->list[$row[$key]] = FALSE; } } elseif (is_numeric($row)) { $this->list[$row] = FALSE; } } } elseif (is_object($data)) { if (isset($data->$key)) { $this->list[$data->$key] = FALSE; } } elseif (is_numeric($data)) { $this->list[(int)$data] = FALSE; } } // load list data function load_related($list = FALSE,$key = 'uid') { if ($list) { $this->set_related($list,$key); } if (empty($this->list)) { return; } $keys = array_keys($this->list); $listing = $this->db-> where_in($this->_primary_key,$keys)-> get($this->_table)-> result(); if ( ! $listing) { return; } foreach ($listing as $record) { $this->list[$record->id] = $record; } } // returns related items function related($list = FALSE,$key = 'uid') { $this->load_related($list,$key); return $this->list; } // set or update standart fields function accordion($action = 'add') { if ( ! in_array($action,array('add','edit'))) { // dont knew what to do return; } // get table // found acquaintance fields // make some actions $this->config->load('tables/'.$this->_table,TRUE); $fields = config_item('tables/'.$this->_table); if ($action == 'add') { if (array_key_exists('created',$fields)) { $this->db->set('created',time()); } if (array_key_exists($this->_active_key,$fields)) { $this->db->set($this->_active_key,1); } if (array_key_exists('uid',$fields)) { if ($this->user) { $this->db->set('uid',$this->user->profile['id']); } } } elseif ($action == 'edit') { if (array_key_exists('created',$fields)) { if (array_key_exists('updated',$fields)) { $this->db->set('updated',time()); } } if (array_key_exists('changed',$fields)) { $this->db->set('changed',time()); } } } // counter increment function increment($id,$field) { $this->db-> set($field,$field.' + 1',FALSE)-> where($this->_primary_key,$id)-> update($this->_table); } // counter decrement function decrement($id,$field) { $this->db-> set($field,$field . ' - 1 ',FALSE)-> where($this->_primary_key,$id)-> update($this->_table); } // move item up function move_up($item,$sortorder = 'sortorder') { $active_key = $this->_active_key; $prev = $this->db-> where('`'.$sortorder.'` < '.$item->$sortorder)-> where($active_key,$item->$active_key)-> order_by($sortorder,'DESC')-> get($this->_table)-> row(); if ($prev) { $primary_key = $this->_primary_key; $this->db-> set($sortorder,$prev->$sortorder)-> where($primary_key,$item->$primary_key)-> update($this->_table); $this->db-> set($sortorder,$item->$sortorder)-> where($primary_key,$prev->$primary_key)-> update($this->_table); } } // move item down function move_down($item,$sortorder = 'sortorder') { $active_key = $this->_active_key; $prev = $this->db-> where('`'.$sortorder.'` > '.$item->sortorder)-> where($active_key,$item->is_active)-> order_by($sortorder)-> get($this->_table)-> row(); if ($prev) { $primary_key = $this->_primary_key; $this->db-> set($sortorder,$prev->$sortorder)-> where($primary_key,$item->$primary_key)-> update($this->_table); $this->db-> set($sortorder,$item->$sortorder)-> where($primary_key,$prev->$primary_key)-> update($this->_table); } } } With this extension, the models look ascetic, and have a similar API for most actions.
The design () function in application / helpers / MY_html_helper.php, which is often lacking.
function design($view,$data = FALSE) { $CI =& get_instance(); return $CI->load->view($view,$data,TRUE); } Hint if the material is like. Tell what is missing, which can be supplemented.
Source: https://habr.com/ru/post/167857/
All Articles