WikiMiNET

La documentation technique et administrative

Outils pour utilisateurs

Outils du site


wiki:services:le_site:le_framework

Le framework

Abstract

Dans le cadre du site web de minet, un petit framework legé à été developpé dans le but de simplifier le developpement sans obligé les debutants à apprendre de nombreuses notions.

L'arborescence

  • Engine : le coeur du FrameWork maison
    • loader.php : Le loader à inclure pour utiliser le frameWork
    • *.php : les differentes class du frameWork
  • js : l'ensemble des scripts utilisé par le site
    • lib : les differentes librairies client (jquery, etc…) géré par bower
    • *.js : nos propres fichiers js
  • lang : dossier de stockage (temporaire ?) des textes du site au format json
    • fr
    • en
    • es
  • less : l'ensemble de nos fichiers less (futur public/css)
    • lib : libraire maison (contenant les elements visuel de base du site)
      • minet.less : loader de nos popres fichier less
    • *.less
  • public : dossier public (à lier à apache) visible par le client
    • js : scripts clients généré autoamtiquement par grunt
    • img : images du site
    • css : styles généré automatiquement par grunt
    • **/*.php : fichier php servis au client
  • views : dossier comprenant les “vue” twig
    • lib : templates maison spécialements conçus pour MiNET
    • *.twig : fichier de rendu de vue
  • vendor : modules php (twig,intl,etc..) non “gité”
  • node_modules : modules node (grunt…) non “gité”
  • .gitignore
  • .bowerrc : conf de bower
  • bower.json : Libraires javascript à charger via bower
  • composer.json : Modules PHP à charger via composer
  • Gruntfile.js : descriptions des tâches gruntk
  • package.json : gestion des dependances node (tâches grunt !)
  • composer.lock
  • README

Un monde d'objets

Render($view)

Render est un object qui gère pour vous, les langues, ainsi que les vues à rendre.

  • $view : {String} le nom de la vue que vous allez rendre
  • Lang : (voir objet suivant dans la doc)
  • Compile($components, $optsViews) : retourne le html de votre pages
    • $components : {Array} composants du template
    • $optsViews : {Array} composants de la vue

Exemple d'utilisation :

<?php
require_once __DIR__ . '/../Engine/loader.php';
 
$render = new Render("index");
 
echo $render->compile(Array('header','footer'), Array('index'));

Render cherche actuellement la vue dans ./views/NomDeLaVue.twig.

Les fichiers de langue sont (temporairement) stocké sous forme de json dans lang/LaLangueDeLuser/NomDeLaVue.json

wiki/services/le_site/le_framework.txt · Dernière modification: 2020/06/27 18:16 (modification externe)