Directory access is forbidden.
9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /application/config/ldap.php: -------------------------------------------------------------------------------- 1 | my_controller/index 50 | | my-controller/my-method -> my_controller/my_method 51 | */ 52 | $route['default_controller'] = 'welcome'; 53 | $route['404_override'] = ''; 54 | $route['translate_uri_dashes'] = TRUE; 55 | 56 | /* 57 | | ------------------------------------------------------------------------- 58 | | Sample REST API Routes 59 | | ------------------------------------------------------------------------- 60 | */ 61 | $route['api/example/users/(:num)'] = 'api/example/users/id/$1'; // Example 4 62 | $route['api/example/users/(:num)(\.)([a-zA-Z0-9_-]+)(.*)'] = 'api/example/users/id/$1/format/$3$4'; // Example 8 63 | -------------------------------------------------------------------------------- /application/controllers/Rest_server.php: -------------------------------------------------------------------------------- 1 | load->helper('url'); 10 | 11 | $this->load->view('rest_server'); 12 | } 13 | } 14 | -------------------------------------------------------------------------------- /application/controllers/Welcome.php: -------------------------------------------------------------------------------- 1 | 19 | * @see https://codeigniter.com/user_guide/general/urls.html 20 | */ 21 | public function index() 22 | { 23 | $this->load->helper('url'); 24 | 25 | $this->load->view('welcome_message'); 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /application/controllers/api/Example.php: -------------------------------------------------------------------------------- 1 | methods['users_get']['limit'] = 500; // 500 requests per hour per user/key 32 | $this->methods['users_post']['limit'] = 100; // 100 requests per hour per user/key 33 | $this->methods['users_delete']['limit'] = 50; // 50 requests per hour per user/key 34 | } 35 | 36 | public function users_get() 37 | { 38 | // Users from a data store e.g. database 39 | $users = [ 40 | ['id' => 1, 'name' => 'John', 'email' => 'john@example.com', 'fact' => 'Loves coding'], 41 | ['id' => 2, 'name' => 'Jim', 'email' => 'jim@example.com', 'fact' => 'Developed on CodeIgniter'], 42 | ['id' => 3, 'name' => 'Jane', 'email' => 'jane@example.com', 'fact' => 'Lives in the USA', ['hobbies' => ['guitar', 'cycling']]], 43 | ]; 44 | 45 | $id = $this->get('id'); 46 | 47 | // If the id parameter doesn't exist return all the users 48 | 49 | if ($id === NULL) 50 | { 51 | // Check if the users data store contains users (in case the database result returns NULL) 52 | if ($users) 53 | { 54 | // Set the response and exit 55 | $this->response($users, REST_Controller::HTTP_OK); // OK (200) being the HTTP response code 56 | } 57 | else 58 | { 59 | // Set the response and exit 60 | $this->response([ 61 | 'status' => FALSE, 62 | 'message' => 'No users were found' 63 | ], REST_Controller::HTTP_NOT_FOUND); // NOT_FOUND (404) being the HTTP response code 64 | } 65 | } 66 | 67 | // Find and return a single record for a particular user. 68 | 69 | $id = (int) $id; 70 | 71 | // Validate the id. 72 | if ($id <= 0) 73 | { 74 | // Invalid id, set the response and exit. 75 | $this->response(NULL, REST_Controller::HTTP_BAD_REQUEST); // BAD_REQUEST (400) being the HTTP response code 76 | } 77 | 78 | // Get the user from the array, using the id as key for retrieval. 79 | // Usually a model is to be used for this. 80 | 81 | $user = NULL; 82 | 83 | if (!empty($users)) 84 | { 85 | foreach ($users as $key => $value) 86 | { 87 | if (isset($value['id']) && $value['id'] === $id) 88 | { 89 | $user = $value; 90 | } 91 | } 92 | } 93 | 94 | if (!empty($user)) 95 | { 96 | $this->set_response($user, REST_Controller::HTTP_OK); // OK (200) being the HTTP response code 97 | } 98 | else 99 | { 100 | $this->set_response([ 101 | 'status' => FALSE, 102 | 'message' => 'User could not be found' 103 | ], REST_Controller::HTTP_NOT_FOUND); // NOT_FOUND (404) being the HTTP response code 104 | } 105 | } 106 | 107 | public function users_post() 108 | { 109 | // $this->some_model->update_user( ... ); 110 | $message = [ 111 | 'id' => 100, // Automatically generated by the model 112 | 'name' => $this->post('name'), 113 | 'email' => $this->post('email'), 114 | 'message' => 'Added a resource' 115 | ]; 116 | 117 | $this->set_response($message, REST_Controller::HTTP_CREATED); // CREATED (201) being the HTTP response code 118 | } 119 | 120 | public function users_delete() 121 | { 122 | $id = (int) $this->get('id'); 123 | 124 | // Validate the id. 125 | if ($id <= 0) 126 | { 127 | // Set the response and exit 128 | $this->response(NULL, REST_Controller::HTTP_BAD_REQUEST); // BAD_REQUEST (400) being the HTTP response code 129 | } 130 | 131 | // $this->some_model->delete_something($id); 132 | $message = [ 133 | 'id' => $id, 134 | 'message' => 'Deleted the resource' 135 | ]; 136 | 137 | $this->set_response($message, REST_Controller::HTTP_NO_CONTENT); // NO_CONTENT (204) being the HTTP response code 138 | } 139 | 140 | } 141 | -------------------------------------------------------------------------------- /application/controllers/api/Key.php: -------------------------------------------------------------------------------- 1 | ['level' => 10, 'limit' => 10], 25 | 'index_delete' => ['level' => 10], 26 | 'level_post' => ['level' => 10], 27 | 'regenerate_post' => ['level' => 10], 28 | ]; 29 | 30 | /** 31 | * Insert a key into the database 32 | * 33 | * @access public 34 | * @return void 35 | */ 36 | public function index_put() 37 | { 38 | // Build a new key 39 | $key = $this->_generate_key(); 40 | 41 | // If no key level provided, provide a generic key 42 | $level = $this->put('level') ? $this->put('level') : 1; 43 | $ignore_limits = ctype_digit($this->put('ignore_limits')) ? (int) $this->put('ignore_limits') : 1; 44 | 45 | // Insert the new key 46 | if ($this->_insert_key($key, ['level' => $level, 'ignore_limits' => $ignore_limits])) 47 | { 48 | $this->response([ 49 | 'status' => TRUE, 50 | 'key' => $key 51 | ], REST_Controller::HTTP_CREATED); // CREATED (201) being the HTTP response code 52 | } 53 | else 54 | { 55 | $this->response([ 56 | 'status' => FALSE, 57 | 'message' => 'Could not save the key' 58 | ], REST_Controller::HTTP_INTERNAL_SERVER_ERROR); // INTERNAL_SERVER_ERROR (500) being the HTTP response code 59 | } 60 | } 61 | 62 | /** 63 | * Remove a key from the database to stop it working 64 | * 65 | * @access public 66 | * @return void 67 | */ 68 | public function index_delete() 69 | { 70 | $key = $this->delete('key'); 71 | 72 | // Does this key exist? 73 | if (!$this->_key_exists($key)) 74 | { 75 | // It doesn't appear the key exists 76 | $this->response([ 77 | 'status' => FALSE, 78 | 'message' => 'Invalid API key' 79 | ], REST_Controller::HTTP_BAD_REQUEST); // BAD_REQUEST (400) being the HTTP response code 80 | } 81 | 82 | // Destroy it 83 | $this->_delete_key($key); 84 | 85 | // Respond that the key was destroyed 86 | $this->response([ 87 | 'status' => TRUE, 88 | 'message' => 'API key was deleted' 89 | ], REST_Controller::HTTP_NO_CONTENT); // NO_CONTENT (204) being the HTTP response code 90 | } 91 | 92 | /** 93 | * Change the level 94 | * 95 | * @access public 96 | * @return void 97 | */ 98 | public function level_post() 99 | { 100 | $key = $this->post('key'); 101 | $new_level = $this->post('level'); 102 | 103 | // Does this key exist? 104 | if (!$this->_key_exists($key)) 105 | { 106 | // It doesn't appear the key exists 107 | $this->response([ 108 | 'status' => FALSE, 109 | 'message' => 'Invalid API key' 110 | ], REST_Controller::HTTP_BAD_REQUEST); // BAD_REQUEST (400) being the HTTP response code 111 | } 112 | 113 | // Update the key level 114 | if ($this->_update_key($key, ['level' => $new_level])) 115 | { 116 | $this->response([ 117 | 'status' => TRUE, 118 | 'message' => 'API key was updated' 119 | ], REST_Controller::HTTP_OK); // OK (200) being the HTTP response code 120 | } 121 | else 122 | { 123 | $this->response([ 124 | 'status' => FALSE, 125 | 'message' => 'Could not update the key level' 126 | ], REST_Controller::HTTP_INTERNAL_SERVER_ERROR); // INTERNAL_SERVER_ERROR (500) being the HTTP response code 127 | } 128 | } 129 | 130 | /** 131 | * Suspend a key 132 | * 133 | * @access public 134 | * @return void 135 | */ 136 | public function suspend_post() 137 | { 138 | $key = $this->post('key'); 139 | 140 | // Does this key exist? 141 | if (!$this->_key_exists($key)) 142 | { 143 | // It doesn't appear the key exists 144 | $this->response([ 145 | 'status' => FALSE, 146 | 'message' => 'Invalid API key' 147 | ], REST_Controller::HTTP_BAD_REQUEST); // BAD_REQUEST (400) being the HTTP response code 148 | } 149 | 150 | // Update the key level 151 | if ($this->_update_key($key, ['level' => 0])) 152 | { 153 | $this->response([ 154 | 'status' => TRUE, 155 | 'message' => 'Key was suspended' 156 | ], REST_Controller::HTTP_OK); // OK (200) being the HTTP response code 157 | } 158 | else 159 | { 160 | $this->response([ 161 | 'status' => FALSE, 162 | 'message' => 'Could not suspend the user' 163 | ], REST_Controller::HTTP_INTERNAL_SERVER_ERROR); // INTERNAL_SERVER_ERROR (500) being the HTTP response code 164 | } 165 | } 166 | 167 | /** 168 | * Regenerate a key 169 | * 170 | * @access public 171 | * @return void 172 | */ 173 | public function regenerate_post() 174 | { 175 | $old_key = $this->post('key'); 176 | $key_details = $this->_get_key($old_key); 177 | 178 | // Does this key exist? 179 | if (!$key_details) 180 | { 181 | // It doesn't appear the key exists 182 | $this->response([ 183 | 'status' => FALSE, 184 | 'message' => 'Invalid API key' 185 | ], REST_Controller::HTTP_BAD_REQUEST); // BAD_REQUEST (400) being the HTTP response code 186 | } 187 | 188 | // Build a new key 189 | $new_key = $this->_generate_key(); 190 | 191 | // Insert the new key 192 | if ($this->_insert_key($new_key, ['level' => $key_details->level, 'ignore_limits' => $key_details->ignore_limits])) 193 | { 194 | // Suspend old key 195 | $this->_update_key($old_key, ['level' => 0]); 196 | 197 | $this->response([ 198 | 'status' => TRUE, 199 | 'key' => $new_key 200 | ], REST_Controller::HTTP_CREATED); // CREATED (201) being the HTTP response code 201 | } 202 | else 203 | { 204 | $this->response([ 205 | 'status' => FALSE, 206 | 'message' => 'Could not save the key' 207 | ], REST_Controller::HTTP_INTERNAL_SERVER_ERROR); // INTERNAL_SERVER_ERROR (500) being the HTTP response code 208 | } 209 | } 210 | 211 | /* Helper Methods */ 212 | 213 | private function _generate_key() 214 | { 215 | do 216 | { 217 | // Generate a random salt 218 | $salt = base_convert(bin2hex($this->security->get_random_bytes(64)), 16, 36); 219 | 220 | // If an error occurred, then fall back to the previous method 221 | if ($salt === FALSE) 222 | { 223 | $salt = hash('sha256', time() . mt_rand()); 224 | } 225 | 226 | $new_key = substr($salt, 0, config_item('rest_key_length')); 227 | } 228 | while ($this->_key_exists($new_key)); 229 | 230 | return $new_key; 231 | } 232 | 233 | /* Private Data Methods */ 234 | 235 | private function _get_key($key) 236 | { 237 | return $this->rest->db 238 | ->where(config_item('rest_key_column'), $key) 239 | ->get(config_item('rest_keys_table')) 240 | ->row(); 241 | } 242 | 243 | private function _key_exists($key) 244 | { 245 | return $this->rest->db 246 | ->where(config_item('rest_key_column'), $key) 247 | ->count_all_results(config_item('rest_keys_table')) > 0; 248 | } 249 | 250 | private function _insert_key($key, $data) 251 | { 252 | $data[config_item('rest_key_column')] = $key; 253 | $data['date_created'] = function_exists('now') ? now() : time(); 254 | 255 | return $this->rest->db 256 | ->set($data) 257 | ->insert(config_item('rest_keys_table')); 258 | } 259 | 260 | private function _update_key($key, $data) 261 | { 262 | return $this->rest->db 263 | ->where(config_item('rest_key_column'), $key) 264 | ->update(config_item('rest_keys_table'), $data); 265 | } 266 | 267 | private function _delete_key($key) 268 | { 269 | return $this->rest->db 270 | ->where(config_item('rest_key_column'), $key) 271 | ->delete(config_item('rest_keys_table')); 272 | } 273 | 274 | } 275 | -------------------------------------------------------------------------------- /application/controllers/api/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Directory access is forbidden.
9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /application/controllers/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Directory access is forbidden.
9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /application/helpers/db_helper.php: -------------------------------------------------------------------------------- 1 | 4 | */ 5 | defined('BASEPATH') OR exit('No direct script access allowed'); 6 | 7 | if ( ! function_exists('add_foreign_key')) 8 | { 9 | /** 10 | * @param string $table Table name 11 | * @param string $foreign_key Collumn name having the Foreign Key 12 | * @param string $references Table and column reference. Ex: users(id) 13 | * @param string $on_delete RESTRICT, NO ACTION, CASCADE, SET NULL, SET DEFAULT 14 | * @param string $on_update RESTRICT, NO ACTION, CASCADE, SET NULL, SET DEFAULT 15 | * 16 | * @return string SQL command 17 | */ 18 | function add_foreign_key($table, $foreign_key, $references, $on_delete = 'RESTRICT', $on_update = 'RESTRICT') 19 | { 20 | $references = explode('(', str_replace(')', '', str_replace('`', '', $references))); 21 | 22 | return "ALTER TABLE `{$table}` ADD CONSTRAINT `{$table}_{$foreign_key}_fk` FOREIGN KEY (`{$foreign_key}`) REFERENCES `{$references[0]}`(`{$references[1]}`) ON DELETE {$on_delete} ON UPDATE {$on_update}"; 23 | } 24 | } 25 | 26 | if ( ! function_exists('drop_foreign_key')) 27 | { 28 | /** 29 | * @param string $table Table name 30 | * @param string $foreign_key Collumn name having the Foreign Key 31 | * 32 | * @return string SQL command 33 | */ 34 | function drop_foreign_key($table, $foreign_key) 35 | { 36 | return "ALTER TABLE `{$table}` DROP FOREIGN KEY `{$table}_{$foreign_key}_fk`"; 37 | } 38 | } 39 | 40 | if ( ! function_exists('add_trigger')) 41 | { 42 | /** 43 | * @param string $trigger_name Trigger name 44 | * @param string $table Table name 45 | * @param string $statement Command to run 46 | * @param string $time BEFORE or AFTER 47 | * @param string $event INSERT, UPDATE or DELETE 48 | * @param string $type FOR EACH ROW [FOLLOWS|PRECEDES] 49 | * 50 | * @return string SQL Command 51 | */ 52 | function add_trigger($trigger_name, $table, $statement, $time = 'BEFORE', $event = 'INSERT', $type = 'FOR EACH ROW') 53 | { 54 | return 'DELIMITER ;;' . PHP_EOL . "CREATE TRIGGER `{$trigger_name}` {$time} {$event} ON `{$table}` {$type}" . PHP_EOL . 'BEGIN' . PHP_EOL . $statement . PHP_EOL . 'END;' . PHP_EOL . 'DELIMITER ;;'; 55 | } 56 | } 57 | 58 | if ( ! function_exists('drop_trigger')) 59 | { 60 | /** 61 | * @param string $trigger_name Trigger name 62 | * 63 | * @return string SQL Command 64 | */ 65 | function drop_trigger($trigger_name) 66 | { 67 | return "DROP TRIGGER {$trigger_name};"; 68 | } 69 | } 70 | -------------------------------------------------------------------------------- /application/helpers/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Directory access is forbidden.
9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /application/hooks/hooks.profiler.php: -------------------------------------------------------------------------------- 1 | output->enable_profiler( config_item('enable_profiling') ); 16 | } 17 | } 18 | ?> 19 | -------------------------------------------------------------------------------- /application/language/bulgarian/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Directory access is forbidden.
9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /application/language/bulgarian/rest_controller_lang.php: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Directory access is forbidden.
9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /application/language/dutch/rest_controller_lang.php: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Directory access is forbidden.
9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /application/language/english/rest_controller_lang.php: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Directory access is forbidden.
9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /application/language/french/rest_controller_lang.php: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Directory access is forbidden.
9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /application/language/german/rest_controller_lang.php: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Directory access is forbidden.
9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /application/language/indonesia/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Directory access is forbidden.
9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /application/language/indonesia/rest_controller_lang.php: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Directory access is forbidden.
9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /application/language/italian/rest_controller_lang.php: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Directory access is forbidden.
9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /application/language/korean/rest_controller_lang.php: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Directory access is forbidden.
9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /application/language/portuguese-brazilian/rest_controller_lang.php: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Directory access is forbidden.
9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /application/language/romanian/rest_controller_lang.php: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Directory access is forbidden.
9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /application/language/serbian_cyr/rest_controller_lang.php: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Directory access is forbidden.
9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /application/language/serbian_lat/rest_controller_lang.php: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Directory access is forbidden.
9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /application/language/simplified-chinese/rest_controller_lang.php: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Directory access is forbidden.
9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /application/language/spanish/rest_controller_lang.php: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Directory access is forbidden.
9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /application/language/traditional-chinese/rest_controller_lang.php: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Directory access is forbidden.
9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /application/language/turkish/rest_controller_lang.php: -------------------------------------------------------------------------------- 1 | _CI = &get_instance(); 89 | 90 | // Load the inflector helper 91 | $this->_CI->load->helper('inflector'); 92 | 93 | // If the provided data is already formatted we should probably convert it to an array 94 | if ($from_type !== NULL) 95 | { 96 | if (method_exists($this, '_from_'.$from_type)) 97 | { 98 | $data = call_user_func([$this, '_from_'.$from_type], $data); 99 | } 100 | else 101 | { 102 | throw new Exception('Format class does not support conversion from "'.$from_type.'".'); 103 | } 104 | } 105 | 106 | // Set the member variable to the data passed 107 | $this->_data = $data; 108 | } 109 | 110 | /** 111 | * Create an instance of the format class 112 | * e.g: echo $this->format->factory(['foo' => 'bar'])->to_csv(); 113 | * 114 | * @param mixed $data Data to convert/parse 115 | * @param string $from_type Type to convert from e.g. json, csv, html 116 | * 117 | * @return object Instance of the format class 118 | */ 119 | public static function factory($data, $from_type = NULL) 120 | { 121 | // $class = __CLASS__; 122 | // return new $class(); 123 | 124 | return new static($data, $from_type); 125 | } 126 | 127 | // FORMATTING OUTPUT --------------------------------------------------------- 128 | 129 | /** 130 | * Format data as an array 131 | * 132 | * @param mixed|NULL $data Optional data to pass, so as to override the data passed 133 | * to the constructor 134 | * @return array Data parsed as an array; otherwise, an empty array 135 | */ 136 | public function to_array($data = NULL) 137 | { 138 | // If no data is passed as a parameter, then use the data passed 139 | // via the constructor 140 | if ($data === NULL && func_num_args() === 0) 141 | { 142 | $data = $this->_data; 143 | } 144 | 145 | // Cast as an array if not already 146 | if (is_array($data) === FALSE) 147 | { 148 | $data = (array) $data; 149 | } 150 | 151 | $array = []; 152 | foreach ((array) $data as $key => $value) 153 | { 154 | if (is_object($value) === TRUE || is_array($value) === TRUE) 155 | { 156 | $array[$key] = $this->to_array($value); 157 | } 158 | else 159 | { 160 | $array[$key] = $value; 161 | } 162 | } 163 | 164 | return $array; 165 | } 166 | 167 | /** 168 | * Format data as XML 169 | * 170 | * @param mixed|NULL $data Optional data to pass, so as to override the data passed 171 | * to the constructor 172 | * @param NULL $structure 173 | * @param string $basenode 174 | * @return mixed 175 | */ 176 | public function to_xml($data = NULL, $structure = NULL, $basenode = 'xml') 177 | { 178 | if ($data === NULL && func_num_args() === 0) 179 | { 180 | $data = $this->_data; 181 | } 182 | 183 | if ($structure === NULL) 184 | { 185 | $structure = simplexml_load_string("<$basenode />"); 186 | } 187 | 188 | // Force it to be something useful 189 | if (is_array($data) === FALSE && is_object($data) === FALSE) 190 | { 191 | $data = (array) $data; 192 | } 193 | 194 | foreach ($data as $key => $value) 195 | { 196 | 197 | //change false/true to 0/1 198 | if (is_bool($value)) 199 | { 200 | $value = (int) $value; 201 | } 202 | 203 | // no numeric keys in our xml please! 204 | if (is_numeric($key)) 205 | { 206 | // make string key... 207 | $key = (singular($basenode) != $basenode) ? singular($basenode) : 'item'; 208 | } 209 | 210 | // replace anything not alpha numeric 211 | $key = preg_replace('/[^a-z_\-0-9]/i', '', $key); 212 | 213 | if ($key === '_attributes' && (is_array($value) || is_object($value))) 214 | { 215 | $attributes = $value; 216 | if (is_object($attributes)) 217 | { 218 | $attributes = get_object_vars($attributes); 219 | } 220 | 221 | foreach ($attributes as $attribute_name => $attribute_value) 222 | { 223 | $structure->addAttribute($attribute_name, $attribute_value); 224 | } 225 | } 226 | // if there is another array found recursively call this function 227 | elseif (is_array($value) || is_object($value)) 228 | { 229 | $node = $structure->addChild($key); 230 | 231 | // recursive call. 232 | $this->to_xml($value, $node, $key); 233 | } 234 | else 235 | { 236 | // add single node. 237 | $value = htmlspecialchars(html_entity_decode($value, ENT_QUOTES, 'UTF-8'), ENT_QUOTES, 'UTF-8'); 238 | 239 | $structure->addChild($key, $value); 240 | } 241 | } 242 | 243 | return $structure->asXML(); 244 | } 245 | 246 | /** 247 | * Format data as HTML 248 | * 249 | * @param mixed|NULL $data Optional data to pass, so as to override the data passed 250 | * to the constructor 251 | * @return mixed 252 | */ 253 | public function to_html($data = NULL) 254 | { 255 | // If no data is passed as a parameter, then use the data passed 256 | // via the constructor 257 | if ($data === NULL && func_num_args() === 0) 258 | { 259 | $data = $this->_data; 260 | } 261 | 262 | // Cast as an array if not already 263 | if (is_array($data) === FALSE) 264 | { 265 | $data = (array) $data; 266 | } 267 | 268 | // Check if it's a multi-dimensional array 269 | if (isset($data[0]) && count($data) !== count($data, COUNT_RECURSIVE)) 270 | { 271 | // Multi-dimensional array 272 | $headings = array_keys($data[0]); 273 | } 274 | else 275 | { 276 | // Single array 277 | $headings = array_keys($data); 278 | $data = [$data]; 279 | } 280 | 281 | // Load the table library 282 | $this->_CI->load->library('table'); 283 | 284 | $this->_CI->table->set_heading($headings); 285 | 286 | foreach ($data as $row) 287 | { 288 | // Suppressing the "array to string conversion" notice 289 | // Keep the "evil" @ here 290 | $row = @array_map('strval', $row); 291 | 292 | $this->_CI->table->add_row($row); 293 | } 294 | 295 | return $this->_CI->table->generate(); 296 | } 297 | 298 | /** 299 | * @link http://www.metashock.de/2014/02/create-csv-file-in-memory-php/ 300 | * @param mixed|NULL $data Optional data to pass, so as to override the data passed 301 | * to the constructor 302 | * @param string $delimiter The optional delimiter parameter sets the field 303 | * delimiter (one character only). NULL will use the default value (,) 304 | * @param string $enclosure The optional enclosure parameter sets the field 305 | * enclosure (one character only). NULL will use the default value (") 306 | * @return string A csv string 307 | */ 308 | public function to_csv($data = NULL, $delimiter = ',', $enclosure = '"') 309 | { 310 | // Use a threshold of 1 MB (1024 * 1024) 311 | $handle = fopen('php://temp/maxmemory:1048576', 'w'); 312 | if ($handle === FALSE) 313 | { 314 | return NULL; 315 | } 316 | 317 | // If no data is passed as a parameter, then use the data passed 318 | // via the constructor 319 | if ($data === NULL && func_num_args() === 0) 320 | { 321 | $data = $this->_data; 322 | } 323 | 324 | // If NULL, then set as the default delimiter 325 | if ($delimiter === NULL) 326 | { 327 | $delimiter = ','; 328 | } 329 | 330 | // If NULL, then set as the default enclosure 331 | if ($enclosure === NULL) 332 | { 333 | $enclosure = '"'; 334 | } 335 | 336 | // Cast as an array if not already 337 | if (is_array($data) === FALSE) 338 | { 339 | $data = (array) $data; 340 | } 341 | 342 | // Check if it's a multi-dimensional array 343 | if (isset($data[0]) && count($data) !== count($data, COUNT_RECURSIVE)) 344 | { 345 | // Multi-dimensional array 346 | $headings = array_keys($data[0]); 347 | } 348 | else 349 | { 350 | // Single array 351 | $headings = array_keys($data); 352 | $data = [$data]; 353 | } 354 | 355 | // Apply the headings 356 | fputcsv($handle, $headings, $delimiter, $enclosure); 357 | 358 | foreach ($data as $record) 359 | { 360 | // If the record is not an array, then break. This is because the 2nd param of 361 | // fputcsv() should be an array 362 | if (is_array($record) === FALSE) 363 | { 364 | break; 365 | } 366 | 367 | // Suppressing the "array to string conversion" notice. 368 | // Keep the "evil" @ here. 369 | $record = @ array_map('strval', $record); 370 | 371 | // Returns the length of the string written or FALSE 372 | fputcsv($handle, $record, $delimiter, $enclosure); 373 | } 374 | 375 | // Reset the file pointer 376 | rewind($handle); 377 | 378 | // Retrieve the csv contents 379 | $csv = stream_get_contents($handle); 380 | 381 | // Close the handle 382 | fclose($handle); 383 | 384 | // Convert UTF-8 encoding to UTF-16LE which is supported by MS Excel 385 | $csv = mb_convert_encoding($csv, 'UTF-16LE', 'UTF-8'); 386 | 387 | return $csv; 388 | } 389 | 390 | /** 391 | * Encode data as json 392 | * 393 | * @param mixed|NULL $data Optional data to pass, so as to override the data passed 394 | * to the constructor 395 | * @return string Json representation of a value 396 | */ 397 | public function to_json($data = NULL) 398 | { 399 | // If no data is passed as a parameter, then use the data passed 400 | // via the constructor 401 | if ($data === NULL && func_num_args() === 0) 402 | { 403 | $data = $this->_data; 404 | } 405 | 406 | // Get the callback parameter (if set) 407 | $callback = $this->_CI->input->get('callback'); 408 | 409 | if (empty($callback) === TRUE) 410 | { 411 | return json_encode($data, JSON_UNESCAPED_UNICODE); 412 | } 413 | 414 | // We only honour a jsonp callback which are valid javascript identifiers 415 | elseif (preg_match('/^[a-z_\$][a-z0-9\$_]*(\.[a-z_\$][a-z0-9\$_]*)*$/i', $callback)) 416 | { 417 | // Return the data as encoded json with a callback 418 | return $callback.'('.json_encode($data, JSON_UNESCAPED_UNICODE).');'; 419 | } 420 | 421 | // An invalid jsonp callback function provided. 422 | // Though I don't believe this should be hardcoded here 423 | $data['warning'] = 'INVALID JSONP CALLBACK: '.$callback; 424 | 425 | return json_encode($data, JSON_UNESCAPED_UNICODE); 426 | } 427 | 428 | /** 429 | * Encode data as a serialized array 430 | * 431 | * @param mixed|NULL $data Optional data to pass, so as to override the data passed 432 | * to the constructor 433 | * @return string Serialized data 434 | */ 435 | public function to_serialized($data = NULL) 436 | { 437 | // If no data is passed as a parameter, then use the data passed 438 | // via the constructor 439 | if ($data === NULL && func_num_args() === 0) 440 | { 441 | $data = $this->_data; 442 | } 443 | 444 | return serialize($data); 445 | } 446 | 447 | /** 448 | * Format data using a PHP structure 449 | * 450 | * @param mixed|NULL $data Optional data to pass, so as to override the data passed 451 | * to the constructor 452 | * @return mixed String representation of a variable 453 | */ 454 | public function to_php($data = NULL) 455 | { 456 | // If no data is passed as a parameter, then use the data passed 457 | // via the constructor 458 | if ($data === NULL && func_num_args() === 0) 459 | { 460 | $data = $this->_data; 461 | } 462 | 463 | return var_export($data, TRUE); 464 | } 465 | 466 | // INTERNAL FUNCTIONS 467 | 468 | /** 469 | * @param string $data XML string 470 | * @return array XML element object; otherwise, empty array 471 | */ 472 | protected function _from_xml($data) 473 | { 474 | return $data ? (array) simplexml_load_string($data, 'SimpleXMLElement', LIBXML_NOCDATA) : []; 475 | } 476 | 477 | /** 478 | * @param string $data CSV string 479 | * @param string $delimiter The optional delimiter parameter sets the field 480 | * delimiter (one character only). NULL will use the default value (,) 481 | * @param string $enclosure The optional enclosure parameter sets the field 482 | * enclosure (one character only). NULL will use the default value (") 483 | * @return array A multi-dimensional array with the outer array being the number of rows 484 | * and the inner arrays the individual fields 485 | */ 486 | protected function _from_csv($data, $delimiter = ',', $enclosure = '"') 487 | { 488 | // If NULL, then set as the default delimiter 489 | if ($delimiter === NULL) 490 | { 491 | $delimiter = ','; 492 | } 493 | 494 | // If NULL, then set as the default enclosure 495 | if ($enclosure === NULL) 496 | { 497 | $enclosure = '"'; 498 | } 499 | 500 | return str_getcsv($data, $delimiter, $enclosure); 501 | } 502 | 503 | /** 504 | * @param string $data Encoded json string 505 | * @return mixed Decoded json string with leading and trailing whitespace removed 506 | */ 507 | protected function _from_json($data) 508 | { 509 | return json_decode(trim($data)); 510 | } 511 | 512 | /** 513 | * @param string $data Data to unserialize 514 | * @return mixed Unserialized data 515 | */ 516 | protected function _from_serialize($data) 517 | { 518 | return unserialize(trim($data)); 519 | } 520 | 521 | /** 522 | * @param string $data Data to trim leading and trailing whitespace 523 | * @return string Data with leading and trailing whitespace removed 524 | */ 525 | protected function _from_php($data) 526 | { 527 | return trim($data); 528 | } 529 | } 530 | -------------------------------------------------------------------------------- /application/libraries/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Directory access is forbidden.
9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /application/migrations/20170706025420_create_table_users.php: -------------------------------------------------------------------------------- 1 | 4 | */ 5 | defined('BASEPATH') OR exit('No direct script access allowed'); 6 | 7 | /** 8 | * Class Migration_create_table_users 9 | * 10 | * @property CI_DB_forge $dbforge 11 | * @property CI_DB_query_builder $db 12 | */ 13 | class Migration_create_table_users extends CI_Migration { 14 | 15 | 16 | protected $table = 'users'; 17 | 18 | 19 | public function up() 20 | { 21 | $fields = array( 22 | 'id' => [ 23 | 'type' => 'INT(11)', 24 | 'auto_increment' => TRUE, 25 | 'unsigned' => TRUE, 26 | ], 27 | 'email' => [ 28 | 'type' => 'VARCHAR(255)', 29 | 'unique' => TRUE, 30 | ], 31 | 'password' => [ 32 | 'type' => 'VARCHAR(64)', 33 | ], 34 | 'firstname' => [ 35 | 'type' => 'VARCHAR(32)', 36 | ], 37 | 'lastname' => [ 38 | 'type' => 'VARCHAR(32)', 39 | ], 40 | 'created_at' => [ 41 | 'type' => 'DATETIME', 42 | ], 43 | ); 44 | $this->dbforge->add_field($fields); 45 | $this->dbforge->add_key('id', TRUE); 46 | $this->dbforge->create_table($this->table, TRUE); 47 | 48 | /*for ($i = 1; $i <= 100; $i++) 49 | { 50 | $this->db->insert($this->table, [ 51 | 'email' => "user-{$i}@mail.com", 52 | 'password' => password_hash('codeigniter', PASSWORD_DEFAULT), 53 | 'firstname' => "Firstname {$i}", 54 | 'lastname' => "Lastname {$i}", 55 | 'created_at' => date('Y-' . rand(1, 12) . '-' . rand(1, 28) . ' H:i:s'), 56 | ]); 57 | }*/ 58 | } 59 | 60 | 61 | public function down() 62 | { 63 | if ($this->db->table_exists($this->table)) 64 | { 65 | $this->dbforge->drop_table($this->table); 66 | } 67 | } 68 | 69 | } 70 | -------------------------------------------------------------------------------- /application/migrations/20170706030520_create_table_api_keys.php: -------------------------------------------------------------------------------- 1 | 4 | */ 5 | defined('BASEPATH') OR exit('No direct script access allowed'); 6 | 7 | /** 8 | * Class Migration_create_table_api_keys 9 | * 10 | * @property CI_DB_forge $dbforge 11 | * @property CI_DB_query_builder $db 12 | */ 13 | class Migration_create_table_api_keys extends CI_Migration { 14 | 15 | 16 | public function up() 17 | { 18 | $this->config->load('rest'); 19 | $table = config_item('rest_keys_table'); 20 | $fields = array( 21 | 'id' => [ 22 | 'type' => 'INT(11)', 23 | 'auto_increment' => TRUE, 24 | 'unsigned' => TRUE, 25 | ], 26 | 'user_id' => [ 27 | 'type' => 'INT(11)', 28 | 'unsigned' => TRUE, 29 | ], 30 | config_item('rest_key_column') => [ 31 | 'type' => 'VARCHAR(' . config_item('rest_key_length') . ')', 32 | 'unique' => TRUE, 33 | ], 34 | 'level' => [ 35 | 'type' => 'INT(2)', 36 | ], 37 | 'ignore_limits' => [ 38 | 'type' => 'TINYINT(1)', 39 | 'default' => 0, 40 | ], 41 | 'is_private_key' => [ 42 | 'type' => 'TINYINT(1)', 43 | 'default' => 0, 44 | ], 45 | 'ip_addresses' => [ 46 | 'type' => 'TEXT', 47 | 'null' => TRUE, 48 | ], 49 | 'date_created' => [ 50 | 'type' => 'INT(11)', 51 | ], 52 | ); 53 | $this->dbforge->add_field($fields); 54 | $this->dbforge->add_key('id', TRUE); 55 | $this->dbforge->create_table($table); 56 | $this->db->query(add_foreign_key($table, 'user_id', 'users(id)', 'CASCADE', 'CASCADE')); 57 | } 58 | 59 | 60 | public function down() 61 | { 62 | $table = config_item('rest_key_column'); 63 | if ($this->db->table_exists($table)) 64 | { 65 | $this->db->query(drop_foreign_key($table, 'user_id')); 66 | $this->dbforge->drop_table($table); 67 | } 68 | } 69 | 70 | } 71 | -------------------------------------------------------------------------------- /application/migrations/20170706031435_create_table_api_logs.php: -------------------------------------------------------------------------------- 1 | 4 | */ 5 | defined('BASEPATH') OR exit('No direct script access allowed'); 6 | 7 | /** 8 | * Class Migration_create_table_api_logs 9 | * 10 | * @property CI_DB_forge $dbforge 11 | * @property CI_DB_query_builder $db 12 | */ 13 | class Migration_create_table_api_logs extends CI_Migration { 14 | 15 | 16 | public function up() 17 | { 18 | $this->config->load('rest'); 19 | $table = config_item('rest_logs_table'); 20 | $fields = array( 21 | 'id' => [ 22 | 'type' => 'INT(11)', 23 | 'auto_increment' => TRUE, 24 | 'unsigned' => TRUE, 25 | ], 26 | 'api_key' => [ 27 | 'type' => 'VARCHAR(' . config_item('rest_key_length') . ')', 28 | ], 29 | 'uri' => [ 30 | 'type' => 'VARCHAR(255)', 31 | ], 32 | 'method' => [ 33 | 'type' => 'ENUM("get","post","options","put","patch","delete")', 34 | ], 35 | 'params' => [ 36 | 'type' => 'TEXT', 37 | 'null' => TRUE, 38 | ], 39 | 'ip_address' => [ 40 | 'type' => 'VARCHAR(45)', 41 | ], 42 | 'time' => [ 43 | 'type' => 'INT(11)', 44 | ], 45 | 'rtime' => [ 46 | 'type' => 'FLOAT', 47 | 'null' => TRUE, 48 | ], 49 | 'authorized' => [ 50 | 'type' => 'VARCHAR(1)', 51 | ], 52 | 'response_code' => [ 53 | 'type' => 'SMALLINT(3)', 54 | 'null' => TRUE, 55 | 'default' => 0, 56 | ], 57 | ); 58 | $this->dbforge->add_field($fields); 59 | $this->dbforge->add_key('id', TRUE); 60 | $this->dbforge->create_table($table); 61 | /*$this->db->query(add_foreign_key($table, 'api_key', 62 | config_item('rest_keys_table') . '(' . config_item('rest_key_column') . ')', 'CASCADE', 'CASCADE'));*/ 63 | } 64 | 65 | 66 | public function down() 67 | { 68 | $table = config_item('rest_logs_table'); 69 | if ($this->db->table_exists($table)) 70 | { 71 | // $this->db->query(drop_foreign_key($table, 'api_key')); 72 | $this->dbforge->drop_table($table); 73 | } 74 | } 75 | 76 | } 77 | -------------------------------------------------------------------------------- /application/migrations/20170706032133_create_table_api_access.php: -------------------------------------------------------------------------------- 1 | 4 | */ 5 | defined('BASEPATH') OR exit('No direct script access allowed'); 6 | 7 | /** 8 | * Class Migration_create_table_api_access 9 | * 10 | * @property CI_DB_forge $dbforge 11 | * @property CI_DB_query_builder $db 12 | */ 13 | class Migration_create_table_api_access extends CI_Migration { 14 | 15 | 16 | public function up() 17 | { 18 | $this->config->load('rest'); 19 | $table = config_item('rest_access_table'); 20 | $fields = array( 21 | 'id' => [ 22 | 'type' => 'INT(11)', 23 | 'auto_increment' => TRUE, 24 | 'unsigned' => TRUE, 25 | ], 26 | 'key' => [ 27 | 'type' => 'VARCHAR(' . config_item('rest_key_length') . ')', 28 | ], 29 | 'all_access' => [ 30 | 'type' => 'TINYINT(1)', 31 | 'default' => 0, 32 | ], 33 | 'controller' => [ 34 | 'type' => 'VARCHAR(50)', 35 | ], 36 | 'date_created' => [ 37 | 'type' => 'DATETIME', 38 | 'null' => TRUE, 39 | ], 40 | 'date_modified' => [ 41 | 'type' => 'TIMESTAMP', 42 | ], 43 | ); 44 | $this->dbforge->add_field($fields); 45 | $this->dbforge->add_key('id', TRUE); 46 | $this->dbforge->add_key('controller'); 47 | $this->dbforge->create_table($table); 48 | $this->db->query(add_foreign_key($table, 'key', 49 | config_item('rest_keys_table') . '(' . config_item('rest_key_column') . ')', 'CASCADE', 'CASCADE')); 50 | } 51 | 52 | 53 | public function down() 54 | { 55 | $table = config_item('rest_access_table'); 56 | if ($this->db->table_exists($table)) 57 | { 58 | $this->db->query(drop_foreign_key($table, 'key')); 59 | $this->dbforge->drop_table($table); 60 | } 61 | } 62 | 63 | } 64 | -------------------------------------------------------------------------------- /application/migrations/20170706032825_create_table_api_limits.php: -------------------------------------------------------------------------------- 1 | 4 | */ 5 | defined('BASEPATH') OR exit('No direct script access allowed'); 6 | 7 | /** 8 | * Class Migration_create_table_api_limits 9 | * 10 | * @property CI_DB_forge $dbforge 11 | * @property CI_DB_query_builder $db 12 | */ 13 | class Migration_create_table_api_limits extends CI_Migration { 14 | 15 | 16 | public function up() 17 | { 18 | $this->config->load('rest'); 19 | $table = config_item('rest_limits_table'); 20 | $fields = array( 21 | 'id' => [ 22 | 'type' => 'INT(11)', 23 | 'auto_increment' => TRUE, 24 | 'unsigned' => TRUE, 25 | ], 26 | 'api_key' => [ 27 | 'type' => 'VARCHAR(' . config_item('rest_key_length') . ')', 28 | ], 29 | 'uri' => [ 30 | 'type' => 'VARCHAR(255)', 31 | ], 32 | 'count' => [ 33 | 'type' => 'INT(10)', 34 | ], 35 | 'hour_started' => [ 36 | 'type' => 'INT(11)', 37 | ], 38 | ); 39 | $this->dbforge->add_field($fields); 40 | $this->dbforge->add_key('id', TRUE); 41 | $this->dbforge->add_key('uri'); 42 | $this->dbforge->create_table($table); 43 | $this->db->query(add_foreign_key($table, 'api_key', 44 | config_item('rest_keys_table') . '(' . config_item('rest_key_column') . ')', 'CASCADE', 'CASCADE')); 45 | } 46 | 47 | 48 | public function down() 49 | { 50 | $table = config_item('rest_limits_table'); 51 | if ($this->db->table_exists($table)) 52 | { 53 | $this->db->query(drop_foreign_key($table, 'api_key')); 54 | $this->dbforge->drop_table($table); 55 | } 56 | } 57 | 58 | } 59 | -------------------------------------------------------------------------------- /application/migrations/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Directory access is forbidden.
9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /application/views/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |Directory access is forbidden.
9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /application/views/rest_server.php: -------------------------------------------------------------------------------- 1 | 4 | 5 | 6 | 7 | 8 | 9 |81 | See the article 82 | 83 | http://net.tutsplus.com/tutorials/php/working-with-restful-services-in-codeigniter-2/ 84 | 85 |
86 | 87 |88 | The master project repository is 89 | 90 | https://github.com/chriskacerguis/codeigniter-restserver 91 | 92 |
93 | 94 |95 | Click on the links to check whether the REST server is working. 96 |
97 | 98 |The page you are looking at is being generated dynamically by CodeIgniter.
85 | 86 |If you would like to edit this page you'll find it located at:
87 |application/views/welcome_message.php
88 |
89 | The corresponding controller for this page is found at:
90 |application/controllers/Welcome.php
91 |
92 |
93 | If you are exploring CodeIgniter for the very first time, you should start by reading the User Guide.
94 | 95 |The requested page could not be found.
98 |You have probably clicked on a link that is outdated and points to a page that does not exist any more or you have made an typing error in the address.
99 |To continue please try to find requested page in the menu, or use search field on the top.
100 |This is an example of a few basic user interaction methods you could use 96 | all done with a hardcoded array
97 |
107 | REST_Controller
108 |
109 |
110 |
111 |
114 | Example
115 |
116 |
117 |
152 | public
153 |
154 |
155 |
156 |
157 | |
158 |
159 |
160 | #
161 | __construct( string $config,… )
162 |
163 |
164 |
166 |
167 |
185 | Constructor for the REST API 165 | |
186 |
190 | public
191 |
192 |
193 |
194 |
195 | |
196 |
197 | 216 | |
220 | public
221 |
222 |
223 |
224 |
225 | |
226 |
227 | 246 | |
250 | public
251 |
252 |
253 |
254 |
255 | |
256 |
257 | 276 | |
414 | $_allow,
415 | $_apiuser,
416 | $_args,
417 | $_delete_args,
418 | $_enable_xss,
419 | $_end_rtime,
420 | $_get_args,
421 | $_head_args,
422 | $_insert_id,
423 | $_options_args,
424 | $_patch_args,
425 | $_post_args,
426 | $_put_args,
427 | $_query_args,
428 | $_start_rtime,
429 | $_supported_formats,
430 | $_user_ldap_dn,
431 | $allowed_http_methods,
432 | $check_cors,
433 | $http_status_codes,
434 | $methods,
435 | $request,
436 | $response,
437 | $rest,
438 | $rest_format
439 | |
440 |
Keys Controller 96 | This is a basic Key Management REST controller to make and delete keys
97 |
107 | REST_Controller
108 |
109 |
110 |
111 |
114 | Key
115 |
116 |
117 |
152 | public
153 |
154 |
155 |
156 |
157 | |
158 |
159 | 178 | |
182 | public
183 |
184 |
185 |
186 |
187 | |
188 |
189 |
190 | #
191 | index_delete( )
192 |
193 |
194 |
196 |
197 |
207 | Remove a key from the database to stop it working 195 | |
208 |
212 | public
213 |
214 |
215 |
216 |
217 | |
218 |
219 | 238 | |
242 | public
243 |
244 |
245 |
246 |
247 | |
248 |
249 | 268 | |
272 | public
273 |
274 |
275 |
276 |
277 | |
278 |
279 | 298 | |
436 | protected
437 | array
438 | |
439 |
440 |
441 | $methods
442 |
443 |
444 |
446 |
447 |
451 | Defines the list of method properties such as limit, log and level 445 | |
452 |
453 |
454 | #
455 |
462 | [
456 | 'index_put' => ['level' => 10, 'limit' => 10],
457 | 'index_delete' => ['level' => 10],
458 | 'level_post' => ['level' => 10],
459 | 'regenerate_post' => ['level' => 10],
460 | ]
461 | |
463 |
470 | $_allow,
471 | $_apiuser,
472 | $_args,
473 | $_delete_args,
474 | $_enable_xss,
475 | $_end_rtime,
476 | $_get_args,
477 | $_head_args,
478 | $_insert_id,
479 | $_options_args,
480 | $_patch_args,
481 | $_post_args,
482 | $_put_args,
483 | $_query_args,
484 | $_start_rtime,
485 | $_supported_formats,
486 | $_user_ldap_dn,
487 | $allowed_http_methods,
488 | $check_cors,
489 | $http_status_codes,
490 | $request,
491 | $response,
492 | $rest,
493 | $rest_format
494 | |
495 |
104 | Rest_server
105 |
106 |
107 |
134 | public
135 |
136 |
137 |
138 |
139 | |
140 |
141 | 160 | |
104 | Welcome
105 |
106 |
107 |
134 | public
135 |
136 |
137 |
138 |
139 | |
140 |
141 | 173 | |
| 101 | CodeIgniter 102 | | 103 |
| 106 | CodeIgniter\Libraries 107 | | 108 |
| 111 | CodeIgniter\Rest 112 | | 113 |
| 116 | None 117 | | 118 |
| REST_Controller | 98 |CodeIgniter Rest Controller 99 | A fully RESTful server implementation for CodeIgniter using one library, one config file and one controller. |
100 |
| Example | 99 |This is an example of a few basic user interaction methods you could use 100 | all done with a hardcoded array |
101 |
| Key | 104 |Keys Controller 105 | This is a basic Key Management REST controller to make and delete keys |
106 |
| CodeIgniter\Libraries | 91 |
| CodeIgniter\Rest | 94 |
| Format | 100 |Format class 101 | Help convert between various formats such as XML, JSON, CSV, etc. |
102 |
| Rest_server | 105 |106 | |
| Welcome | 109 |110 | |
1: <?php
96 | 2:
97 | 3: defined('BASEPATH') OR exit('No direct script access allowed');
98 | 4:
99 | 5: // This can be removed if you use __autoload() in config.php OR use Modular Extensions
100 | 6: require APPPATH . '/libraries/REST_Controller.php';
101 | 7:
102 | 8: /**
103 | 9: * This is an example of a few basic user interaction methods you could use
104 | 10: * all done with a hardcoded array
105 | 11: *
106 | 12: * @package CodeIgniter
107 | 13: * @subpackage Rest Server
108 | 14: * @category Controller
109 | 15: * @author Phil Sturgeon, Chris Kacerguis
110 | 16: * @license MIT
111 | 17: * @link https://github.com/chriskacerguis/codeigniter-restserver
112 | 18: */
113 | 19: class Example extends REST_Controller {
114 | 20:
115 | 21: function __construct()
116 | 22: {
117 | 23: // Construct the parent class
118 | 24: parent::__construct();
119 | 25:
120 | 26: // Configure limits on our controller methods
121 | 27: // Ensure you have created the 'limits' table and enabled 'limits' within application/config/rest.php
122 | 28: $this->methods['user_get']['limit'] = 500; // 500 requests per hour per user/key
123 | 29: $this->methods['user_post']['limit'] = 100; // 100 requests per hour per user/key
124 | 30: $this->methods['user_delete']['limit'] = 50; // 50 requests per hour per user/key
125 | 31: }
126 | 32:
127 | 33: public function users_get()
128 | 34: {
129 | 35: // Users from a data store e.g. database
130 | 36: $users = [
131 | 37: ['id' => 1, 'name' => 'John', 'email' => 'john@example.com', 'fact' => 'Loves coding'],
132 | 38: ['id' => 2, 'name' => 'Jim', 'email' => 'jim@example.com', 'fact' => 'Developed on CodeIgniter'],
133 | 39: ['id' => 3, 'name' => 'Jane', 'email' => 'jane@example.com', 'fact' => 'Lives in the USA', ['hobbies' => ['guitar', 'cycling']]],
134 | 40: ];
135 | 41:
136 | 42: $id = $this->get('id');
137 | 43:
138 | 44: // If the id parameter doesn't exist return all the users
139 | 45:
140 | 46: if ($id === NULL)
141 | 47: {
142 | 48: // Check if the users data store contains users (in case the database result returns NULL)
143 | 49: if ($users)
144 | 50: {
145 | 51: // Set the response and exit
146 | 52: $this->response($users, REST_Controller::HTTP_OK); // OK (200) being the HTTP response code
147 | 53: }
148 | 54: else
149 | 55: {
150 | 56: // Set the response and exit
151 | 57: $this->response([
152 | 58: 'status' => FALSE,
153 | 59: 'message' => 'No users were found'
154 | 60: ], REST_Controller::HTTP_NOT_FOUND); // NOT_FOUND (404) being the HTTP response code
155 | 61: }
156 | 62: }
157 | 63:
158 | 64: // Find and return a single record for a particular user.
159 | 65:
160 | 66: $id = (int) $id;
161 | 67:
162 | 68: // Validate the id.
163 | 69: if ($id <= 0)
164 | 70: {
165 | 71: // Invalid id, set the response and exit.
166 | 72: $this->response(NULL, REST_Controller::HTTP_BAD_REQUEST); // BAD_REQUEST (400) being the HTTP response code
167 | 73: }
168 | 74:
169 | 75: // Get the user from the array, using the id as key for retreival.
170 | 76: // Usually a model is to be used for this.
171 | 77:
172 | 78: $user = NULL;
173 | 79:
174 | 80: if (!empty($users))
175 | 81: {
176 | 82: foreach ($users as $key => $value)
177 | 83: {
178 | 84: if (isset($value['id']) && $value['id'] === $id)
179 | 85: {
180 | 86: $user = $value;
181 | 87: }
182 | 88: }
183 | 89: }
184 | 90:
185 | 91: if (!empty($user))
186 | 92: {
187 | 93: $this->set_response($user, REST_Controller::HTTP_OK); // OK (200) being the HTTP response code
188 | 94: }
189 | 95: else
190 | 96: {
191 | 97: $this->set_response([
192 | 98: 'status' => FALSE,
193 | 99: 'message' => 'User could not be found'
194 | 100: ], REST_Controller::HTTP_NOT_FOUND); // NOT_FOUND (404) being the HTTP response code
195 | 101: }
196 | 102: }
197 | 103:
198 | 104: public function users_post()
199 | 105: {
200 | 106: // $this->some_model->update_user( ... );
201 | 107: $message = [
202 | 108: 'id' => 100, // Automatically generated by the model
203 | 109: 'name' => $this->post('name'),
204 | 110: 'email' => $this->post('email'),
205 | 111: 'message' => 'Added a resource'
206 | 112: ];
207 | 113:
208 | 114: $this->set_response($message, REST_Controller::HTTP_CREATED); // CREATED (201) being the HTTP response code
209 | 115: }
210 | 116:
211 | 117: public function users_delete()
212 | 118: {
213 | 119: $id = (int) $this->get('id');
214 | 120:
215 | 121: // Validate the id.
216 | 122: if ($id <= 0)
217 | 123: {
218 | 124: // Set the response and exit
219 | 125: $this->response(NULL, REST_Controller::HTTP_BAD_REQUEST); // BAD_REQUEST (400) being the HTTP response code
220 | 126: }
221 | 127:
222 | 128: // $this->some_model->delete_something($id);
223 | 129: $message = [
224 | 130: 'id' => $id,
225 | 131: 'message' => 'Deleted the resource'
226 | 132: ];
227 | 133:
228 | 134: $this->set_response($message, REST_Controller::HTTP_NO_CONTENT); // NO_CONTENT (204) being the HTTP response code
229 | 135: }
230 | 136:
231 | 137: }
232 | 138: 1: <?php
96 | 2:
97 | 3: defined('BASEPATH') OR exit('No direct script access allowed');
98 | 4:
99 | 5: class Rest_server extends CI_Controller {
100 | 6:
101 | 7: public function index()
102 | 8: {
103 | 9: $this->load->helper('url');
104 | 10:
105 | 11: $this->load->view('rest_server');
106 | 12: }
107 | 13: }
108 | 14: 1: <?php
96 | 2: defined('BASEPATH') OR exit('No direct script access allowed');
97 | 3:
98 | 4: class Welcome extends CI_Controller {
99 | 5:
100 | 6: /**
101 | 7: * Index Page for this controller.
102 | 8: *
103 | 9: * Maps to the following URL
104 | 10: * http://example.com/index.php/welcome
105 | 11: * - or -
106 | 12: * http://example.com/index.php/welcome/index
107 | 13: * - or -
108 | 14: * Since this controller is set as the default controller in
109 | 15: * config/routes.php, it's displayed at http://example.com/
110 | 16: *
111 | 17: * So any other public methods not prefixed with an underscore will
112 | 18: * map to /index.php/welcome/<method_name>
113 | 19: * @see https://codeigniter.com/user_guide/general/urls.html
114 | 20: */
115 | 21: public function index()
116 | 22: {
117 | 23: $this->load->helper('url');
118 | 24:
119 | 25: $this->load->view('welcome_message');
120 | 26: }
121 | 27: }
122 | 28: