diff --git a/engine/Api/V1/Authorization.php b/engine/Api/V1/Authorization.php index ccf19ee5..627f8309 100644 --- a/engine/Api/V1/Authorization.php +++ b/engine/Api/V1/Authorization.php @@ -19,6 +19,8 @@ use \EA\Engine\Types\NonEmptyText; * API v1 Authorization Class * * This class will handle the authorization procedure of the API. + * + * @deprecated */ class Authorization { /** diff --git a/engine/Api/V1/Exception.php b/engine/Api/V1/Exception.php index d2ba6f2c..5b7f4088 100644 --- a/engine/Api/V1/Exception.php +++ b/engine/Api/V1/Exception.php @@ -17,6 +17,8 @@ namespace EA\Engine\Api\V1; * API v1 Exception Class * * This exception variation will hold the information needed for exception handling in the API. + * + * @deprecated */ class Exception extends \Exception { /** diff --git a/engine/Api/V1/Parsers/Admins.php b/engine/Api/V1/Parsers/Admins.php index 7beb3752..674571e3 100644 --- a/engine/Api/V1/Parsers/Admins.php +++ b/engine/Api/V1/Parsers/Admins.php @@ -17,6 +17,8 @@ namespace EA\Engine\Api\V1\Parsers; * Admins Parser * * This class will handle the encoding and decoding from the API requests. + * + * @deprecated */ class Admins implements ParsersInterface { /** diff --git a/engine/Api/V1/Parsers/Appointments.php b/engine/Api/V1/Parsers/Appointments.php index cfc3b8e3..273974e8 100644 --- a/engine/Api/V1/Parsers/Appointments.php +++ b/engine/Api/V1/Parsers/Appointments.php @@ -17,6 +17,8 @@ namespace EA\Engine\Api\V1\Parsers; * Appointments Parser * * This class will handle the encoding and decoding from the API requests. + * + * @deprecated */ class Appointments implements ParsersInterface { /** diff --git a/engine/Api/V1/Parsers/Categories.php b/engine/Api/V1/Parsers/Categories.php index 610f3b42..ae7a7996 100644 --- a/engine/Api/V1/Parsers/Categories.php +++ b/engine/Api/V1/Parsers/Categories.php @@ -17,6 +17,8 @@ namespace EA\Engine\Api\V1\Parsers; * Categories Parser * * This class will handle the encoding and decoding from the API requests. + * + * @deprecated */ class Categories implements ParsersInterface { /** diff --git a/engine/Api/V1/Parsers/Customers.php b/engine/Api/V1/Parsers/Customers.php index 1c2d5a0b..f1c3fb34 100644 --- a/engine/Api/V1/Parsers/Customers.php +++ b/engine/Api/V1/Parsers/Customers.php @@ -17,6 +17,8 @@ namespace EA\Engine\Api\V1\Parsers; * Customers Parser * * This class will handle the encoding and decoding from the API requests. + * + * @deprecated */ class Customers implements ParsersInterface { /** diff --git a/engine/Api/V1/Parsers/ParsersInterface.php b/engine/Api/V1/Parsers/ParsersInterface.php index 6262e9b8..8b103297 100644 --- a/engine/Api/V1/Parsers/ParsersInterface.php +++ b/engine/Api/V1/Parsers/ParsersInterface.php @@ -17,6 +17,8 @@ namespace EA\Engine\Api\V1\Parsers; * Parsers Interface * * Every parser needs the "encode" and "decode" methods. + * + * @deprecated */ interface ParsersInterface { /** diff --git a/engine/Api/V1/Parsers/Providers.php b/engine/Api/V1/Parsers/Providers.php index 663c93d4..948652dd 100644 --- a/engine/Api/V1/Parsers/Providers.php +++ b/engine/Api/V1/Parsers/Providers.php @@ -17,6 +17,8 @@ namespace EA\Engine\Api\V1\Parsers; * Providers Parser * * This class will handle the encoding and decoding from the API requests. + * + * @deprecated */ class Providers implements ParsersInterface { /** diff --git a/engine/Api/V1/Parsers/Secretaries.php b/engine/Api/V1/Parsers/Secretaries.php index 1ed1513a..a487e10c 100644 --- a/engine/Api/V1/Parsers/Secretaries.php +++ b/engine/Api/V1/Parsers/Secretaries.php @@ -17,6 +17,8 @@ namespace EA\Engine\Api\V1\Parsers; * Secretaries Parser * * This class will handle the encoding and decoding from the API requests. + * + * @deprecated */ class Secretaries implements ParsersInterface { /** diff --git a/engine/Api/V1/Parsers/Services.php b/engine/Api/V1/Parsers/Services.php index 7720b4f1..82a40fd7 100644 --- a/engine/Api/V1/Parsers/Services.php +++ b/engine/Api/V1/Parsers/Services.php @@ -17,6 +17,8 @@ namespace EA\Engine\Api\V1\Parsers; * Services Parser * * This class will handle the encoding and decoding from the API requests. + * + * @deprecated */ class Services implements ParsersInterface { /** diff --git a/engine/Api/V1/Parsers/Settings.php b/engine/Api/V1/Parsers/Settings.php index b544d1bb..ef0a713a 100644 --- a/engine/Api/V1/Parsers/Settings.php +++ b/engine/Api/V1/Parsers/Settings.php @@ -17,6 +17,8 @@ namespace EA\Engine\Api\V1\Parsers; * Settings Parser * * This class will handle the encoding and decoding from the API requests. + * + * @deprecated */ class Settings implements ParsersInterface { /** diff --git a/engine/Api/V1/Parsers/Unavailabilities.php b/engine/Api/V1/Parsers/Unavailabilities.php index 88e22b53..87b49b30 100644 --- a/engine/Api/V1/Parsers/Unavailabilities.php +++ b/engine/Api/V1/Parsers/Unavailabilities.php @@ -17,6 +17,8 @@ namespace EA\Engine\Api\V1\Parsers; * Unavailabilities Parser * * This class will handle the encoding and decoding from the API requests. + * + * @deprecated */ class Unavailabilities implements ParsersInterface { /** diff --git a/engine/Api/V1/Processors/Filter.php b/engine/Api/V1/Processors/Filter.php index 4f1fa2f2..4580d92b 100644 --- a/engine/Api/V1/Processors/Filter.php +++ b/engine/Api/V1/Processors/Filter.php @@ -20,6 +20,8 @@ namespace EA\Engine\Api\V1\Processors; * easier to apply some custom filtering in order to get the required results. * * @todo Implement this processor class. + * + * @deprecated */ class Filter implements ProcessorsInterface { /** diff --git a/engine/Api/V1/Processors/Minimize.php b/engine/Api/V1/Processors/Minimize.php index 35b13801..63631219 100644 --- a/engine/Api/V1/Processors/Minimize.php +++ b/engine/Api/V1/Processors/Minimize.php @@ -22,6 +22,8 @@ namespace EA\Engine\Api\V1\Processors; * * Make sure that the response parameter is a sequential array and not a single entry by the time this * processor is executed. + * + * @deprecated */ class Minimize implements ProcessorsInterface { /** diff --git a/engine/Api/V1/Processors/Paginate.php b/engine/Api/V1/Processors/Paginate.php index 4cc209cd..031f6a2b 100644 --- a/engine/Api/V1/Processors/Paginate.php +++ b/engine/Api/V1/Processors/Paginate.php @@ -22,6 +22,8 @@ namespace EA\Engine\Api\V1\Processors; * * Make sure that the response parameter is a sequential array and not a single entry by the time this * processor is executed. + * + * @deprecated */ class Paginate implements ProcessorsInterface { /** diff --git a/engine/Api/V1/Processors/ProcessorsInterface.php b/engine/Api/V1/Processors/ProcessorsInterface.php index fe087dba..4cb34e8a 100644 --- a/engine/Api/V1/Processors/ProcessorsInterface.php +++ b/engine/Api/V1/Processors/ProcessorsInterface.php @@ -13,6 +13,13 @@ namespace EA\Engine\Api\V1\Processors; +/** + * Interface ProcessorsInterface + * + * @deprecated + * + * @package EA\Engine\Api\V1\Processors + */ interface ProcessorsInterface { public static function process(array &$response); -} +} diff --git a/engine/Api/V1/Processors/Search.php b/engine/Api/V1/Processors/Search.php index 31166b41..fd89d0bb 100644 --- a/engine/Api/V1/Processors/Search.php +++ b/engine/Api/V1/Processors/Search.php @@ -19,6 +19,8 @@ namespace EA\Engine\Api\V1\Processors; * This class will search the response with the "q" GET parameter and only provide the entries * that match the keyword. Make sure that the response parameter is a sequential array and not * a single entry by the time this processor is executed. + * + * @deprecated */ class Search implements ProcessorsInterface { /** diff --git a/engine/Api/V1/Processors/Sort.php b/engine/Api/V1/Processors/Sort.php index 5a054735..234166b8 100644 --- a/engine/Api/V1/Processors/Sort.php +++ b/engine/Api/V1/Processors/Sort.php @@ -19,6 +19,8 @@ namespace EA\Engine\Api\V1\Processors; * This class will sort the response array with the provided GET parameters. Make sure that the * response parameter is a sequential array and not a single entry by the time this processor is * executed. + * + * @deprecated */ class Sort implements ProcessorsInterface { /** diff --git a/engine/Api/V1/Request.php b/engine/Api/V1/Request.php index 0d650d96..9c3fd8f3 100644 --- a/engine/Api/V1/Request.php +++ b/engine/Api/V1/Request.php @@ -18,6 +18,8 @@ namespace EA\Engine\Api\V1; * * This class handles the common request handling before the data are manipulated and * returned back with the Response class. + * + * @deprecated */ class Request { /** diff --git a/engine/Api/V1/Response.php b/engine/Api/V1/Response.php index a0e58a90..49f1cb4d 100644 --- a/engine/Api/V1/Response.php +++ b/engine/Api/V1/Response.php @@ -25,6 +25,8 @@ use EA\Engine\Types\NonEmptyText; * $parser = new \EA\Engine\Api\V1\Parsers\Appointments; * $response = new \EA\Engine\Api\V1\Response($data); * $response->format($parser)->search()->sort()->paginate()->minimize()->output(); + * + * @deprecated */ class Response { /** diff --git a/engine/Notifications/Email.php b/engine/Notifications/Email.php index b83eeeda..d028c725 100755 --- a/engine/Notifications/Email.php +++ b/engine/Notifications/Email.php @@ -24,6 +24,8 @@ use \EA\Engine\Types\Email as EmailAddress; * This library handles all the notification email deliveries on the system. * * Important: The email configuration settings are located at: /application/config/email.php + * + * @deprecated */ class Email { /** diff --git a/engine/Types/Boolean.php b/engine/Types/Boolean.php index f15349e1..2f0a1aa2 100644 --- a/engine/Types/Boolean.php +++ b/engine/Types/Boolean.php @@ -13,7 +13,18 @@ namespace EA\Engine\Types; +/** + * Class Boolean + * + * @deprecated + * + * @package EA\Engine\Types + */ class Boolean extends Type { + /** + * @param mixed $value + * @return bool + */ protected function _validate($value) { return is_bool($value); diff --git a/engine/Types/Decimal.php b/engine/Types/Decimal.php index 5f63271a..d30a37b3 100644 --- a/engine/Types/Decimal.php +++ b/engine/Types/Decimal.php @@ -13,7 +13,19 @@ namespace EA\Engine\Types; + +/** + * Class Decimal + * + * @deprecated + * + * @package EA\Engine\Types + */ class Decimal extends Type { + /** + * @param mixed $value + * @return bool + */ protected function _validate($value) { return is_float($value); diff --git a/engine/Types/Email.php b/engine/Types/Email.php index 3d7a8104..f3722c79 100644 --- a/engine/Types/Email.php +++ b/engine/Types/Email.php @@ -13,6 +13,13 @@ namespace EA\Engine\Types; +/** + * Class Email + * + * @deprecated + * + * @package EA\Engine\Types + */ class Email extends NonEmptyText { protected function _validate($value) { diff --git a/engine/Types/Integer.php b/engine/Types/Integer.php index 1f5667c9..60f32511 100644 --- a/engine/Types/Integer.php +++ b/engine/Types/Integer.php @@ -13,7 +13,18 @@ namespace EA\Engine\Types; +/** + * Class Integer + * + * @deprecated + * + * @package EA\Engine\Types + */ class Integer extends Type { + /** + * @param mixed $value + * @return bool + */ protected function _validate($value) { return is_numeric($value) && ! is_float($value); diff --git a/engine/Types/NonEmptyText.php b/engine/Types/NonEmptyText.php index b2dcfc54..ea0ef01b 100644 --- a/engine/Types/NonEmptyText.php +++ b/engine/Types/NonEmptyText.php @@ -13,7 +13,18 @@ namespace EA\Engine\Types; +/** + * Class NonEmptyText + * + * @deprecated + * + * @package EA\Engine\Types + */ class NonEmptyText extends Text { + /** + * @param mixed $value + * @return bool + */ protected function _validate($value) { return parent::_validate($value) && $value !== ''; diff --git a/engine/Types/Text.php b/engine/Types/Text.php index d738b81d..518aa800 100644 --- a/engine/Types/Text.php +++ b/engine/Types/Text.php @@ -13,6 +13,13 @@ namespace EA\Engine\Types; +/** + * Class Text + * + * @deprecated + * + * @package EA\Engine\Types + */ class Text extends Type { protected function _validate($value) { diff --git a/engine/Types/Type.php b/engine/Types/Type.php index 31547aed..d2298959 100644 --- a/engine/Types/Type.php +++ b/engine/Types/Type.php @@ -16,6 +16,8 @@ namespace EA\Engine\Types; /** * Abstract Type Class * + * @deprecated + * * This class needs to be extended by the type classes which must implement the validation logic. */ abstract class Type { diff --git a/engine/Types/UnsignedInteger.php b/engine/Types/UnsignedInteger.php index 30a47a8a..de775916 100644 --- a/engine/Types/UnsignedInteger.php +++ b/engine/Types/UnsignedInteger.php @@ -13,7 +13,18 @@ namespace EA\Engine\Types; +/** + * Class UnsignedInteger + * + * @deprecated + * + * @package EA\Engine\Types + */ class UnsignedInteger extends Integer { + /** + * @param mixed $value + * @return bool + */ protected function _validate($value) { return parent::_validate($value) && $value > -1; diff --git a/engine/Types/Url.php b/engine/Types/Url.php index e836adf3..af7870be 100644 --- a/engine/Types/Url.php +++ b/engine/Types/Url.php @@ -13,7 +13,18 @@ namespace EA\Engine\Types; +/** + * Class Url + * + * @deprecated + * + * @package EA\Engine\Types + */ class Url extends NonEmptyText { + /** + * @param mixed $value + * @return bool + */ protected function _validate($value) { return parent::_validate($value) && filter_var($value, FILTER_VALIDATE_URL);