| @@ -12,9 +12,9 @@ | ||
| 12 | 12 | |
| 13 | 13 |  class EmptyArrayException extends Exception { | 
| 14 | 14 | |
| 15 | - public static function checkEmptyArrayException($message) | |
| 16 | -    { | |
| 17 | - return new static($message); | |
| 18 | - } | |
| 15 | + public static function checkEmptyArrayException($message) | |
| 16 | +	{ | |
| 17 | + return new static($message); | |
| 18 | + } | |
| 19 | 19 | |
| 20 | 20 | } | 
| @@ -12,9 +12,9 @@ | ||
| 12 | 12 | |
| 13 | 13 |  class NoArgumentPassedToFunctionException extends Exception { | 
| 14 | 14 | |
| 15 | - public static function checkNoArgumentPassedToFunction($message) | |
| 16 | -    { | |
| 17 | - return new static($message); | |
| 18 | - } | |
| 15 | + public static function checkNoArgumentPassedToFunction($message) | |
| 16 | +	{ | |
| 17 | + return new static($message); | |
| 18 | + } | |
| 19 | 19 | |
| 20 | 20 | } | 
| @@ -12,8 +12,8 @@ | ||
| 12 | 12 | |
| 13 | 13 |  class NoRecordInsertionException extends Exception { | 
| 14 | 14 | |
| 15 | - public static function checkNoRecordAddedException($mesaage) | |
| 16 | -    { | |
| 17 | - return new static($mesaage); | |
| 18 | - } | |
| 15 | + public static function checkNoRecordAddedException($mesaage) | |
| 16 | +	{ | |
| 17 | + return new static($mesaage); | |
| 18 | + } | |
| 19 | 19 | } | 
| @@ -12,9 +12,9 @@ | ||
| 12 | 12 | |
| 13 | 13 |  class NoRecordUpdateException extends  Exception { | 
| 14 | 14 | |
| 15 | - public static function checkNoRecordUpdateException($message) | |
| 16 | -    { | |
| 17 | - return new static($message); | |
| 18 | - } | |
| 15 | + public static function checkNoRecordUpdateException($message) | |
| 16 | +	{ | |
| 17 | + return new static($message); | |
| 18 | + } | |
| 19 | 19 | |
| 20 | 20 | } | 
| @@ -12,9 +12,9 @@ | ||
| 12 | 12 | |
| 13 | 13 |  class NullArgumentPassedToFunction extends Exception { | 
| 14 | 14 | |
| 15 | - public static function ckeckNullArgumentPassedToFunction($message) | |
| 16 | -    { | |
| 17 | - return new static ($message); | |
| 18 | - } | |
| 15 | + public static function ckeckNullArgumentPassedToFunction($message) | |
| 16 | +	{ | |
| 17 | + return new static ($message); | |
| 18 | + } | |
| 19 | 19 | |
| 20 | 20 | } | 
| @@ -12,9 +12,9 @@ | ||
| 12 | 12 | |
| 13 | 13 |  class WrongArgumentException extends Exception { | 
| 14 | 14 | |
| 15 | - public function checkWrongArgumentException($message) | |
| 16 | -    { | |
| 17 | - return new static ($message); | |
| 18 | - } | |
| 15 | + public function checkWrongArgumentException($message) | |
| 16 | +	{ | |
| 17 | + return new static ($message); | |
| 18 | + } | |
| 19 | 19 | |
| 20 | 20 | } | 
| @@ -13,25 +13,25 @@ | ||
| 13 | 13 | |
| 14 | 14 |  class DatabaseHelper { | 
| 15 | 15 | |
| 16 | - public $dbConn; | |
| 16 | + public $dbConn; | |
| 17 | 17 | |
| 18 | - /** | |
| 19 | - * This is a constructor; a default method that will be called automatically during class instantiation | |
| 20 | - */ | |
| 21 | - public function __construct($dbConnect) | |
| 22 | -    { | |
| 23 | - $this->dbConn = $dbConnect; | |
| 24 | - } | |
| 18 | + /** | |
| 19 | + * This is a constructor; a default method that will be called automatically during class instantiation | |
| 20 | + */ | |
| 21 | + public function __construct($dbConnect) | |
| 22 | +	{ | |
| 23 | + $this->dbConn = $dbConnect; | |
| 24 | + } | |
| 25 | 25 | |
| 26 | - /** | |
| 27 | - * This method creates a particular table | |
| 28 | - * @param tableName | |
| 29 | - * $return boolean true or false | |
| 30 | - */ | |
| 26 | + /** | |
| 27 | + * This method creates a particular table | |
| 28 | + * @param tableName | |
| 29 | + * $return boolean true or false | |
| 30 | + */ | |
| 31 | 31 | public function createTable($tableName, $conn = NULL) | 
| 32 | 32 |     { | 
| 33 | 33 |     	if (is_null($conn)) { | 
| 34 | - $conn = $this->dbConn; | |
| 34 | + $conn = $this->dbConn; | |
| 35 | 35 | } | 
| 36 | 36 | |
| 37 | 37 |     	$sql = 'CREATE TABLE IF NOT EXISTS '.$tableName.'('; | 
| @@ -10,12 +10,12 @@ | ||
| 10 | 10 | |
| 11 | 11 |  interface InterfaceBaseClass { | 
| 12 | 12 | |
| 13 | - /** | |
| 14 | - * This method gets all the record from a particular table | |
| 15 | - * @params void | |
| 16 | - * @return associative array | |
| 17 | - */ | |
| 18 | - public static function getAll(); | |
| 13 | + /** | |
| 14 | + * This method gets all the record from a particular table | |
| 15 | + * @params void | |
| 16 | + * @return associative array | |
| 17 | + */ | |
| 18 | + public static function getAll(); | |
| 19 | 19 | |
| 20 | 20 | /** | 
| 21 | 21 | * This method create or update record in a database table | 
| @@ -20,124 +20,124 @@ discard block | ||
| 20 | 20 | |
| 21 | 21 | class BaseClass implements InterfaceBaseClass | 
| 22 | 22 |  { | 
| 23 | - protected $databaseModel; // Private variable that contains instance of database | |
| 24 | - protected $tableName; // Class variable holding class name pluralized | |
| 25 | - protected $properties = []; // Properties will later contain key, value pairs from the magic setter, getter methods | |
| 26 | - use Inflector; // Inject the inflector trait | |
| 23 | + protected $databaseModel; // Private variable that contains instance of database | |
| 24 | + protected $tableName; // Class variable holding class name pluralized | |
| 25 | + protected $properties = []; // Properties will later contain key, value pairs from the magic setter, getter methods | |
| 26 | + use Inflector; // Inject the inflector trait | |
| 27 | 27 | |
| 28 | - public function __construct() | |
| 29 | -    { | |
| 30 | - $this->tableName = $this->getClassName(); | |
| 31 | - $this->databaseModel = new DatabaseHandler($this->tableName); | |
| 32 | - $this->properties['id'] = 0; | |
| 33 | - } | |
| 28 | + public function __construct() | |
| 29 | +	{ | |
| 30 | + $this->tableName = $this->getClassName(); | |
| 31 | + $this->databaseModel = new DatabaseHandler($this->tableName); | |
| 32 | + $this->properties['id'] = 0; | |
| 33 | + } | |
| 34 | 34 | |
| 35 | - /** | |
| 36 | - * The magic getter method | |
| 37 | - * @params key | |
| 38 | - * @return array key | |
| 39 | - */ | |
| 40 | - public function __get($key) | |
| 41 | -    { | |
| 42 | - $this->properties[$key]; | |
| 43 | - } | |
| 35 | + /** | |
| 36 | + * The magic getter method | |
| 37 | + * @params key | |
| 38 | + * @return array key | |
| 39 | + */ | |
| 40 | + public function __get($key) | |
| 41 | +	{ | |
| 42 | + $this->properties[$key]; | |
| 43 | + } | |
| 44 | 44 | |
| 45 | - /** | |
| 46 | - * The magic setter method | |
| 47 | - * @params property, key | |
| 48 | - * @return array associative array properties | |
| 49 | - */ | |
| 50 | - public function __set($property, $value) | |
| 51 | -    { | |
| 52 | - $this->properties[$property] = $value; | |
| 53 | - } | |
| 45 | + /** | |
| 46 | + * The magic setter method | |
| 47 | + * @params property, key | |
| 48 | + * @return array associative array properties | |
| 49 | + */ | |
| 50 | + public function __set($property, $value) | |
| 51 | +	{ | |
| 52 | + $this->properties[$property] = $value; | |
| 53 | + } | |
| 54 | 54 | |
| 55 | - /** | |
| 56 | - * This method gets all the record from a particular table | |
| 57 | - * @params void | |
| 58 | - * @return associative array | |
| 59 | - * @throws NoRecordFoundException | |
| 60 | - */ | |
| 61 | - public static function getAll() | |
| 62 | -    { | |
| 63 | - $allData = DatabaseHandler::read($id = false, self::getClassName()); | |
| 64 | -    	if (count($allData) > 0) { | |
| 65 | - return $allData; | |
| 66 | - } | |
| 67 | -    	throw NoRecordFoundException::checkNoRecordFoundException("There is no record to display"); | |
| 68 | - } | |
| 55 | + /** | |
| 56 | + * This method gets all the record from a particular table | |
| 57 | + * @params void | |
| 58 | + * @return associative array | |
| 59 | + * @throws NoRecordFoundException | |
| 60 | + */ | |
| 61 | + public static function getAll() | |
| 62 | +	{ | |
| 63 | + $allData = DatabaseHandler::read($id = false, self::getClassName()); | |
| 64 | +		if (count($allData) > 0) { | |
| 65 | + return $allData; | |
| 66 | + } | |
| 67 | +		throw NoRecordFoundException::checkNoRecordFoundException("There is no record to display"); | |
| 68 | + } | |
| 69 | 69 | |
| 70 | - /** | |
| 71 | - * This method create or update record in a database table | |
| 72 | - * @params void | |
| 73 | - * @return bool true or false; | |
| 74 | - * @throws EmptyArrayException | |
| 75 | - * @throws NoRecordInsertionException | |
| 76 | - * @throws NoRecordUpdateException | |
| 77 | - */ | |
| 78 | - public function save() | |
| 79 | -    { | |
| 80 | - $boolCommit = false; | |
| 81 | -    	if ($this->properties['id']) { | |
| 82 | - $allData = DatabaseHandler::read($id = $this->properties['id'], self::getClassName()); | |
| 83 | -    	    if ($this->checkIfRecordIsEmpty($allData)) { | |
| 84 | - $boolCommit = $this->databaseModel->update(['id' => $this->properties['id']], $this->tableName, $this->properties); | |
| 85 | -    	    	if ($boolCommit) { | |
| 86 | - return true; | |
| 87 | - } | |
| 88 | -    	    	throw NoRecordUpdateException::checkNoRecordUpdateException("Record not updated successfully"); | |
| 89 | - } | |
| 90 | -    	    throw EmptyArrayException::checkEmptyArrayException("Value passed didn't match any record"); | |
| 91 | - } | |
| 92 | - $boolCommit = $this->databaseModel->create($this->properties, $this->tableName); | |
| 93 | -    	if ($boolCommit) { | |
| 94 | - return true; | |
| 95 | - } | |
| 96 | -    	throw NoRecordInsertionException::checkNoRecordAddedException("Record not created successfully"); | |
| 97 | - } | |
| 70 | + /** | |
| 71 | + * This method create or update record in a database table | |
| 72 | + * @params void | |
| 73 | + * @return bool true or false; | |
| 74 | + * @throws EmptyArrayException | |
| 75 | + * @throws NoRecordInsertionException | |
| 76 | + * @throws NoRecordUpdateException | |
| 77 | + */ | |
| 78 | + public function save() | |
| 79 | +	{ | |
| 80 | + $boolCommit = false; | |
| 81 | +		if ($this->properties['id']) { | |
| 82 | + $allData = DatabaseHandler::read($id = $this->properties['id'], self::getClassName()); | |
| 83 | +			if ($this->checkIfRecordIsEmpty($allData)) { | |
| 84 | + $boolCommit = $this->databaseModel->update(['id' => $this->properties['id']], $this->tableName, $this->properties); | |
| 85 | +				if ($boolCommit) { | |
| 86 | + return true; | |
| 87 | + } | |
| 88 | +				throw NoRecordUpdateException::checkNoRecordUpdateException("Record not updated successfully"); | |
| 89 | + } | |
| 90 | +			throw EmptyArrayException::checkEmptyArrayException("Value passed didn't match any record"); | |
| 91 | + } | |
| 92 | + $boolCommit = $this->databaseModel->create($this->properties, $this->tableName); | |
| 93 | +		if ($boolCommit) { | |
| 94 | + return true; | |
| 95 | + } | |
| 96 | +		throw NoRecordInsertionException::checkNoRecordAddedException("Record not created successfully"); | |
| 97 | + } | |
| 98 | 98 | |
| 99 | - /** | |
| 100 | - * This method find a record by id | |
| 101 | - * @params int id | |
| 102 | - * @return Object | |
| 103 | - * @throws NoArgumentPassedToFunctionException | |
| 104 | - */ | |
| 105 | - public static function find($id) | |
| 106 | -    { | |
| 107 | - $num_args = (int) func_num_args(); // get number of arguments passed to | |
| 108 | -    	if ($num_args == 0 || $num_args > 1) { | |
| 109 | -    	    throw NoArgumentPassedToFunctionException::checkNoArgumentPassedToFunction("Argument missing: only one argument is allowed"); | |
| 110 | - } | |
| 111 | -    	if ($id == "") { | |
| 112 | -    		throw NullArgumentPassedToFunction::ckeckNullArgumentPassedToFunction("This function expect a value"); | |
| 113 | - } | |
| 114 | - $staticFindInstance = new static(); | |
| 115 | - $staticFindInstance->id = $id == "" ? false : $id; | |
| 116 | - return $staticFindInstance; | |
| 99 | + /** | |
| 100 | + * This method find a record by id | |
| 101 | + * @params int id | |
| 102 | + * @return Object | |
| 103 | + * @throws NoArgumentPassedToFunctionException | |
| 104 | + */ | |
| 105 | + public static function find($id) | |
| 106 | +	{ | |
| 107 | + $num_args = (int) func_num_args(); // get number of arguments passed to | |
| 108 | +		if ($num_args == 0 || $num_args > 1) { | |
| 109 | +			throw NoArgumentPassedToFunctionException::checkNoArgumentPassedToFunction("Argument missing: only one argument is allowed"); | |
| 110 | + } | |
| 111 | +		if ($id == "") { | |
| 112 | +			throw NullArgumentPassedToFunction::ckeckNullArgumentPassedToFunction("This function expect a value"); | |
| 113 | + } | |
| 114 | + $staticFindInstance = new static(); | |
| 115 | + $staticFindInstance->id = $id == "" ? false : $id; | |
| 116 | + return $staticFindInstance; | |
| 117 | 117 | |
| 118 | - } | |
| 118 | + } | |
| 119 | 119 | |
| 120 | - /** | |
| 121 | - * This method delete a row from the table by the row id | |
| 122 | - * @params int id | |
| 123 | - * @return boolean true or false | |
| 124 | - * @throws NoRecordDeletionException; | |
| 125 | - */ | |
| 126 | - public static function destroy($id) | |
| 127 | -    { | |
| 128 | - $boolDeleted = false; | |
| 129 | - $num_args = (int) func_num_args(); // get number of arguments passed to | |
| 120 | + /** | |
| 121 | + * This method delete a row from the table by the row id | |
| 122 | + * @params int id | |
| 123 | + * @return boolean true or false | |
| 124 | + * @throws NoRecordDeletionException; | |
| 125 | + */ | |
| 126 | + public static function destroy($id) | |
| 127 | +	{ | |
| 128 | + $boolDeleted = false; | |
| 129 | + $num_args = (int) func_num_args(); // get number of arguments passed to | |
| 130 | 130 | |
| 131 | -    	if ($num_args == 0 || $num_args > 1) { | |
| 132 | -    	    throw NoArgumentPassedToFunctionException::checkNoArgumentPassedToFunction("Argument missing: only one argument is allowed"); | |
| 133 | - } | |
| 134 | - $boolDeleted = DatabaseHandler::delete($id, self::getClassName()); | |
| 135 | -    	if ($boolDeleted) { | |
| 136 | - return true; | |
| 137 | - } | |
| 138 | -    	throw NoRecordDeletionException::checkNoRecordUpdateException("Record deletion unsuccessful because id does not match any record"); | |
| 131 | +		if ($num_args == 0 || $num_args > 1) { | |
| 132 | +			throw NoArgumentPassedToFunctionException::checkNoArgumentPassedToFunction("Argument missing: only one argument is allowed"); | |
| 133 | + } | |
| 134 | + $boolDeleted = DatabaseHandler::delete($id, self::getClassName()); | |
| 135 | +		if ($boolDeleted) { | |
| 136 | + return true; | |
| 137 | + } | |
| 138 | +		throw NoRecordDeletionException::checkNoRecordUpdateException("Record deletion unsuccessful because id does not match any record"); | |
| 139 | 139 | |
| 140 | - } | |
| 140 | + } | |
| 141 | 141 | |
| 142 | 142 | /** | 
| 143 | 143 | * This method return the current class name | 
| @@ -156,12 +156,12 @@ discard block | ||
| 156 | 156 | * @param $arrayOfRecord | 
| 157 | 157 | * @return bool | 
| 158 | 158 | */ | 
| 159 | - public function checkIfRecordIsEmpty($arrayOfRecord) | |
| 160 | -    { | |
| 161 | -    	if (count($arrayOfRecord) > 0) { | |
| 162 | - return true; | |
| 163 | - } | |
| 164 | - return false; | |
| 165 | - } | |
| 159 | + public function checkIfRecordIsEmpty($arrayOfRecord) | |
| 160 | +	{ | |
| 161 | +		if (count($arrayOfRecord) > 0) { | |
| 162 | + return true; | |
| 163 | + } | |
| 164 | + return false; | |
| 165 | + } | |
| 166 | 166 | |
| 167 | 167 | } |