Coding Standards Improvement Proposal

Code: Select all

<?php

# This file has changed for 1.4.9.4 based on the optimization proposal here: http://forum.opencart.com/viewtopic.php?f=24&t=19000

class ControllerSettingSetting extends Controller {
	private $error = array();

	public function index() {
		$this->load->language('setting/setting');

		$this->document->title = $this->language->get('heading_title');

...
...
...

			$this->session->data['success'] = $this->language->get('text_success');

			$this->redirect(HTTPS_SERVER . 'index.php?route=setting/setting&token=' . $this->session->data['token']);
		}

		# Load language file
		$this->data = array_merge($this->data, $this->load->language('setting/setting'));

Code: Select all

	public function index() {
		$this->data = $this->load->language('setting/setting');

		$this->document->title = $this->data['heading_title'];
...
...
          $this->session->data['success'] = $this->data['text_success'];

Code: Select all

$this->data = array_merge($this->data, $this->load->language('setting/setting'));

Code: Select all

$this->data = $this->load->language('setting/setting');

Code: Select all

$this->document->title = $this->language->get('heading_title');

Code: Select all

$this->document->title = $this->data['heading_title'];

Code: Select all

	private function validate() {
		if (!$this->user->hasPermission('modify', 'setting/setting')) {
			$this->error['warning'] = $this->language->get('error_permission');
		}

		if (!$this->request->post['config_name']) {
			$this->error['name'] = $this->language->get('error_name');
		}
...
...

Code: Select all

	private function validate() {
		if (!$this->user->hasPermission('modify', 'setting/setting')) {
			$this->error['warning'] = $this->data['error_permission'];
		}

		if (!$this->request->post['config_name']) {
			$this->error['name'] = $this->data['error_name'];
		}

Code: Select all

$this->language->get('error_name')

Code: Select all

$this->data['error_name'];

Code: Select all

/**
 * Builds up a standard OpenCart URL; particularly useful in the Admin pages as it automatically 
 * appends the token from the Session object.  
 *
 * @param String $route The route you wish to direct the link at, ie 'sale/customer'
 * @param Array $query_data an array of key/value pairs which will be appended to
 * the generated link as part of the query string.
 * @return String fully qualified URL for the supplied route and query string, including the admin
 * session token if it is present in the session object.
 * @example
 * <listing>
 *   // http://my.store/index.php?route=sale/customer/edit&token=123&customer_id=22
 *   $this->link('sale/customer/edit', array('customer_id' => 22));
 * </listing>
 */
protected function link($route, $query_data = array()) {
    if (isset($this->session->data['token'])) {
        $query_data ['token'] = $this->session->data['token'];
    }
    $url = HTTPS_SERVER . 'index.php?route=' . $route;
    if (!empty($query_data)) {
        $url .= '&' . http_build_query($query_data);
    }
    return $url;
} 

Code: Select all

/**
 * Reads the supplied property from the GET request object.  If the property is not set in the GET 
 * request object then the supplied default value will be returned instead.
 *
 * @param String $prop The key to read from the GET request object.
 * @param mixed $default_value Default value which will be returned if the supplied $prop key
 * is not set in the GET request object.
 * @return mixed either the value mapped to the supplied $prop key from the GET request object
 * if it has been set, or the supplied $default_value if it was not set.
 * @example
 * <listing>
 *   $this->data['email'] = $this->readGet('email', '');
 * </listing>
 */
protected function readGet($prop, $default_value = NULL) {
    return (isset($this->request->get[$prop])) ? $this->request->get[$prop] : $default_value;
} 

Code: Select all

/**
 * Renders the supplied template as HTML, including the default childen if they have not
 * already been set.
 * @param String $template the name of the template file to render, exlcuding the .tpl 
 * file extension, eg: 'information/contact'.
 * @example
 * <listing>
 *   // In ControllerInformationContact:index
 *   $this->outputTemplate('information/contact');
 * </listing>
 */
protected function outputTemplate($template) {
    // Include either a custom template, goverened by the current theme, or fall back to the default 
    // theme which ships with OpenCart.
    if (file_exists(DIR_TEMPLATE . $this->config->get('config_template') . '/template/' . $template . '.tpl')) {
        $this->template = $this->config->get('config_template') . '/template/' . $template . '.tpl';
    } else {
        $this->template = 'default/template/' . $template . '.tpl';
    }
        
    // Populate default child templates.
    if (empty($this->children)) {
        $this->children = array(
            'common/column_right',
            'common/footer',
            'common/column_left',
            'common/header'
        );
    }    
    $this->response->setOutput($this->render(TRUE), $this->config->get('config_compression'));        
}
 

Code: Select all

if (isset($this->request->post['config_address'])) {
	$this->data['config_address'] = $this->request->post['config_address'];
} else {
	$this->data['config_address'] = $this->config->get('config_address');
}

Code: Select all

$this->data['config_address'] = $this->queryPost('config_address', $this->config->get('config_address'));