Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
94 lines (68 sloc) 5 KB

Starterkit module

GitHub GitHub tag PHP from Packagist GitHub code size in bytes

Pour démarrer un module Soosyze avec une base de code standard.

Sommaire

Fonctionnalités

Routes et contrôleurs

Il s'agit d'une base de travail CRUD (Create/Read/Update/Delete). Il est conseillé, mais pas obligatoire de suivre les mêmes routes et méthodes.

Route Méthode HTTP* Contrôleurs@methode Fonction
starterkit/index GET Starterkit@index Page d'accueil du module.
admin/starterkit GET Starterkit@admin Page d'administration du module.
starterkit/:id GET Starterkit@show Page de contenu.
starterkit/item GET Starterkit@create Formulaire de création du module.
starterkit/item POST Starterkit@store Fonction de validation et d'ajout du module.
starterkit/:id/edit GET Starterkit@edit Formulaire d'édition de votre module.
starterkit/:id/edit POST Starterkit@update Fonction de validation et modification du module.
starterkit/:id/delete POST Starterkit@delete Fonction de validation et suppression du module.

*Vous pouvez utiliser les méthodes HTTP que vous souhaitez, mais seules les actions GET et POST sont fonctionnelles avec les formulaires PHP.

Services

  • starterkit une base de service simple avec comme dépendance le service query pour créer des requêtes.
  • starterkit.hook une base de service pour vos hooks avec comme dépendances les services schema et query. Il vous permet d'interagir avec les autres modules appelant des hooks.
  • starterkit.install pour les appels aux hooks install.user (pour les permissions utilisateurs) et install.menu (pour les liens dans le menu).

Installateur

La classe d'installateur est un service pour créer vos tables en base et insérer vos données. Il implémente le hook install.user pour les permissions utilisateurs.

Nom des permissions Utilisateurs autorisés
starterkit.index Utilisateurs non connectés, connectés et administrateurs
starterkit.admin Administrateurs
starterkit.show Utilisateurs non connectés, connectés et administrateurs
starterkit.create Administrateurs
starterkit.store Administrateurs
starterkit.edit Administrateurs
starterkit.update Administrateurs
starterkit.delete Administrateurs

Il implémente également le hook install.menu pour créer un lien dans le menu principal et d'administration.

Vues

Le module est fournit avec 4 vues de base :

  • form-starterkit-create.php pour le formulaire de création,
  • form-starterkit-edit.php pour le formulaire d'édition,
  • page-starterkit-admin.php pour votre page d'administration,
  • page-starterkit-index.php pour votre page d'accueil,
  • page-starterkit-show.php pour voir du contenu.

Requirements

Starterkit module supporte jusqu'à présent toutes les versions de Soosyze CMS.

Version PHP

Version PHP Starterkit module 1.x
<= 5.3 ✗ Non supporté
5.4 / 5.5 / 5.6 ✓ Supporté
7.0 / 7.1 / 7.2 / 7.3.0RC3 ✓ Supporté

Installation

Soosyze CMS

Après l'installation de Soosyze CMS sur votre serveur web (distant ou local) vous devez :

  • Télécharger l'archive du dépôt,
  • Décompresser l'archive avec dans un dossier nommé Starterkit,
  • Placer le dossier Starterkit dans le répertoire app/modules de Soosyze CMS.
  • Ouvrer un navigateur web, rendez-vous à l'adresse de votre site web et connectez-vous,
  • Vous rendre dans la page Module, sélectionner le module Starterkit et cliquer sur Enregister.

License

Starterkit module est sous licence MIT. Voir le fichier de licence pour plus d'informations.

You can’t perform that action at this time.