Notice: Trying to access array offset on value of type null in /home/clients/90d1129082b800c0a3d21a4440f50e96/sites/ms-accepteur-sunuphco.phco-preprod.com/app/core/BaseController.php on line 47

Notice: Trying to access array offset on value of type null in /home/clients/90d1129082b800c0a3d21a4440f50e96/sites/ms-accepteur-sunuphco.phco-preprod.com/app/core/BaseController.php on line 47
SunuApi | Docs

2.1.0

Documentation

Last updated: July 18th, 2018

[votre_nom_de_projet]


Sunuframeawork est cadre de travail qui va vous permettre de développer éfficacement et rapidement des applications Web, des Api REST.
Il vous permettra également trés facilement de faire appel à des Webservices REST et SOAP. Il est basé sur le pattern MVC.

app

Ce dossier contiendra toute la logique applicative, à savoir les controlleurs, les modéles et les vues entre autres.

common

Dans ce dossier on retrouvra toutes les méthodes des modéles et de la classe Utils, partagées et accéssibles un peu partout dans l'application.

CommonModel

Ce fichier est un trait qui est utilisé par le BaseModels, les méthodes qu'elle contient sont accéssibles à toutes les classes modéles.

CommonUtils

Ce fichier est un trait qui est utilisé par le Utils, les méthodes qu'elle contient sont accéssibles via la classe static Utils.
NB : la classe Utils étant une classe static, les méthodes qui seront définies dans le trait CommonUtils devront etre des méthodes static.

controllers

Dans ce dossier et ses sous dossiers on retrouvra tous les controleurs.

admin

Ce dossier est un espace de l'application il est prédifini dans le fichier configuration. NB : les classes qui seront définies dans ce dossier devront avoir le namespace suivant : namespace app\controllers\admin;

ErrorController *

Ce fichier est un controlleur servant à la gestion des erreurs.

HomeController

Ce fichier est un controlleur typique, vous pouvez vous y réferrer pour créer vos contolleurs.

LanguageController *

Ce fichier est un controlleur servant à la gestion des multilangues.

WebserviceClientController

Ce fichier est un controlleur qui est spécifiquement utilisé pour faire des appels d'api REST et SOAP.

WebserviceServerController

Ce fichier est un controlleur qui est spécifiquement utilisé pour définir des api REST.

core *

Ce dossier représente le coeur du framework.

services

Ce dossier contient le service de routing du framework.

App

Le fichier App représente le fichier de routing. Il gére les redirections et valide les routes de l'application.
Il permet aussi de définir les constantes propres au framework et celles prédéfinies au niveau du fichier app.config.ini

ApiClient

Ce fichier établie la configuration de base pour l'appel d'api REST.

ApiClientSoap

Ce fichier établie la configuration de base pour l'appel d'api SOAP.

ApiServer

Ce fichier établie la configuration de base pour une implémentation d'api REST.

BaseController

Nous avons ici la classe qui représente la couche métier de base. Elle est la classe parente de tous les controlleurs.
Elle permet de définir des méthodes communes à tous les controlleurs de l'application.

BaseModel

Nous avons ici la classe qui représente la couche d'acces aux données. Elle est la classe parente de tous les modéles.

BaseViews

Cette classe permet de gerer le templating et retourne la vue.

error

Ce fichier représente la vue à retourner pour la gestion des erreurs.

Language

Ce fichier est la classe de base de la configuration des langues et donne accés aux données des fichiers de langue prédéfinis.

message

Ce fichier représente le gestionnaire des messages d'erreur et notifications.

Model

Ce fichier est une classe modéle utilisée par le framework.

Security

Cette classe gérer l'aspect sécuritaire de l'application.

Session

Cette classe gérer la sesssion et permet d'y avoir accés plus facilement.

TokenJWT

Cette classe static est utilisée pour la génération de token JWT (JSON WEB TOKEN).

Utils

Cette classe est un utilitaire regroupant plusieurs méthodes statics utiles

language

Ce doosier regroupe les fichiers des différentes langues de votre application.

fr

Ce fichier est un exemple de fichier de langue sur lequel il faudra se baser pour définir les autres fichiers de langue.

models

Ce dossier va regrouper toutes vos classes modéles.

admin

Ce dossier est un espace de l'application il est prédifini dans le fichier configuration. NB : les classes qui seront définies dans ce dossier devront avoir le namespace suivant : namespace app\models\admin;

HomeModel

Cette classe est un modéle typique, vous pouvez vous y réferrer pour créer vos modéles.

views

Ce dossier regroupe toutes vos vues. Vous avez la liberté de les organiser dans des dossiers et sous dossiers.

admin

Ce dossier est un espace de l'application il est prédifini dans le fichier configuration. NB : Ce dossier devra contenir toutes les vues ainsi que le dossier de templating qu'utilisera l'espace admin.

home

Ce dossier est un modéle typique d'un dossier contenant des vues, vous pouvez vous y réferrer pour créer vos propres dossier de vues.

template

Ce dossier est contient les fichiers de template qu'utilisera l'espace par défaut.

webservice

Dans ce dossier on trouvera les classes qui définissent les services des api.

api

Cette classe est un exemple offrant des services d'api.

assets

Commes son nom l'indique on retrouvera les assets (css, js, plugins) dans ce dossier.

_main_

Ce dossier appartient au framework. Il contient une dependance JS du framework.

main.js *

Ce fichier est la dépendance en question dont je parlais.
C'est un script JS à inclure obligatoirement dans tous les footer de vos templates.

css

Ce dossier va contenir tous vos fichiers CSS

medias

Ce dossier va contenir tous vos fichiers images/vidéos que devra utiliser vos CSS et/ou JS.

js

Ce dossier va contenir tous vos fichiers JS

plugins

Dans ce dossier vous allez regrouper tous les plugins de votre application.

config

Ce dossier est le premier à visiter.
Il va contenir tous les fichiers de configuration de base à effectuer en amont.

htaccess

Ce fichier htacces sert juste à restreindre l'accés à dossier.

app.config.ini

Ce fichier doit etre le premier à etre éditer. On y configure tous les prérequis de l'application.

db.config.ini

Ce fichier doit etre le second à etre éditer. On y configure les accés à la base de données.

DB.mysql.sql

Ce fichier contient le script SQL de base qui sera importé dans votre base de données MYSQL.

DB.sqlite.sql

Ce fichier contient le script SQLITE de base qui sera importé dans votre base de données SQLITE.
La base de données SQLITE sera enrgistré dans le dossier config.
Elle aura le nom de la base de données que vous aviez configurer dans le fichier DB.config.ini

public

Dans ce dossier on mettra toutes ressources publiques propres a votre apllication.

vendor

Ce dossier est créer par composer qui l'utilise pour gérer toutes dépendances installées.

htaccess

Ce fichier doit etre le troiséme à etre éditer. Il est principalement utilisé pour gérer la réécriture d'url.

composer.json

Dans ce on y trouve principalement la liste de toutes les dépendances installées.

composer.lock

Ce fichier est créé et utilisé par composer pour la gestion de nos dépendance.

composer.phar

Ceci est ni plus ni moins que composer.

index

Ce fichier est le point d'entrée du framework.

README

Ceci est juste un fichier qui décrit briévement c'est quoi SunuFramework.