controller.php
| 1 | <?php |
| 2 | class OsController { |
| 3 | |
| 4 | protected $params, |
| 5 | $files, |
| 6 | $layout = 'admin', |
| 7 | $views_folder = LATEPOINT_VIEWS_ABSPATH_SHARED, |
| 8 | $return_format = 'html', |
| 9 | $extra_css_classes = ['latepoint']; |
| 10 | public array $fields_to_update = []; |
| 11 | |
| 12 | // if an action can only be accessed by a backend user, we need to define capabilities that are required |
| 13 | public array $controller_capabilities = ['settings__edit']; // default for controller |
| 14 | public array $action_capabilities = []; // per action |
| 15 | |
| 16 | public array $action_access = [ 'customer' => [], 'public' => [] ]; |
| 17 | |
| 18 | public $vars; |
| 19 | public $route_name; |
| 20 | |
| 21 | |
| 22 | |
| 23 | function __construct(){ |
| 24 | $this->params = $this->get_params(); |
| 25 | $this->files = $this->get_files(); |
| 26 | $this->set_layout($this->layout); |
| 27 | $this->vars['page_header'] = __('Bookings', 'latepoint'); |
| 28 | $this->vars['breadcrumbs'][] = array('label' => __('Dashboard', 'latepoint'), 'link' => OsRouterHelper::build_link(['dashboard', 'index'] )); |
| 29 | |
| 30 | $this->load_settings(); |
| 31 | $this->vars['logged_in_customer'] = OsAuthHelper::get_logged_in_customer(); |
| 32 | } |
| 33 | |
| 34 | public function check_nonce($action){ |
| 35 | $nonce = $this->params['_wpnonce']; |
| 36 | if(!wp_verify_nonce($nonce, $action)){ |
| 37 | if($this->get_return_format() == 'json'){ |
| 38 | $this->send_json(array('status' => LATEPOINT_STATUS_ERROR, 'message' => __('Invalid Request', 'latepoint'))); |
| 39 | }else{ |
| 40 | wp_die(); |
| 41 | } |
| 42 | } |
| 43 | } |
| 44 | |
| 45 | public function can_current_user_access_action(string $action): bool{ |
| 46 | if(in_array($action, $this->action_access['public'])){ |
| 47 | // public route |
| 48 | $can = true; |
| 49 | }elseif(in_array($action, $this->action_access['customer']) && OsAuthHelper::get_current_user()->customer){ |
| 50 | // customer route & customer is logged in |
| 51 | $can = true; |
| 52 | }else{ |
| 53 | // backend route, check for capabilities |
| 54 | $can = OsAuthHelper::get_current_user()->has_capability($this->get_capabilities_required_for_action($action)); |
| 55 | } |
| 56 | |
| 57 | /** |
| 58 | * Determines if a currently logged in user can access controller's action |
| 59 | * |
| 60 | * @since 4.7.0 |
| 61 | * @hook latepoint_can_current_user_access_action |
| 62 | * |
| 63 | * @param {bool} $can Decision true|false |
| 64 | * @param {string} $action Name of the action that is being called |
| 65 | * @param {LatePoint\Misc\User} $current_user Currently logged in latepoint user |
| 66 | * @returns {bool} Decision true|false |
| 67 | */ |
| 68 | return apply_filters('latepoint_can_current_user_access_action', $can, $action, OsAuthHelper::get_current_user()); |
| 69 | } |
| 70 | |
| 71 | public function get_capabilities_required_for_action($action){ |
| 72 | return OsRolesHelper::get_capabilities_required_for_controller_action(get_class($this), $action); |
| 73 | } |
| 74 | |
| 75 | function generate_css_class($view_name){ |
| 76 | $class_name_filtered = strtolower(preg_replace('/^Os(\w+)Controller/i', '$1', static::class)); |
| 77 | return "latepoint-view-{$class_name_filtered}-{$view_name}"; |
| 78 | } |
| 79 | |
| 80 | protected function load_settings(){ |
| 81 | } |
| 82 | |
| 83 | |
| 84 | public function access_not_allowed(){ |
| 85 | $this->format_render(__FUNCTION__, [], [], true); |
| 86 | exit(); |
| 87 | } |
| 88 | |
| 89 | function format_render($view_name, $extra_vars = array(), $json_return_vars = array(), $from_shared_folder = false){ |
| 90 | echo $this->format_render_return($view_name, $extra_vars, $json_return_vars, $from_shared_folder); |
| 91 | } |
| 92 | |
| 93 | // You can pass array to $view_name, ['json_view_name' => ..., 'html_view_name' => ...] |
| 94 | function format_render_return($view_name, $extra_vars = array(), $json_return_vars = array(), $from_shared_folder = false){ |
| 95 | $html = ''; |
| 96 | if($this->get_return_format() == 'json'){ |
| 97 | if(is_array($view_name)) $view_name = $view_name['json_view_name']; |
| 98 | $response_html = $this->render($this->get_view_uri($view_name, $from_shared_folder), 'none', $extra_vars); |
| 99 | $this->send_json(array_merge(array('status' => LATEPOINT_STATUS_SUCCESS, 'message' => $response_html), $json_return_vars)); |
| 100 | }else{ |
| 101 | if(is_array($view_name)) $view_name = $view_name['html_view_name']; |
| 102 | $this->extra_css_classes[] = $this->generate_css_class($view_name); |
| 103 | $this->vars['extra_css_classes'] = $this->extra_css_classes; |
| 104 | $html = $this->render($this->get_view_uri($view_name, $from_shared_folder), $this->get_layout(), $extra_vars); |
| 105 | } |
| 106 | return $html; |
| 107 | } |
| 108 | |
| 109 | function set_layout($layout = 'admin'){ |
| 110 | if(isset($this->params['layout'])){ |
| 111 | $this->layout = $this->params['layout']; |
| 112 | }else{ |
| 113 | $this->layout = $layout; |
| 114 | } |
| 115 | if($this->layout == 'print'){ |
| 116 | add_action('wp_enqueue_scripts', 'OsUtilHelper::add_auto_print_script'); |
| 117 | } |
| 118 | } |
| 119 | |
| 120 | function get_layout(){ |
| 121 | return $this->layout; |
| 122 | } |
| 123 | |
| 124 | function set_return_format($format = 'html'){ |
| 125 | $this->return_format = $format; |
| 126 | } |
| 127 | |
| 128 | function get_return_format(){ |
| 129 | return $this->return_format; |
| 130 | } |
| 131 | |
| 132 | function send_json($data, $status_code = null){ |
| 133 | if(!empty($this->fields_to_update)) $data['fields_to_update'] = $this->fields_to_update; |
| 134 | wp_send_json($data, $status_code); |
| 135 | } |
| 136 | |
| 137 | function get_view_uri($view_name, $from_shared_folder = false){ |
| 138 | if($from_shared_folder){ |
| 139 | $view_uri = LATEPOINT_VIEWS_ABSPATH_SHARED.$view_name.'.php'; |
| 140 | }else{ |
| 141 | $view_uri = $this->views_folder.$view_name.'.php'; |
| 142 | } |
| 143 | return $view_uri; |
| 144 | } |
| 145 | |
| 146 | // render view and if needed layout, when layout is rendered - view variable is passed to a layout file |
| 147 | function render($view, $layout = 'none', $extra_vars = array()){ |
| 148 | $this->vars['route_name'] = $this->route_name; |
| 149 | extract($extra_vars); |
| 150 | extract($this->vars); |
| 151 | ob_start(); |
| 152 | if($layout != 'none'){ |
| 153 | // rendering layout, view variable will be passed and used in layout file |
| 154 | include LATEPOINT_VIEWS_LAYOUTS_ABSPATH . $this->add_extension($layout, '.php'); |
| 155 | }else{ |
| 156 | include $this->add_extension($view, '.php'); |
| 157 | } |
| 158 | $response_html = ob_get_clean(); |
| 159 | return $response_html; |
| 160 | } |
| 161 | |
| 162 | /* |
| 163 | Adds extension to a file string if its missing |
| 164 | */ |
| 165 | function add_extension($string = '', $extension = '.php'){ |
| 166 | if(substr($string, -strlen($extension))===$extension) return $string; |
| 167 | else return $string.$extension; |
| 168 | } |
| 169 | |
| 170 | function get_files(){ |
| 171 | return OsParamsHelper::get_files(); |
| 172 | } |
| 173 | |
| 174 | function get_params(){ |
| 175 | return OsParamsHelper::get_params(); |
| 176 | } |
| 177 | } |