ZnetDK | Fichiers ZnetDK

Le Kit de Développement ZnetDK est livré dans une archive compressée au format ZIP nommée znetdk-<version>.zip où <version> est le numéro de la version téléchargée.

Le détail des fichiers présents dans ce fichier d'archive est affiché ci-dessous.
Cliquez sur le fichier de votre choix pour accéder à sa description (déplier tous les fichiers).

Fichier de configuration du serveur HTTP Apache du répertoire racine de l'application et de sa descendance.
Il interdit la visualisation du contenu du répertoire racine et de ses sous-répertoires.
D'autre par il définit le fichier index.php comme étant le script par défaut à exécuter si l'URL ne précise pas de nom de page à charger.
Il intercepte enfin les erreurs HTTP 403 et 404 et les redirige vers le contrôleur principal de l'application pour affichage de la vue httperror.php (voir rubrique Erreurs HTTP).

index.php

Script principal de l'application destinataire de toutes les requêtes HTTP émises depuis le navigateur de l'utilisateur.
Il active les traductions à appliquer selon la langue d'affichage demandée, charge les paramètres généraux de l'application, démarre la session utilisateur et appelle le contrôleur principal de l'application pour l'affichage du modèle de page (requête GET) ou pour l'exécution des actions demandées par le navigateur internet (requêtes POST).

Répertoire `/applications`

Il contient les applications développées avec ZnetDK.

globalconfig.php

Fichier de configuration applicable à l'ensemble des applications ZnetDK.

Répertoire `/applications/default`

Il contient l'ensemble du code source PHP de l'application par défaut ainsi que l'ensemble des ressources web (styles, images et scripts Javascript) qui lui sont nécessaires.

Répertoire `/applications/default/app`

Il contient les scripts PHP développés spécifiquement pour les besoins de l'application.

.htaccess

Fichier de configuration du serveur HTTP Apache interdisant l'accès au répertoire /applications/default/app et à ses sous-répertoires.

config.php

Fichier de configuration de l'application ZnetDK dont les paramètres sont décrits en détail dans la rubrique Réglages de l'application.
Les paramètres renseignés dans ce fichier surchargent les valeurs par défaut des paramètres de même nom définis dans le fichier /engine/core/config.php.

menu.php

Script PHP de définition des entrées de menu de l'application à travers la classe \app\Menuqui implémente l'interface \iMenu de l'API ZnetDK.

Répertoire `/applications/default/app/controller`

Il contient les scripts PHP des contrôleurs applicatifs développés spécifiquement pour les besoins de l'application et répondant aux actions émises localement par le navigateur internet.
Veuillez vous référer aux rubriques Bien démarrer et 1er Tuto pour disposer d'exemples de développement de contrôleurs applicatifs.
Ce dossier peut également contenir les contrôleurs du noyau dans leur version surchargée au niveau de l'application.

Répertoire `/applications/default/app/email`

Il contient les modèles d'email pour l'envoi de mails à partir du module optionnel zdkmail.
Un modèle d'email est un script PHP appelé par la classe \zdkmail\mod\Email et contenant l'intialisation de ses propriétés subject et message.

Répertoire `/applications/default/app/help`

Il contient les pages d'aide développées spécifiquement pour les besoins de votre application.
Veuillez vous référer à la rubrique Aide en ligne pour ajouter des pages d'aide contextuelle à votre application.

Répertoire `/applications/default/app/lang`

Ce répertoire centralise les fichiers de traduction de l'application.
Les fichiers qu'il contient surchargent ou complètent les traductions livrées en standard dans le répertoire /engine/core/lang.

L'affichage d'une application en plusieurs langues différentes nécessite un paramètrage préalable décrit à la rubrique Gestion multilingue.

locale_en.php

Script PHP des traductions anglaises spécifiques à l'application.

locale_es.php

Script PHP des traductions espagnoles spécifiques à l'application.

locale_fr.php

Script PHP des traductions françaises spécifiques à l'application.

Répertoire `/applications/default/app/layout`

Répertoire des modèles de page développés spécifiquement pour l'application.
Veuillez vous référer à la rubrique Modèle de page pour en savoir davantage.

Répertoire `/applications/default/app/model`

Répertoire d'accueil des scripts PHP de définition des objets DAO ajoutés à l'application pour consulter et modifier les données de l'application.
Veuillez vous référer aux rubriques Bien démarrer et 1er Tuto pour disposer d'exemples de développement d'objets DAO.

Répertoire `/applications/default/app/validator`

Il contient les classes de validation des données développées pour répondre au besoin des contrôleurs de l'application de valider les données transmises par l'utilisateur.
Veuillez vous référer à la classe \Validator pour en savoir davantage.

Répertoire `/applications/default/app/view`

Scripts PHP des vues développées spécifiquement pour répondre aux besoins métier de l'application.

Répertoire `/applications/default/documents`

Il contient les fichiers téléchargés et téléchargeables de l'application.
L'accès à ce répertoire est privé et les fichiers qu'il contient sont ajoutés ou lus à travers l'action download des contrôleurs applicatifs développés spécifiquement pour les besoins de l'application.
Le chemin absolu de ce répertoire correspond à celui renseigné pour le paramètre CFG_DOCUMENTS_DIR.

.htaccess

Fichier de configuration du serveur HTTP Apache interdisant l'accès au répertoire /applications/default/documents et à ses sous-répertoires.

Répertoire `/applications/default/public`

Ce répertoire accueille les styles, images et scripts javascript exposés publiquement par l'application par défaut.

Répertoire `/applications/default/public/css`

Contient les feuilles de styles développées spécifiquement pour l'application par défaut.

myapp.css

Styles spécifiques à l'application développée et destinés à surcharger les styles appliqués en standard au modèle de page.

Répertoire `/applications/default/public/images`

Images répondant spécifiquement aux besoins de l'application et destinées à être affichées telles que des logos, icônes, images d'illustration...

Répertoire `/applications/default/public/js`

Scripts Javascript développés spécifiquement pour les besoins de l'application.

Répertoire `/applications/default/public/themes`

Contient le ou les thèmes de composants jQueryUI créés spécifiquement avec le Themeroller pour personnaliser l'apparence de l'application.

Répertoire `/engine`

Répertoire contenant les scripts et ressources web du moteur d'applications ZnetDK. Le contenu de ce répertoire ne doit pas être modifié en dehors de toute mise à jour de ZnetDK.

Répertoire `/engine/core`

Ce répertoire contient les scripts PHP fournissant le coeur des fonctionnalités et services de ZnetDK.
Ces scripts ne doivent pas être modifiés car toutes modifications seraient perdues lors de l'installation de toute nouvelle version de ZnetDK.

.htaccess

Fichier de configuration du serveur HTTP Apache interdisant l'accès au répertoire /engine/core et à ses sous-répertoires.

appcontroller.php

Classe abstraite à partir de laquelle dérivent les contrôleurs applicatifs créés pour les besoins spécifiques de l'application (voir classe \AppController).

config.php

Fichier de configuration par défaut de l'application ZnetDK dont les paramètres sont décrits en détail dans la rubrique Réglages de l'application.

convert.php

Classe utilitaire de conversion de données.

dao.php

Classe abstraite d'interrogation et de mise à jour des données de tables dans la base de données MySQL.
Tout accès à la base de données est effectué par l'intermédiaire de classes dérivées de cette classe abstraite (voir classe \DAO).

database.php

Fournit aux objets de type \DAO, une connexion à la base de données MySQL de l'application ou du noyau ZnetDK.

dependencies.php

Ajoute de manière dynamqiue au modèle de page de l'application, les dépendances CSS et JavaScript nécessaires à son fonctionnement.

errorhandler.php

Intercepte les erreurs PHP générées à l'exécution de l'application, les consigne dans le journal des erreurs errors.log et dans le cas d'une requête HTTP de type POST, retourne une erreur HTTP 500.

general.php

Classe utilitaire de l'application (voir classe \General).

imenu.php

Classe d'interface de la classe Menu implémentée dans le script menu.php (voir classe \iMenu).

layout.php

Contrôleur d'affichage invoqué par le contrôleur principal.

maincontroller.php

Contrôleur principal de l'application en charge d'aiguiller les requêtes HTTP GET et POST reçues vers les contrôleurs secondaires correspondant.

menumanager.php

Classe d'accès aux entrées de menu définies pour naviguer dans l'application (voir classe \MenuManager).
Cette classe interroge la classe \app\Menu définie dans le script /applications/default/app/menu.php pour obtenir les détails du menu paramétré spécifiquement pour l'application.

menurenderer.php

Assure l'affichage HTML du menu de navigation de l'application en fonction du modèle de page de l'application, lors de l'appel de la méthode Layout::renderNavigationMenu.

parameters.php

Objet dédié à la lecture et à la validation des paramètres renseignés dans le fichier config.php du noyau ou de l'application.

profilemanager.php

Objet centralisant tous les services d'accès en base de données aux profils utilisateur paramétrés pour l'application.
Cet objet est principalement appelé par les actions du contrôleur profiles.php.

request.php

Contient la définition de la classe \Request d'accès aux données de la requête HTTP émise par le navigateur internet de l'utilisateur.

response.php

Définition de la classe \Response fournissant les données ou vues de l'application en fonction de la requête HTTP reçue.

usermanager.php

Objet centralisant tous les services d'accès en base de données aux utilisateurs paramétrés pour l'application.
Cet objet est principalement appelé par les actions du contrôleur users.php.

usersession.php

Classe \UserSession d'accès aux données de l'utilisateur stockées en session.

validator.php

Classe \Validator de validation des données POST transmises en HTTP au contrôleur applicatif.

version.php

Initialise la constante ZNETDK_VERSION de la version courante de ZnetDK.

zdkexception.php

Classe dérivée de la classe PHP \Exception et instanciée par ZnetDK pour lever des exceptions en réponse aux erreurs détectées par le noyau.

Répertoire `/engine/core/api`

Ce répertoire isole dans l'espace de nom \api les classes ZnetDK pouvant être en conflit avec des classes standards PHP lorsqu'elles sont déclarées sur l'espace de nom racine.

locale.php

Ce script contient la classe d'accès aux données de localisation de l'application.
Cette classe est placée dans l'espace de nom \api pour ne pas être en conflit avec la classe PHP de même nom accessible depuis l'espace de nom racine et déclarée dans l'extension PHP intl.

Répertoire `/engine/core/controller`

Il contient les contrôleurs applicatifs dédiés à l'authentification et l'habilitation des utilisateurs de l'application.

profiles.php

Contrôleur de traitement des actions destinées à la gestion des profils utilisateurs.
Ce contrôleur peut être surchargé en créant un contrôleur de même nom dans le dossier /applications/default/app/controller et en redéfinissant les actions souhaitées.

security.php

Contrôleur secondaire destiné à traiter les demandes d'authentification des utilisateurs de l'application.
Ce contrôleur peut être surchargé en créant un contrôleur de même nom dans le dossier /applications/default/app/controller et en redéfinissant les actions souhaitées.

users.php

Contrôleur de traitement des actions destinées à la gestion des utilisateurs de l'application.
Ce contrôleur peut être surchargé en créant un contrôleur de même nom dans le dossier /applications/default/app/controller et en redéfinissant les actions souhaitées.

Répertoire `/engine/core/help`

Aide en ligne contextuelle des vues standards ZnetDK d'administration des utilisateurs et des profils utilisateur.

profiles_en.php

Aide en ligne en Anglais de la vue de définition des profils utilisateur.

profiles_es.php

Aide en ligne en Espagnol de la vue de définition des profils utilisateur.

profiles_fr.php

Aide en ligne en Français de la vue de définition des profils utilisateur.

users_en.php

Aide en ligne en Anglais de la vue d'habilitation des utilisateurs de l'application.

users_es.php

Aide en ligne en Espagnol de la vue d'habilitation des utilisateurs de l'application.

users_fr.php

Aide en ligne en Français de la vue d'habilitation des utilisateurs de l'application.

Répertoire `/engine/core/lang`

Fichiers de traduction de l'application. En standard, les traductions livrées sont celles des langues française, anglaise et espagnole.

locale_en.php

Script PHP des traductions anglaises des fonctionnalités génériques de l'application.

locale_es.php

Script PHP des traductions espagnoles des fonctionnalités génériques de l'application.

locale_fr.php

Script PHP des traductions françaises des fonctionnalités génériques de l'application.

Répertoire `/engine/core/layout`

classic.php

Modèle de page de l'application actif par défaut à l'installation de ZnetDK. Il intègre un menu de navigation hiérarchique à 2 niveaux de type onglets et de larges entête et pied de page (voir le modèle de page classic).

custom.php

Modèle de page de l'application dont les styles d'affichage sont destinés à être personnalisés. Il dispose d'un entête, d'un pied de page et d'un menu multi-niveaux permettant par exemple d'afficher un menu déroulant horizontal (voir le modèle de page personnalisable).

languages-layout.php

Fragment de modèle de page affichant le composant de sélection d'une langue parmi celles paramétrées pour l'application.

office.php

Autre modèle de page de l'application qui se caractérise par un menu vertical hiérarchique multi-niveaux de type déroulant, dont l'entête est de hauteur réduite pour offrir le plus d'espace de travail possible et qui affiche les vues dans des fenêtres redimensionnables et repositionnables (voir le modèle de page office).

Répertoire `/engine/core/model`

Il accueille les scripts PHP destinés à fournir les données techniques de l'application telles que les habilitations, les entrées de menu de navigation, les données transmises par les requêtes HTTP...

profilemenus.php

Classe DAO destinée à fournir les entrées de menu auxquelles l'utilisateur peut accéder lorsqu'il dispose d'un profil donné.

profiles.php

Classe DAO destinée à fournir les profils utilisateurs paramétrés pour l'application.

usermenus.php

Classe DAO destinée à fournir les entrées de menu de navigation auxquelles l'utilisateur connecté est habilité à accéder.

userprofiles.php

Classe DAO destinée à fournir les profils de l'utilisateur connecté.

users.php

Classe DAO destinée à accéder en base de données aux caractéristiques des utilisateurs de l'application.

Répertoire `/engine/core/validator`

authentication.php

Classe de validation des données d'authentification des utilisateurs de l'application.

password.php

Classe de validation des mots de passe saisis à la création de l'utilisateur ou au changement du mot de passe.

user.php

Classe de validation des données de l'utilisateur à sa création ou modification.

Répertoire `/engine/core/view`

Ce répertoire contient les modèles et fragments de page livrés en standard avec ZnetDK ainsi que les vues d'administration des utilisateurs et profils de l'application.

check_connection.php

Vue affichée en page d'accueil de l'application de démarrage livée en standard avec ZnetDK.
Elle permet en particulier de vérifier que la connexion à la base de données MySQL est opérationnelle.

check_widgets.php

Vue de l'onglet Exemple de l'application de démarrage livrée en standard avec ZnetDK.
Elle permet de notamment de vérifier que les widgets PrimeUI sont correctement initialisés.

httperror.php

Vue standard d'affichage des erreurs HTTP 403 et 404.
Cette vue peut être surchagée pour être personnalisée (voir la rubrique Erreurs HTTP).

profiles.php

Vue d'affichage des profils utilisateurs en tableau et dans le formulaire d'ajout et de modification.

profiles-ui-events.php

Script de traitement des évènements Javascript des composants graphiques de la vue de gestion des profils utilisateurs.

profiles-ui-init.php

Script d'initialisation des composants graphiques de la vue de gestion des profils utilisateurs.

try_themes.php

Vue d'affichage des thèmes de composants PrimeUI correspondant à l'onglet Thèmes de l'application de démarrage livée en standard avec ZnetDK.
Cette vue est notamment destinée à tester l'affichage des différents thèmes de composants afin de choisir celui à appliquer à l'application de démarrage.

Kit de Développement Logiciel Open Source

Développement simple, rapide et gratuit d'applications internet d'entreprise en PHP