Merge pull request chriskacerguis#526 from softwarespot/master

Improvements with non-English developers in mind

Author: chriskacerguis

application/config/rest.php

@@ -477,3 +477,13 @@
 |
 */
 $config['rest_ajax_only'] = FALSE;
+
+/*
+|--------------------------------------------------------------------------
+| REST Language File
+|--------------------------------------------------------------------------
+|
+| Language file to load from the language directory
+|
+*/
+$config['rest_language'] = 'english';

application/controllers/Rest_server.php

@@ -1,4 +1,5 @@
 <?php
+
 defined('BASEPATH') OR exit('No direct script access allowed');
 
 class Rest_server extends CI_Controller {

application/controllers/api/Example.php

@@ -56,7 +56,7 @@ public function users_get()
                 // Set the response and exit
                 $this->response([
                     'status' => FALSE,
-                    'error' => 'No users were found'
+                    'message' => 'No users were found'
                 ], REST_Controller::HTTP_NOT_FOUND); // NOT_FOUND (404) being the HTTP response code
             }
         }
@@ -96,7 +96,7 @@ public function users_get()
         {
             $this->set_response([
                 'status' => FALSE,
-                'error' => 'User could not be found'
+                'message' => 'User could not be found'
             ], REST_Controller::HTTP_NOT_FOUND); // NOT_FOUND (404) being the HTTP response code
         }
     }

application/controllers/api/Key.php

@@ -52,7 +52,7 @@ public function index_put()
         {
             $this->response([
                 'status' => FALSE,
-                'error' => 'Could not save the key'
+                'message' => 'Could not save the key'
             ], REST_Controller::HTTP_INTERNAL_SERVER_ERROR); // INTERNAL_SERVER_ERROR (500) being the HTTP response code
         }
     }
@@ -73,7 +73,7 @@ public function index_delete()
             // It doesn't appear the key exists
             $this->response([
                 'status' => FALSE,
-                'error' => 'Invalid API key'
+                'message' => 'Invalid API key'
             ], REST_Controller::HTTP_BAD_REQUEST); // BAD_REQUEST (400) being the HTTP response code
         }
 
@@ -83,7 +83,7 @@ public function index_delete()
         // Respond that the key was destroyed
         $this->response([
             'status' => TRUE,
-            'success' => 'API key was deleted'
+            'message' => 'API key was deleted'
             ], REST_Controller::HTTP_NO_CONTENT); // NO_CONTENT (204) being the HTTP response code
     }
 
@@ -104,7 +104,7 @@ public function level_post()
             // It doesn't appear the key exists
             $this->response([
                 'status' => FALSE,
-                'error' => 'Invalid API key'
+                'message' => 'Invalid API key'
             ], REST_Controller::HTTP_BAD_REQUEST); // BAD_REQUEST (400) being the HTTP response code
         }
 
@@ -113,14 +113,14 @@ public function level_post()
         {
             $this->response([
                 'status' => TRUE,
-                'success' => 'API key was updated'
+                'message' => 'API key was updated'
             ], REST_Controller::HTTP_OK); // OK (200) being the HTTP response code
         }
         else
         {
             $this->response([
                 'status' => FALSE,
-                'error' => 'Could not update the key level'
+                'message' => 'Could not update the key level'
             ], REST_Controller::HTTP_INTERNAL_SERVER_ERROR); // INTERNAL_SERVER_ERROR (500) being the HTTP response code
         }
     }
@@ -141,7 +141,7 @@ public function suspend_post()
             // It doesn't appear the key exists
             $this->response([
                 'status' => FALSE,
-                'error' => 'Invalid API key'
+                'message' => 'Invalid API key'
             ], REST_Controller::HTTP_BAD_REQUEST); // BAD_REQUEST (400) being the HTTP response code
         }
 
@@ -150,14 +150,14 @@ public function suspend_post()
         {
             $this->response([
                 'status' => TRUE,
-                'success' => 'Key was suspended'
+                'message' => 'Key was suspended'
             ], REST_Controller::HTTP_OK); // OK (200) being the HTTP response code
         }
         else
         {
             $this->response([
                 'status' => FALSE,
-                'error' => 'Could not suspend the user'
+                'message' => 'Could not suspend the user'
             ], REST_Controller::HTTP_INTERNAL_SERVER_ERROR); // INTERNAL_SERVER_ERROR (500) being the HTTP response code
         }
     }
@@ -179,7 +179,7 @@ public function regenerate_post()
             // It doesn't appear the key exists
             $this->response([
                 'status' => FALSE,
-                'error' => 'Invalid API key'
+                'message' => 'Invalid API key'
             ], REST_Controller::HTTP_BAD_REQUEST); // BAD_REQUEST (400) being the HTTP response code
         }
 
@@ -201,7 +201,7 @@ public function regenerate_post()
         {
             $this->response([
                 'status' => FALSE,
-                'error' => 'Could not save the key'
+                'message' => 'Could not save the key'
             ], REST_Controller::HTTP_INTERNAL_SERVER_ERROR); // INTERNAL_SERVER_ERROR (500) being the HTTP response code
         }
     }

application/language/english/index.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+<head>
+	<title>403 Forbidden</title>
+</head>
+<body>
+
+<p>Directory access is forbidden.</p>
+
+</body>
+</html>

application/language/english/rest_controller_lang.php

@@ -0,0 +1,17 @@
+<?php
+
+/*
+* English language
+*/
+
+$lang['text_rest_invalid_api_key'] = 'Invalid API key %s'; // %s is the REST API key
+$lang['text_rest_invalid_credentials'] = 'Invalid credentials';
+$lang['text_rest_ip_denied'] = 'IP denied';
+$lang['text_rest_ip_unauthorized'] = 'IP unauthorized';
+$lang['text_rest_unauthorized'] = 'Unauthorized';
+$lang['text_rest_ajax_only'] = 'Only Ajax requests are only allowed';
+$lang['text_rest_api_key_unauthorized'] = 'This API key does not have access to the requested controller';
+$lang['text_rest_api_key_permissions'] = 'This API key does not have enough permissions';
+$lang['text_rest_api_key_time_limit'] = 'This API key has reached the time limit for this method';
+$lang['text_rest_unknown_method'] = 'Unknown method';
+$lang['text_rest_unsupported'] = 'Unsupported protocol';

application/language/index.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+<head>
+	<title>403 Forbidden</title>
+</head>
+<body>
+
+<p>Directory access is forbidden.</p>
+
+</body>
+</html>