Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

refactor: Removal of Two Deprecated Classes #213

Merged
merged 4 commits into from
Mar 19, 2024
Merged

refactor: Removal of Two Deprecated Classes #213

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
62855c5
refactor: Removal of Two Deprecated Classes
usernane Mar 19, 2024
b8ac095
Revert "refactor: Removal of Two Deprecated Classes"
usernane Mar 19, 2024
0d5f798
chore: Cleanup
usernane Mar 19, 2024
3e33eb8
fix(cli) Fix Create Service Command
usernane Mar 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions tests/webfiori/framework/test/writers/WebServiceWritterTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ public function test00() {
$this->assertEquals('app\\apis', $writter->getNamespace());
$this->assertEquals('Service', $writter->getSuffix());
$this->assertEquals([
"webfiori\\framework\\EAbstractWebService",
"webfiori\http\AbstractWebService",
"webfiori\http\ParamType",
"webfiori\http\ParamOption",
"webfiori\\http\\RequestMethod"
Expand All @@ -33,7 +33,7 @@ public function test01() {
$this->assertEquals('app\\apis', $writter->getNamespace());
$this->assertEquals('Service', $writter->getSuffix());
$this->assertEquals([
"webfiori\\framework\\EAbstractWebService",
"webfiori\http\AbstractWebService",
"webfiori\http\ParamType",
"webfiori\http\ParamOption",
"webfiori\\http\\RequestMethod"
Expand Down Expand Up @@ -61,7 +61,7 @@ public function test02() {
$this->assertEquals('app\\apis', $writter->getNamespace());
$this->assertEquals('Service', $writter->getSuffix());
$this->assertEquals([
"webfiori\\framework\\EAbstractWebService",
"webfiori\http\AbstractWebService",
"webfiori\http\ParamType",
"webfiori\http\ParamOption",
"webfiori\\http\\RequestMethod"
Expand Down
44 changes: 0 additions & 44 deletions webfiori/framework/EAbstractWebService.php
View file
Open in desktop

This file was deleted.

206 changes: 3 additions & 203 deletions webfiori/framework/ExtendedWebServicesManager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,8 @@
* parameter 'lang'.
*
* @author Ibrahim
*
* @version 1.0.2
*/
abstract class ExtendedWebServicesManager extends WebServicesManager {
/**
* A constant that represents error message type.
*
* @since 1.0.2
*/
private static $E = 'error';
private $translation;
/**
* Creates new instance of 'API'.
Expand Down Expand Up @@ -69,74 +61,6 @@ public function __construct(string $version = '1.0.0') {
]);
}
}
/**
* Sends a response message to indicate that an action is not implemented.
*
* This method will send back a JSON string in the following format:
* <p>
* {<br/>
* &nbsp;&nbsp;"message":"Action not implemented.",<br/>
* &nbsp;&nbsp;"type":"error",<br/>
* }
* </p>
* In addition to the message, The response will sent HTTP code 404 - Not Found.
* Note that the content of the field "message" might differ. It depends on
* the language. If no language is selected or language is not supported,
* The language that will be used is the language that was set as default
* language in the class 'SiteConfig'.
*
* @since 1.0
*/
public function actionNotImpl() {
$message = $this->get('general/action-not-impl');
$this->sendResponse($message, self::$E, 404);
}
/**
* Sends a response message to indicate that an action is not supported by the API.
*
* This method will send back a JSON string in the following format:
* <p>
* {<br/>
* &nbsp;&nbsp;"message":"Action not supported",<br/>
* &nbsp;&nbsp;"type":"error"<br/>
* }
* </p>
* In addition to the message, The response will sent HTTP code 404 - Not Found.
* Note that the content of the field "message" might differ. It depends on
* the language. If no language is selected or language is not supported,
* The language that will be used is the language that was set as default
* language in the class 'SiteConfig'.
*
* @since 1.0
*/
public function actionNotSupported() {
$message = $this->get('general/action-not-supported');
$this->sendResponse($message, self::$E, 404);
}
/**
* Sends a response message to indicate that request content type is
* not supported by the API.
*
* This method will send back a JSON string in the following format:
* <p>
* {<br/>
* &nbsp;&nbsp;"message":"Content type not supported.",<br/>
* &nbsp;&nbsp;"type":"error",<br/>
* &nbsp;&nbsp;"request-content-type":"content_type"<br/>
* }
* </p>
* In addition to the message, The response will sent HTTP code 404 - Not Found.
* Note that the content of the field "message" might differ. It depends on
* the language. If no language is selected or language is not supported,
* The language that will be used is the language that was set as default
* language in the class 'SiteConfig'.
*
* @since 1.1
*/
public function contentTypeNotSupported(string $cType = '') {
$message = $this->get('general/content-not-supported');
$this->sendResponse($message, self::$E, 404,'"request-content-type":"'.$cType.'"');
}
/**
* Creates a sub array to define language variables.
*
Expand Down Expand Up @@ -191,9 +115,9 @@ public function databaseErr($info = '') {
if (defined('WF_VERBOSE') && WF_VERBOSE === true) {
$json->add('query', $info->getLastQuery());
}
$this->sendResponse($message, self::$E, 404, $json);
$this->sendResponse($message, self::E, 404, $json);
} else {
$this->sendResponse($message, self::$E, 404, $info);
$this->sendResponse($message, self::E, 404, $info);
}
}
/**
Expand Down Expand Up @@ -255,112 +179,10 @@ public function getAuthorizationHeader() {
public function getTranslation() {
return $this->translation;
}
/**
* Sends a response message to indicate that a request parameter(s) have invalid values.
*
* This method will send back a JSON string in the following format:
* <p>
* {<br/>
* &nbsp;&nbsp;"message":"The following parameter(s) has invalid values: 'param_1', 'param_2', 'param_n'",<br/>
* &nbsp;&nbsp;"type":"error"<br/>
* }
* </p>
* In addition to the message, The response will sent HTTP code 404 - Not Found.
* Note that the content of the field "message" might differ. It depends on
* the language. If no language is selected or language is not supported,
* The language that will be used is the language that was set as default
* language in the class 'SiteConfig'.
*
* @since 1.3
*/
public function invParams() {
$val = '';
$paramsNamesArr = $this->getInvalidParameters();

if (gettype($paramsNamesArr) == 'array') {
$i = 0;
$count = count($paramsNamesArr);

foreach ($paramsNamesArr as $paramName) {
if ($i + 1 == $count) {
$val .= '\''.$paramName.'\'';
} else {
$val .= '\''.$paramName.'\', ';
}
$i++;
}
}
$message = $this->get('general/inv-params');
$this->sendResponse($message.$val.'.', self::$E, 404);
}
/**
* Sends a response message to indicate that a request parameter or parameters are missing.
*
* This method will send back a JSON string in the following format:
* <p>
* {<br/>
* &nbsp;&nbsp;"message":"The following required parameter(s) where missing from the request body: 'param_1', 'param_2', 'param_n'",<br/>
* &nbsp;&nbsp;"type":"error",<br/>
* }
* </p>
* In addition to the message, The response will sent HTTP code 404 - Not Found.
* Note that the content of the field "message" might differ. It depends on
* the language. If no language is selected or language is not supported,
* The language that will be used is the language that was set as default
* language in the class 'SiteConfig'.
*
* @since 1.3
*/
public function missingParams() {
$val = '';
$paramsNamesArr = $this->getMissingParameters();

if (gettype($paramsNamesArr) == 'array') {
$i = 0;
$count = count($paramsNamesArr);

foreach ($paramsNamesArr as $paramName) {
if ($i + 1 == $count) {
$val .= '\''.$paramName.'\'';
} else {
$val .= '\''.$paramName.'\', ';
}
$i++;
}
}
$message = $this->get('general/missing-params');
$this->sendResponse($message.$val.'.', self::$E, 404);
}
/**
* Sends a response message to indicate that a user is not authorized to
* do an API call.
*
* This method will send back a JSON string in the following format:
* <p>
* {<br/>
* &nbsp;&nbsp;"message":"Not authorized",<br/>
* &nbsp;&nbsp;"type":"error"<br/>
* }
* </p>
* In addition to the message, The response will sent HTTP code 401 - Not Authorized.
* Note that the content of the field "message" might differ. It depends on
* the language. If no language is selected or language is not supported,
* The language that will be used is the language that was set as default
* language in the class 'SiteConfig'.
*
* @since 1.0
*/
public function notAuth() {
$message = $this->get('general/http-codes/401/message');
$this->sendResponse($message, self::$E, 401);
}
/**
* Auto-register services tables which exist on a specific directory.
*
* Note that the statement 'return __NAMESPACE__' should be included at the
* end of service class for auto-register to work. If the statement
* does not exist, the method will assume that the path is the namespace of
* each class. Also, the classes which represents web services must be suffixed
* The classes which represents web services must be suffixed
* with the word 'Service' in order to register them (e.g. RegisterUserService).
*
* @param string $pathToScan A path which is relative to application source
Expand All @@ -376,28 +198,6 @@ public function registerServices($pathToScan) {
$m->addService($ws);
}, 'Service', [$this], [$this]);
}
/**
* Sends a response message to indicate that request method is not supported.
*
* This method will send back a JSON string in the following format:
* <p>
* {<br/>
* &nbsp;&nbsp;"message":"Method Not Allowed.",<br/>
* &nbsp;&nbsp;"type":"error",<br/>
* }
* </p>
* In addition to the message, The response will sent HTTP code 405 - Method Not Allowed.
* Note that the content of the field "message" might differ. It depends on
* the language. If no language is selected or language is not supported,
* The language that will be used is the language that was set as default
* language in the class 'SiteConfig'.
*
* @since 1.0
*/
public function requestMethodNotAllowed() {
$message = $this->get('general/http-codes/405/message');
$this->sendResponse($message, self::$E, 405);
}
/**
* Sets multiple language variables.
*
Expand Down
5 changes: 2 additions & 3 deletions webfiori/framework/writers/WebServiceWriter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
*/
namespace webfiori\framework\writers;

use webfiori\framework\EAbstractWebService;
use webfiori\http\AbstractWebService;
use webfiori\http\ParamOption;
use webfiori\http\ParamType;
Expand Down Expand Up @@ -51,7 +50,7 @@ public function __construct($webServicesObj = null) {
parent::__construct('NewWebService', APP_PATH.'apis', APP_DIR.'\\apis');

$this->setSuffix('Service');
$this->addUseStatement(EAbstractWebService::class);
$this->addUseStatement(AbstractWebService::class);
$this->addUseStatement(ParamType::class);
$this->addUseStatement(ParamOption::class);
$this->addUseStatement(RequestMethod::class);
Expand Down Expand Up @@ -146,7 +145,7 @@ public function writeClassComment() {
}

public function writeClassDeclaration() {
$this->append('class '.$this->getName().' extends EAbstractWebService {');
$this->append('class '.$this->getName().' extends AbstractWebService {');
}
/**
*
Expand Down
Loading