Version 1.0.0 - 2006/01/31
Index  ::  Hiérarchie  ::  Constantes

Classe NoasUserInterface

NoasObject
   |
   --NoasUserInterface
 
   Classe principale de la couche présentation et d’interaction. Il s'agit de loin de la classe la plus critique du framework. En véritable chef d'orchestre, elle est au cœur de la stratégie visuelle de vos applications. Avec une bonne maîtrise de ces fonctionnalités, vous serez capable d'obtenir l'application conforme à votre cahier des charges avec un effort minimal. 

NoasUserInterface::debug : Fonctionnement en mode débug.

   Fonctionnement en mode débug. Quand ce mode est activé, le moteur compile la template à chaque nouvelle requête. La navigation se voit donc ralenti (pas forcément visible avec une configuration moderne) mais toutes vos modifications sont immédiatement pris en compte. 

NoasUserInterface::design : Fonctionnement en conception.

   Fonctionnement en conception. Quand ce mode est activé, le moteur ne compile la template que si elle a été modifiée ou n'existe pas. Préférez lui le mode débug si vous modifier régulièrement des templates inclus en statique, car ces dernières n'active pas la compilation (pour la simple et bonne raison qu'une fois compilées, l'interface ne peut pas retrouver les inclusions statiques) 

NoasUserInterface::release : Fonctionnement en production.

   Fonctionnement en production. Quand ce mode est activé, le moteur ne compile la template qu'une seule fois (si le fichier résultat n'existe pas). 

 

Constructeur NoasUserInterface($mode)

Argument(s):

 

void NoasUserInterface::display($template, $page, $mode)

Argument(s):
   Afficher une page. La stratégie d'affichage par défaut utilisé sera celui de l'interface si l'argument $mode est NULL. 

 

void NoasUserInterface::displayInCache($template, $page, $expire)

Argument(s):
   Afficher une page en utilisant le processus de cache. Si vous développer une application de type documentaire grand publique ( trafique important) et que vous souhaitez limiter les accès en bases et augmenter les performances, vous avez tout intérêt à mettre en place une bonne stratégie de mise en cache des pages de votre projet. Rassurer vous, vous n'aurez rien à développer de spécifique. Le framework dispose de son propre mécanisme de mise en cache. Mais il faut juste développer en en tenant compte. 

 

string NoasUserInterface::encodeCachePageName($page)

Argument(s):
Retour:
   Encoder le chemein d'une page de cache. 

 

string NoasUserInterface::encodeFilePageName($page)

Argument(s):
Retour:
   Encoder le chemin d'une page. Lorsqu'une template est compilée, il faut déterminer où placer la page résultante. Le nom ne cette page ne peut pas être pris au hasard car elle est relative à un répertoire spécifique de Noas PHP. Il faut donc construire un chemin de fichier avec des discriminants. Les plus utilisés sont le nom de l'application et le local choisis. Le framework vous donne la possibilité le modifier en surchargeant cette méthode. 

 

void NoasUserInterface::generate($template, $result, [$header = ""], [$footer = ""])

Argument(s):
   Générer un fichier de template. Il peut arriver que vous souhaitiez générer un fichier suivant un model prédéfini. Si la structure est complexe, vous gagnerez à utiliser une template Noas PHP. Vous bénéficierez de toute la puissance du moteur de template. Il vous suffira d'utiliser cette méthode. 

 

string NoasUserInterface::getDateFormat()

Retour:
   Obtenir le format de date. 

 

string NoasUserInterface::getErrorResource($key)

Argument(s):
Retour:
   Obtenir un message d'erreur. 

 

NoasTransform NoasUserInterface::getFilter()

Retour:
   Obtenir le filtre des templates compilées. 

 

string NoasUserInterface::getGuiResource($key)

Argument(s):
Retour:
   Obtenir un libellé internationalisé. 

 

string NoasUserInterface::getLocale()

Retour:
   Obtenir le local de la session. 

 

string NoasUserInterface::getMessageResource($key)

Argument(s):
Retour:
   Obtenir un message. 

 

int NoasUserInterface::getMode()

Retour:
   Obtenir le mode de fonctionnement du moteur. 

 

string NoasUserInterface::getResourceDirectory()

Retour:
   Obtenir le répertoire de ressource (dépendant du local). 

 

void NoasUserInterface::includeTemplate($template, $result, $mode)

Argument(s):
   Inclure une template ( avec compilation implicite ) dans le flux courant. 

 

void NoasUserInterface::loadErrorResource($errorResourceFile)

Argument(s):
   Charger les messages d'erreurs. 

 

void NoasUserInterface::loadGuiResource($guiResourceFile)

Argument(s):
   Charger les libellés d'internationalisation (GUI) 

 

void NoasUserInterface::loadMessageResource($messageResourceFile)

Argument(s):
   Charger les messages. 

 

void NoasUserInterface::loadResource($resourceBase, $locale)

Argument(s):
   Charger les ressources pour une mise à disposition immédiate ou différée. 

 

void NoasUserInterface::setDateFormat($format)

Argument(s):
   Définir le format de date. 

 

void NoasUserInterface::setFilter($filter)

Argument(s):
   Définir le filtre des templates compilées. 

 

void NoasUserInterface::setLocale($locale)

Argument(s):
   Définir le local pour la session. 

 

void NoasUserInterface::setMode($mode)

Argument(s):
   Définir le mode de fonctionnement de compilation. l'un des valeurs suivantes:NoasUserInterface::releaseNoasUserInterface::designNoasUserInterface::debug 

 

string NoasUserInterface::toErrorMessage($key, $params)

Argument(s):
Retour:
   Conversion d'un message d'erreur (avec formatage optionnel). Les messages d'erreur ne sont pas transportés avec toutes leurs informations textuelles. ne fusse que pour des problèmes de taille. Seule leur forme minimale est sauvegardée tant qu'ils ne sont pas utilisés. C'est à l'interface de fournir sa forme normale déduite de sa forme minimale grâce à cette méthode. Note : Si le message possède le paramètre NOAS_EXCHANGE_ERROR, l’interface va essayer de récupérer le libellé associé à la clef pour définir la valeur du paramètre NOAS_EXCHANGE_CODE. Vous pourrez ainsi user de cette variable dans ce message. Noter que lorsqu’une erreur intervient sur tague EXCHANGE, un message d’erreur est renvoyé automatiquement avec $key égale au code de la propriété et NOAS_EXCHANGE_ERROR égale au type d’erreur. Vous avez donc intérêt à définir dans le fichier de ressource GUI et à ajouter les messages d’erreur, relative à EXCHANGE, dans votre fichier de ressource d’erreur. Le même principe est appliqué pour les champs HTML, à la différence que seul le paramètre NOAS_INPUT_ERROR ou NOAS_UPLOAD_ERROR 

 

string NoasUserInterface::toInfoMessage($key, $params)

Argument(s):
Retour:
   Traduction d'un message d'information (avec formatage optionnel). Les messages d'information ne sont pas transportés avec toutes leurs informations textuelles. ne fusse que pour des problèmes de taille. Seule leur forme minimale est sauvegardée tant qu'ils ne sont pas utilisés. C'est à l'interface de fournir sa forme normale déduite de sa forme minimale grâce à cette méthode. 

 

© 2005 Réoka Djohou, tous droits réservés.