docs/api/source-admin.controller.localisation.return_action.html
| 1: | <?php | | 2: | namespace Opencart\Admin\Controller\Localisation; | | 3: | /** | | 4: | * Class Return Action | | 5: | * | | 6: | * @package Opencart\Admin\Controller\Localisation | | 7: | */ | | 8: | class ReturnAction extends \Opencart\System\Engine\Controller { | | 9: | /** | | 10: | * Index | | 11: | * | | 12: | * @return void | | 13: | */ | | 14: | public function index(): void { | | 15: | $this->load->language('localisation/return_action'); | | 16: | | | 17: | $this->document->setTitle($this->language->get('heading_title')); | | 18: | | | 19: | $url = ''; | | 20: | | | 21: | if (isset($this->request->get['sort'])) { | | 22: | $url .= '&sort=' . $this->request->get['sort']; | | 23: | } | | 24: | | | 25: | if (isset($this->request->get['order'])) { | | 26: | $url .= '&order=' . $this->request->get['order']; | | 27: | } | | 28: | | | 29: | if (isset($this->request->get['page'])) { | | 30: | $url .= '&page=' . $this->request->get['page']; | | 31: | } | | 32: | | | 33: | $data['breadcrumbs'] = []; | | 34: | | | 35: | $data['breadcrumbs'][] = [ | | 36: | 'text' => $this->language->get('text_home'), | | 37: | 'href' => $this->url->link('common/dashboard', 'user_token=' . $this->session->data['user_token']) | | 38: | ]; | | 39: | | | 40: | $data['breadcrumbs'][] = [ | | 41: | 'text' => $this->language->get('heading_title'), | | 42: | 'href' => $this->url->link('localisation/return_action', 'user_token=' . $this->session->data['user_token'] . $url) | | 43: | ]; | | 44: | | | 45: | $data['add'] = $this->url->link('localisation/return_action.form', 'user_token=' . $this->session->data['user_token'] . $url); | | 46: | $data['delete'] = $this->url->link('localisation/return_action.delete', 'user_token=' . $this->session->data['user_token']); | | 47: | | | 48: | $data['list'] = $this->getList(); | | 49: | | | 50: | $data['user_token'] = $this->session->data['user_token']; | | 51: | | | 52: | $data['header'] = $this->load->controller('common/header'); | | 53: | $data['column_left'] = $this->load->controller('common/column_left'); | | 54: | $data['footer'] = $this->load->controller('common/footer'); | | 55: | | | 56: | $this->response->setOutput($this->load->view('localisation/return_action', $data)); | | 57: | } | | 58: | | | 59: | /** | | 60: | * List | | 61: | * | | 62: | * @return void | | 63: | */ | | 64: | public function list(): void { | | 65: | $this->load->language('localisation/return_action'); | | 66: | | | 67: | $this->response->setOutput($this->getList()); | | 68: | } | | 69: | | | 70: | /** | | 71: | * Get List | | 72: | * | | 73: | * @return string | | 74: | */ | | 75: | protected function getList(): string { | | 76: | if (isset($this->request->get['sort'])) { | | 77: | $sort = (string)$this->request->get['sort']; | | 78: | } else { | | 79: | $sort = 'name'; | | 80: | } | | 81: | | | 82: | if (isset($this->request->get['order'])) { | | 83: | $order = (string)$this->request->get['order']; | | 84: | } else { | | 85: | $order = 'ASC'; | | 86: | } | | 87: | | | 88: | if (isset($this->request->get['page'])) { | | 89: | $page = (int)$this->request->get['page']; | | 90: | } else { | | 91: | $page = 1; | | 92: | } | | 93: | | | 94: | $url = ''; | | 95: | | | 96: | if (isset($this->request->get['sort'])) { | | 97: | $url .= '&sort=' . $this->request->get['sort']; | | 98: | } | | 99: | | | 100: | if (isset($this->request->get['order'])) { | | 101: | $url .= '&order=' . $this->request->get['order']; | | 102: | } | | 103: | | | 104: | if (isset($this->request->get['page'])) { | | 105: | $url .= '&page=' . $this->request->get['page']; | | 106: | } | | 107: | | | 108: | $data['action'] = $this->url->link('localisation/return_action.list', 'user_token=' . $this->session->data['user_token'] . $url); | | 109: | | | 110: | $data['return_actions'] = []; | | 111: | | | 112: | $filter_data = [ | | 113: | 'sort' => $sort, | | 114: | 'order' => $order, | | 115: | 'start' => ($page - 1) * $this->config->get('config_pagination_admin'), | | 116: | 'limit' => $this->config->get('config_pagination_admin') | | 117: | ]; | | 118: | | | 119: | $this->load->model('localisation/return_action'); | | 120: | | | 121: | $results = $this->model_localisation_return_action->getReturnActions($filter_data); | | 122: | | | 123: | foreach ($results as $result) { | | 124: | $data['return_actions'][] = [ | | 125: | 'return_action_id' => $result['return_action_id'], | | 126: | 'name' => $result['name'], | | 127: | 'edit' => $this->url->link('localisation/return_action.form', 'user_token=' . $this->session->data['user_token'] . '&return_action_id=' . $result['return_action_id'] . $url) | | 128: | ]; | | 129: | } | | 130: | | | 131: | $url = ''; | | 132: | | | 133: | if ($order == 'ASC') { | | 134: | $url .= '&order=DESC'; | | 135: | } else { | | 136: | $url .= '&order=ASC'; | | 137: | } | | 138: | | | 139: | $data['sort_name'] = $this->url->link('localisation/return_action.list', 'user_token=' . $this->session->data['user_token'] . '&sort=name' . $url); | | 140: | | | 141: | $url = ''; | | 142: | | | 143: | if (isset($this->request->get['sort'])) { | | 144: | $url .= '&sort=' . $this->request->get['sort']; | | 145: | } | | 146: | | | 147: | if (isset($this->request->get['order'])) { | | 148: | $url .= '&order=' . $this->request->get['order']; | | 149: | } | | 150: | | | 151: | $return_action_total = $this->model_localisation_return_action->getTotalReturnActions(); | | 152: | | | 153: | $data['pagination'] = $this->load->controller('common/pagination', [ | | 154: | 'total' => $return_action_total, | | 155: | 'page' => $page, | | 156: | 'limit' => $this->config->get('config_pagination_admin'), | | 157: | 'url' => $this->url->link('localisation/return_action.list', 'user_token=' . $this->session->data['user_token'] . $url . '&page={page}') | | 158: | ]); | | 159: | | | 160: | $data['results'] = sprintf($this->language->get('text_pagination'), ($return_action_total) ? (($page - 1) * $this->config->get('config_pagination_admin')) + 1 : 0, ((($page - 1) * $this->config->get('config_pagination_admin')) > ($return_action_total - $this->config->get('config_pagination_admin'))) ? $return_action_total : ((($page - 1) * $this->config->get('config_pagination_admin')) + $this->config->get('config_pagination_admin')), $return_action_total, ceil($return_action_total / $this->config->get('config_pagination_admin'))); | | 161: | | | 162: | $data['sort'] = $sort; | | 163: | $data['order'] = $order; | | 164: | | | 165: | return $this->load->view('localisation/return_action_list', $data); | | 166: | } | | 167: | | | 168: | /** | | 169: | * Form | | 170: | * | | 171: | * @return void | | 172: | */ | | 173: | public function form(): void { | | 174: | $this->load->language('localisation/return_action'); | | 175: | | | 176: | $this->document->setTitle($this->language->get('heading_title')); | | 177: | | | 178: | $data['text_form'] = !isset($this->request->get['return_action_id']) ? $this->language->get('text_add') : $this->language->get('text_edit'); | | 179: | | | 180: | $url = ''; | | 181: | | | 182: | if (isset($this->request->get['sort'])) { | | 183: | $url .= '&sort=' . $this->request->get['sort']; | | 184: | } | | 185: | | | 186: | if (isset($this->request->get['order'])) { | | 187: | $url .= '&order=' . $this->request->get['order']; | | 188: | } | | 189: | | | 190: | if (isset($this->request->get['page'])) { | | 191: | $url .= '&page=' . $this->request->get['page']; | | 192: | } | | 193: | | | 194: | $data['breadcrumbs'] = []; | | 195: | | | 196: | $data['breadcrumbs'][] = [ | | 197: | 'text' => $this->language->get('text_home'), | | 198: | 'href' => $this->url->link('common/dashboard', 'user_token=' . $this->session->data['user_token']) | | 199: | ]; | | 200: | | | 201: | $data['breadcrumbs'][] = [ | | 202: | 'text' => $this->language->get('heading_title'), | | 203: | 'href' => $this->url->link('localisation/return_action', 'user_token=' . $this->session->data['user_token'] . $url) | | 204: | ]; | | 205: | | | 206: | $data['save'] = $this->url->link('localisation/return_action.save', 'user_token=' . $this->session->data['user_token']); | | 207: | $data['back'] = $this->url->link('localisation/return_action', 'user_token=' . $this->session->data['user_token'] . $url); | | 208: | | | 209: | if (isset($this->request->get['return_action_id'])) { | | 210: | $data['return_action_id'] = (int)$this->request->get['return_action_id']; | | 211: | } else { | | 212: | $data['return_action_id'] = 0; | | 213: | } | | 214: | | | 215: | $this->load->model('localisation/language'); | | 216: | | | 217: | $data['languages'] = $this->model_localisation_language->getLanguages(); | | 218: | | | 219: | if (isset($this->request->get['return_action_id'])) { | | 220: | $this->load->model('localisation/return_action'); | | 221: | | | 222: | $data['return_action'] = $this->model_localisation_return_action->getDescriptions($this->request->get['return_action_id']); | | 223: | } else { | | 224: | $data['return_action'] = []; | | 225: | } | | 226: | | | 227: | $data['header'] = $this->load->controller('common/header'); | | 228: | $data['column_left'] = $this->load->controller('common/column_left'); | | 229: | $data['footer'] = $this->load->controller('common/footer'); | | 230: | | | 231: | $this->response->setOutput($this->load->view('localisation/return_action_form', $data)); | | 232: | } | | 233: | | | 234: | /** | | 235: | * Save | | 236: | * | | 237: | * @return void | | 238: | */ | | 239: | public function save(): void { | | 240: | $this->load->language('localisation/return_action'); | | 241: | | | 242: | $json = []; | | 243: | | | 244: | if (!$this->user->hasPermission('modify', 'localisation/return_action')) { | | 245: | $json['error']['warning'] = $this->language->get('error_permission'); | | 246: | } | | 247: | | | 248: | foreach ($this->request->post['return_action'] as $language_id => $value) { | | 249: | if ((oc_strlen($value['name']) < 3) || (oc_strlen($value['name']) > 64)) { | | 250: | $json['error']['name_' . $language_id] = $this->language->get('error_name'); | | 251: | } | | 252: | } | | 253: | | | 254: | if (!$json) { | | 255: | $this->load->model('localisation/return_action'); | | 256: | | | 257: | if (!$this->request->post['return_action_id']) { | | 258: | $json['return_action_id'] = $this->model_localisation_return_action->addReturnAction($this->request->post); | | 259: | } else { | | 260: | $this->model_localisation_return_action->editReturnAction($this->request->post['return_action_id'], $this->request->post); | | 261: | } | | 262: | | | 263: | $json['success'] = $this->language->get('text_success'); | | 264: | } | | 265: | | | 266: | $this->response->addHeader('Content-Type: application/json'); | | 267: | $this->response->setOutput(json_encode($json)); | | 268: | } | | 269: | | | 270: | /** | | 271: | * Delete | | 272: | * | | 273: | * @return void | | 274: | */ | | 275: | public function delete(): void { | | 276: | $this->load->language('localisation/return_action'); | | 277: | | | 278: | $json = []; | | 279: | | | 280: | if (isset($this->request->post['selected'])) { | | 281: | $selected = $this->request->post['selected']; | | 282: | } else { | | 283: | $selected = []; | | 284: | } | | 285: | | | 286: | if (!$this->user->hasPermission('modify', 'localisation/return_action')) { | | 287: | $json['error'] = $this->language->get('error_permission'); | | 288: | } | | 289: | | | 290: | $this->load->model('sale/returns'); | | 291: | | | 292: | foreach ($selected as $return_action_id) { | | 293: | $return_total = $this->model_sale_returns->getTotalReturnsByReturnActionId($return_action_id); | | 294: | | | 295: | if ($return_total) { | | 296: | $json['error'] = sprintf($this->language->get('error_return'), $return_total); | | 297: | } | | 298: | } | | 299: | | | 300: | if (!$json) { | | 301: | $this->load->model('localisation/return_action'); | | 302: | | | 303: | foreach ($selected as $return_action_id) { | | 304: | $this->model_localisation_return_action->deleteReturnAction($return_action_id); | | 305: | } | | 306: | | | 307: | $json['success'] = $this->language->get('text_success'); | | 308: | } | | 309: | | | 310: | $this->response->addHeader('Content-Type: application/json'); | | 311: | $this->response->setOutput(json_encode($json)); | | 312: | } | | 313: | } | | 314: | |
OpenCart API API documentation generated by ApiGen dev-master