mezon/ajax-application

Simple class for creating ajax applications

1.0.1 2021-10-12 17:57 UTC

Requires

• php: >=7.2.0
• mezon/application: 3.0.*

Requires (Dev)

• phpunit/php-token-stream: 3.1.2
• phpunit/phpunit: ^8.5

MIT

• Dodonov Alexey

README

Intro

Mezon Framework provides simple class for creating ajax applications. This class uses all functionality of the Mezon Application Class also provides usefull functionality:

• automatic creation of the routes '{RouteName}' from methods like 'action{RouteName}';
• routes setup from config.
• action messaging.

Installation

Just print in console

composer require mezon/ajax-application

And that's all )

Learn more

More information can be found here:

• Mezon Framework
• Twitter
• Dev.to
• Medium

It will be great if you will contribute something to this project. Documentation, sharing the project in your social media, bug fixing, refactoring, or even submitting issue with question or feature request. Thanks anyway ) I'll be very glad if you'll press "STAR" button )

Exception handling

For better debugging exception handling is performed in a special way. If the ajax request will be failed to process, then on the front end you will get JSON object with fields:

• code - code of the occured error;
• message - textual description of the occured error;
• call_stack - call stack for the call wich lead to the error.

Finishing request processing

After finishing request processing you can mark it as successfull:

function ajaxRequestSuccess(): void

Wich will return {"code": 0}

Or return any other result:

function ajaxRequestResult($result): void

In this case $result will be encoded in JSON and outputted.

Or in case of the error you can call

function ajaxRequestError(string $message, int $code = - 1): void

Wich will return object {"code": $code, "message": "message"}