Aller au contenu principal
Version: 4.x

📦 Bow Package

Introduction​

Ce système permet d'étendre votre application, de gréffer des package externe dans une application Bow.

Création de plugin​

Si vous avez une application Bow, il vous suffit de faire la création via php bow et lancer la commande add:configuration ensuite vous donnez le nom de votre configuration:

php bow add:configuration PluginConfiguration

Le fichier PluginConfiguration.php sera créé dans le dossier app/Configuration qui contient deux méthode create et run.

  • create permet d'initialiser le package
  • run permet de lancer d'initialisation le package.

Dans l'initialisation des packages c'est la methode create qui ce lancera avant pour tous le autre packages qui seront defini au dessus dans votre configuration ensuite la methode run sera sera dans le meme orde.

N'Essayez pas de contacter un package ici si vous attendez qu'il soit dabort configurer.

Dans le fichier de configuration, Bow va injecté le DIC et sera accéssible via la proprété $this->container. Plus d'information sur le DIC de Bow.

Exemple de création​

Vous allons faire un plugin aui va vérifier un email, alors on crée la configuration avec le nom EmailCheckerConfiguration:

Notez que c'est un exemple pour vous montrez comment vous ici prendre, cet exemple dans un vrai projet aurai pu ĂŞtre traiter autrement.

php bow add:configuration EmailCheckerConfiguration

Dans le dossier app nous allons ajouter un dossier Packages dans ce dossier, nous allons encore ajouter le fichier EmailCheckController.php:

namespace App\Packages;

use Bow\Http\Request;
use Bow\Support\Str;

class EmailCheckController
{
/**
* Check the email
*
* @param Request $request
* @return mixed
*/
public function __invoke(Request $request)
{
$email = $request->get('email');

if (Str::isMail($email)) {
$response = [
'message' => 'Ok',
'error' => false
];
} else {
$response = [
'message' => 'C\'est un mauvais email !',
'error' => true
];
}

return $response;
}
}

Vous allons maintenant créer note configuration:

namespace App\Configurations;

use Bow\Configuration\Loader;
use Bow\Configuration\Configuration;

class EmailCheckController extends Configuration
{
/**
* Permet de lancement de configuration
*
* @return void
*/
public function run()
{
$this->container->make('app')->post(
'/email/checker', \App\Packages\EmailCheckController::class
);
}
}

Allons tester notre application Bow Framework avec la commande php bow run:server pour lancer le serveur de développement.

Testons notre package​

Pour cette exemple nous allons texter node code avec curl:

curl -X POST -d "email=exemple@exemple.com" http://localhost:5000/email/checker
# {"message": "Ok", "error": false}

Il manque quelque chose ?

Si vous rencontrez des problèmes avec la documentation ou si vous avez des suggestions pour améliorer la documentation ou le projet en général, veuillez déposer une issue pour nous, ou envoyer un tweet mentionnant le compte Twitter @bowframework ou sur directement sur le github.