En utilisant les conventions CakePHP dans le nommage des différentes parties de votre application, vous gagnerez des fonctionnalités sans les tracas et les affres de la configuration. Voici un exemple récapitulant les conventions abordées :

    Nom de la table de la base de données: “articles”
    Classe Table: ArticlesTable se trouvant dans src/Model/Table/ArticlesTable.php
    Classe Entity: Article se trouvant dans src/Model/Entity/Article.php
    Classe Controller: ArticlesController se trouvant dans src/Controller/ArticlesController.php
    Template de View se trouvant dans src/Template/Articles/index.ctp

En utilisant ces conventions, CakePHP sait qu’une requête de type http://exemple.com/articles/ sera liée à un appel à la fonction index() du Controller ArticlesController, dans lequel le model Articles est automatiquement disponible (et automatiquement lié à la table ‘articles’ dans la base) et rendue dans un fichier. Aucune de ces relations n’a été configurée par rien d’autre que la création des classes et des fichiers dont vous aviez besoin de toute façon.

Controleurs

noms des classes de controller sont au pluriel, en CamelCase et se terminent par Controller. UsersController et ArticleCategoriesController sont des exemples respectant cette convention

les méthodes publiques des controllers sont souvent exposées comme des ‘actions’ accessibles via un navigateur web. Par exemple /users/view correspond à la méthode view() de UsersController sans rien modifier. Les méthodes privées ou protégées ne sont pas accessibles avec le routing

UsersController (qui serait défini dans le nom de fichier UsersController.php) est accessible à l’adresse http://exemple.com/users.

/article-categories/view-all est la bonne forme pour accéder à l’action ArticleCategoriesController::viewAll()

Quand vous créez des liens en utilisant this->Html->link(), vous pouvez utiliser les conventions suivantes pour le tableau d’url:

$this->Html->link('link-title', [
    'prefix' => 'MyPrefix' // CamelCased
    'plugin' => 'MyPlugin', // CamelCased
    'controller' => 'ControllerName', // CamelCased
    'action' => 'actionName' // camelBacked
]

Fichiers et noms de Classe

En général, les noms de fichiers correspondent aux noms des classes et suivent les standards PSR-0 et PSR-4 pour l’autoloading (chargement automatique).
Voici quelques exemples de noms de classes et de fichiers:

    La classe controller LatestArticlesController devra se trouver dans un fichier nommé LatestArticlesController.php.
    La classe Component (Composant) MyHandyComponent devra se trouver dans un fichier nommé MyHandyComponent.php.
    La classe Table OptionValuesTable devra se trouver dans un fichier nommé OptionValuesTable.php.
    La classe Entity OptionValue devra se trouver dans un fichier nommé OptionValue.php.
    La classe Behavior (Comportement) EspeciallyFunkableBehavior devra se trouver dans un fichier nommé EspeciallyFunkableBehavior.php.
    La classe View (Vue) SuperSimpleView devra se trouver dans un fichier nommé SuperSimpleView.ctp.
    La classe Helper (Assistant) BestEverHelper devra se trouver dans un fichier nommé BestEverHelper.php.

Chaque fichier sera situé dans le répertoire/namespace approprié dans le dossier de votre application.

Modèles et Bases de Données

Les noms de classe de model sont au pluriel, en CamelCase et finissent par Table. UsersTable, ArticleCategoriesTable et UserFavoritePagesTable en sont des exemples.

Les noms de tables correspondant aux models CakePHP sont au pluriel et utilisent le caractère souligné (underscore). Les tables correspondantes aux models mentionnés ci-dessus seront donc respectivement : users, article_categories et user_favorite_pages.

La convention est d’utiliser des mots anglais pour les noms de colonne et de table. Si vous utilisez des mots dans une autre langue, CakePHP ne va pas pouvoir convertir correctement les bonnes inflections (du singulier vers le pluriel et vice-versa). Dans certains cas, si vous souhaitez ajouter vos propres règles pour des mots d’une autre langue, vous pouvez utiliser la classe utilitaire Cake\Utility\Inflector.

Les noms des champs avec deux mots ou plus doivent être avec des underscores comme ici : first_name.

Les clés étrangères des relations hasMany, belongsTo ou hasOne sont reconnues par défaut grâce au nom (singulier) de la table associée, suivi de _id. Donc, si Users hasMany Articles, la table articles se référera à la table users via une clé étrangère user_id. Pour une table avec un nom de plusieurs mots comme article_categories, la clé étrangère sera article_category_id.

Les tables de jointure utilisées dans les relations BelongsToMany entre models doivent être nommées d’après le nom des tables qu’elles unissent, dans l’ordre alphabétique (articles_tags plutôt que tags_articles).

Vues

Les fichiers de template de view sont nommés d’après les fonctions du controller qu’elles affichent, sous une forme avec underscores. La fonction viewAll() de la classe ArticlesController cherchera un gabarit de view dans src/Template/Articles/view_all.ctp.

Le schéma classique est src/Template/Controller/nom_de_fonction_avec_underscore.ctp.

TODOLIST¶

TODO Aout 2017 :

- Bugfix (mail reçu le 8/9/17) : message mail insuffisant, il manque l'id du matériel :
Dorine Roma a modifié le matériel "MACBOOK PRO".
Veuillez vérifier et compléter si besoin la fiche corespondante.
Vous recevez ce message car vous avez demandé à le recevoir. Pour faire retirer votre mail de la liste, veuillez contacter un SuperAdmin.
=> AJOUTER DES TESTS SUR LES RETOUR EMAIL !!!

- Bugfix : il semble que le profil "Responsable" ne peut pas editer un matériel qui lui appartient pourtant (créé en son nom), c'est un comble !!!
(vérifier aussi pour les autres profils, cette possibilité doit être accordée à TOUS les profils)

- Bugfix : les "responsables de domaines" ont-ils une raison d'être pour l'IRAP ? (à supprimer de autres listes)

- Bugfix : les "unites" ont-elles une raison d'être pour l'IRAP ? (à supprimer de autres listes)

- (EP DONE 09/17) Mettre en place les Tests paramétrés pour éviter redondance avec les différents profils (cf https://jtreminio.com/2013/03/unit-testing-tutorial-part-2-assertions-writing-a-useful-test-and-dataprovider/ et https://dzone.com/articles/practical-php-testing/practical-php-testing-patterns-46)

- Mettre en place le mocking d'objets et méthodes pour simplifier les choses difficiles : https://jtreminio.com/2013/03/unit-testing-tutorial-part-4-mock-objects-stub-methods-dependency-injection/ et https://jtreminio.com/2013/03/unit-testing-tutorial-part-5-mock-methods-and-overriding-constructors/

- Remplacer les TODO: (non reconnus dans task list de Eclipse) par @todo

- Ajouter le commentaire //BETTER: devant les lignes qui sont un progrès d'écriture (meilleure pratique) par rapport à ce qu'on faisait avant

- Lire la doc sur Authentication et surtout Authorization pour voir si on peut pas mieux faire
https://book.cakephp.org/3.0/fr/tutorials-and-examples/blog-auth-example/auth.html
(puis lire les 2 articles à suivre tout à la fin)

- Finir de regrouper et numéroter les tests selon le doc ACL (regroupement par controleur, puis par ACTION, puis tester chaque action avec tous les ROLES)

- Merger les vues add et edit car elles se ressemblent énormément et ça évitera des redondances inutiles :
http://phpmysqltalk.com/1851-cakephp-merge-add-and-edit-actions-into-a-single-html-form.html
http://blog.grzegorzpawlik.com/2010/03/how-to-merge-edit-and-add-methods-in-cakephp/

NOUVEAUX BUGS (au 30/6/17) :

Bugfixes:
- BD test_labinvent pas créée automatiquement avec install.sh ? (j'ai dû la créer à la main !!)

Actions:
- install/update_plugins.sh => ameliorer en ajoutant tous les chmod necessaires pour les dossier phpqrcode et autres... (recup de install/installation.sh)
- install from scratch ou update ??? tout ca n'est pas très clair et ne marche pas bien !
- install/installation.sh : remplacer setfacl pour mac os
- ref de cakephp sur github : https://github.com/cakephp/cakephp
- ref de app sur github : https://github.com/cakephp/app
- remettre en place les CSS de base de cakephp (https://github.com/cakephp/app/tree/master/webroot/css) dans default.php : base.css, cake.css, et home.css
- ajouter cette liste à la roadmap
- git push dev-LATMOS + git pull + corriger erreurs + merge, etc.
- remplacer XAMPP par une installation propre avec macport de chaque composant : httpd (apache), mysql (mariadb), et 2 versions de php (5.6 et 7.x), ou alors installer la version XAMPP-VM pour mac
- faire une version docker pour éviter d'avoir à gérer différents OS : Mac (avec XAMPP), CentOS, Ubuntu, Fedora, etc.
- lire page cakephp TESTING pour mieux faire les tests (https://book.cakephp.org/3.0/en/development/testing.html)
- refaire les tests en suivant la nouvelle logique décrite sur cette page
- improve plugins : à la suite de l'installation des plugins, j'ai les messages suivants :

cakephp/cakephp suggests installing lib-ICU (The intl PHP library, to use Text::transliterate() or Text::slug())
symfony/console suggests installing symfony/event-dispatcher ()
cakephp/debug_kit suggests installing ext-sqlite (DebugKit needs to store panel data in a database. SQLite is simple and easy to use.)
symfony/var-dumper suggests installing ext-symfony_debug ()
psy/psysh suggests installing ext-readline (Enables support for arrow-key history navigation, and showing and manipulating command history.)
psy/psysh suggests installing ext-pdo-sqlite (The doc command requires SQLite to work.)
psy/psysh suggests installing hoa/console (A pure PHP readline implementation. You'll want this if your PHP install doesn't already support readline or libedit.)
sebastian/global-state suggests installing ext-uopz (*)
phpunit/php-code-coverage suggests installing ext-xdebug (^2.5.3)
phpunit/phpunit suggests installing phpunit/php-invoker (^1.1)
phpunit/phpunit suggests installing ext-xdebug (*)

Ajouts:
- orange si proche de fin de garantie
- boolean "empruntable" pour materiel qu'on peut emprunter => permet recherche des matériels empruntables et voir disponibilité + rouge quand matériel déjà emprunté (et donc non dispo)
- matos/add : date enlever un chiffre à année => plante sur DateTime
- matos/view : éviter d'afficher "€" quand pas de prix
- matos/add : il faut pouvoir changer le proprio (resp+)
- delete suivi : ramener sur le materiel et non pas sur la liste des suivis
- héritage templates : ok + cancel pour tous les forms (recup vue materiels/add.ctp ligne 50)
- ameliorer pagination :

ameliorer la css inventirap.css
remettre en place la css cake.css (elle devrait être là par défaut, et ensuite, on construit par dessus, ça évitera des soucis à l'avenir, par ex, cakephp3.4 a changé la présentation de la pagination par défaut, et ça ne marchait plus sur inventirap...)
http://www.sanisoft.com/blog/2014/07/28/change-markup-for-pagination-cakephp3/
https://book.cakephp.org/3.0/en/views/helpers/paginator.html
https://book.cakephp.org/3.0/en/controllers/components/pagination.html#using-the-paginator-directly

- bug find
technique ET administratif = technique seulement
administratif seulement = administratif

- materiels/find : chercher labo : on en trouve seulement 100 alors qu'il y en a plus
- expliquer soucis avec cake.css : comment a-t-elle été désactivée ?

La liste des demandes à jour se trouve ici : https://projects.irap.omp.eu/projects/inventirap/issues?query_id=222_

NB: Cette liste est OBSOLÈTE (ici à titre indicatif, pour se souvenir des retours de réunion)

Demandes des utilisateurs (transmises par D. Rambaud le 19/12/16) :

Ca serait bien que le proprio de la fiche reçoive un email quand l'étiquette est imprimée, ou encore quand la fiche est validée => dans le but qu'il vérifie et complète cette fiche
Ca serait bien aussi que le proprio puisse modifier sa fiche, une fois créée, mais aussi même après qu'elle ait été validée. Attention, la modification post-validation ne peut porter que sur les renseignements techniques complémentaires.

Suite à réunion du 27/10/16 avec le LATMOS, constat des modifs nécessaires:

L'étiqueteuse semble ne plus fonctionner alors qu'elle fonctionnait avant...
Ajouter un champ "Titre du mail" dans la liste des emails envoyés, pour qu'on puisse configurer le titre du mail envoyé (ex: [LABINVENT])
Check Date achat <= Date Livraison !!!
Ajouter un statut : ajouter un statut « désinventorié « ou «amorti ? » (à réfléchir)
Ajouter colonne statut « hors service » dans la vue "liste des matériels"
N° série : à remettre dans la section informations (pour que tout le monde le voie)
Empêcher duplication d'une fiche matériel si même numéro de série
Importation depuis Excel
Le champ "Local de stockage" a-t-il disparu ??? => à remettre
Site : champ optionnel
Champs optionnels: de manière générale, il faudrait pouvoir configurer quelques champs comme optionnels (certains champs doivent bien sûr absolument rester obligatoires)
(temporairement, on peut se contenter de CACHER certains champs, comme par exemple le champ "Site")
Suivis par fournisseur: ajouter la colonne "fournisseur" dans Suivi pour pouvoir trier la vue par fournisseur
Suivis relance : trouver un moyen de relancer automatiquement les suivis périodiques (ou bien avec une date programmée)
Emprunt dates: afficher les dates d'emprunt et de retour (date emprunt doit être obligatoire)
Matériel gestionnaire: obliger la personne qui crée une fiche matériel à choisir un gestionnaire (via une liste) (et avertir automatiquement ce gestionnaire par mail)
supprimer profil AdminPlus, inutile

Suite à l'installation à l'IRAP du 21/01/2016:

- Si elle existe, supprimer table "fichiers"
- Sauvegarder les utilisateurs
- Transformer table "utilisateurs" en "users"
- Ajout table "configuration"
- Ajout clé étrangère emprunts (site_id)/suivis (type_suivi_id)
- Transformation des données correspondantes
- Suppression ancien champ emprunt (e_lieu_stockage), suivis (type_intervention)

Suite à l'installation à l'IAS du 09/03/2015

- Ajout table "organismes", "type_suivis", "sites"
- Ajout clé correspondante dans table "matériels"
- Transformation des données correspondantes
- Suppression anciens champs
- Ajout table "documents"
- Sauvegarder les utilisateurs
- Transformer table "utilisateurs" en "users"
- Ajout table "configuration"
- Ajout clé étrangère emprunts (site_id)/suivis (type_suivi_id)
- Transformation des données correspondantes
- Suppression ancien champ emprunt (e_lieu_stockage), suivis (type_intervention)
---

A propose de Composer¶

https://getcomposer.org/doc/01-basic-usage.md#installing-without-composer-lock

Installation des dépendances :
Si composer.lock est absent, il sera créé avec les toutes dernières versions disponibles des plugins.
S'il est déjà présent, composer installera exactement les versions précisées dans ce fichier.
On est ainsi sûr d'avoir tous les mêmes versions de plugins.
C'est pourquoi composer.lock doit être inclus dans le dépot git.

php composer.phar install

Mise à jour des dépendances :
Ne tient pas compte de composer.lock, composer essaie donc de récupérer les dernières versions disponibles des plugins...

php composer.phar update

Modèle de données (Data model)¶

Schéma de la base de données (v2.6)¶

Error executing the thumbnail macro (Attachment BDD_schema.png not found)

Schéma de la base de données (v2.0)¶

Error executing the thumbnail macro (Attachment BDD_IRAP.png not found)

Cycle de vie du Matériel¶

Diagramme d'états-transitions¶

Error executing the thumbnail macro (Attachment equipment_status_state_diagram.png not found)

Diagramme de séquences¶

Error executing the thumbnail macro (Attachment equipment_interactions_sequence_diagram.png not found)

ACL - Gestion des droits selon le profil¶

Document Google doc (à jour) : https://docs.google.com/document/d/1-OhEeoi96j6ueUl5NQCQ9ZsTfbJTFw3ZVaWU2iYly_o/edit?usp=sharing

Ancien document (n'est plus à jour et est incomplet) :

Error executing the thumbnail macro (Attachment ACLs Droits selon les Roles.pdf not found)

Deux environnements de dev pour avoir php5.6 et php7.X¶

Avec XAMPP : https://magazine.joomla.org/issues/issue-mar-2014/item/1797-practical-development-2-working-environment

Utilisation du serveur web de dev de CakePHP (à la place de apache)¶

/!\ Votre serveur MySQL doit être lancé !!!

Se placer à la racine du projet.

Lancer la commande suivante :
```
 bin/cake server 
```

Rendez-vous sur http://localhost:8765/

ROADMAP - Plan de développement¶

Stage de Thibault : il se déroule du 10 avril au 30 juin 2017, soit sur 12 semaines (S1 à S12)
(Ne pas oublier de rédiger le rapport de stage au fur et à mesure)

Voir le détail de la roadmap: https://projects.irap.omp.eu/projects/inventirap/roadmap

S01-SO2 : version 2.5.x - Amélioraiton installation, pagination
S03-SO5 : version 2.6.x - Emails, Etiquettes, bugfix...
S06-SO7 : version 2.7.x - Synchronization avec LATMOS, ACLs ok partout
S08-S10 : version 2.8.x - ACLs configurables via BDD, ...
S11-S12 : version 2.9.x - upgrade Cakephp3, passage à Php7

Stage de Alexandre Cases (avril à juin 2016) :

		Prévu	Réalisé
S01 (11/4-15/4)	1	version 2.00 - Cakephp3 + Php5	version 2.00
S01 (11/4-15/4)	2
S02 (18/4-22/4)	1
S02 (18/4-22/4)	2
S03 (25/4-29/4)	1
S03 (25/4-29/4)	2	version 2.01 - Implémentation complète du CRUD
S04 (02/5-06/5)	1		version 2.01
S04 (02/5-06/5)	2
S05 (09/5-13/5)	1
S05 (09/5-13/5)	2	version 2.02 - Implémentation de toutes les autres actions
S06 (16/5-20/5)	1		version 2.02
S06 (16/5-20/5)	2		version 2.02
S07 (23/5-27/5)	1	version 2.03 - Implémentation du LDAP	version 2.03
S07 (23/5-27/5)	2	version 2.03 - Implémentation du LDAP	version 2.03
S08 (30/5-03/6)	1	version 2.04 - Implémentation des ACL	version 2.04 (en cours)
S08 (30/5-03/6)	2	version 2.04 - Implémentation des ACL
S09 (06/6-10/6)	1	version 2.05 - Documents attaches aux materiels
S09 (06/6-10/6)	2	version 2.05 - Documents attaches aux materiels
S10 (13/6-17/6)	1	version 2.06 - Evolutions prévues dans 1.3 et 1.4
S10 (13/6-17/6)	2	version 2.06 - Evolutions prévues dans 1.3 et 1.4
S11 (20/6-24/6)	1	version 2.07 - Corrections/Evolutions demandées par l'IAS
S11 (20/6-24/6)	2	version 2.08 - Cakephp3 + Php7
S12 (27/6-30/6)	1	version 2.08 - Cakephp3 + Php7
S12 (27/6-30/6)	2	version 2.10 - Autres ajouts

COMMIT : Procédure à suivre à chaque commit¶

NB: cette procédure est détaillée davantage dans la section HOWTO de cette page (partie "CYCLE DE DEVELOPPEMENT A SUIVRE")

Voici les différentes étapes à respecter au moment de chaque commit:

1) S'assurer que tous les tests passent toujours !

Cela permet de se prémunir contre toute régression (ce qui fonctionnait avant doit continuer de fonctionner)

2) Optionnel : Incrementer la version et la date du projet

A la fin du fichier src/Template/Layout/default.ctp

3) Mettre à jour le fichier README-LABINVENT (ceci est un exemple, un template)

Date: 11/05/2016
Version: 2.1.9
Mise à jour doc install
(Attention, changement structure BDD)
Demande(s) réalisée(s) : https://projects.irap.omp.eu/issues/3542
Version majeure en cours (2.1): https://projects.irap.omp.eu/versions/101

Remarques:
=> Version: 2.1.9 = 9ème commit sur la version 2.1
=> préciser "(bugfix)" si c'est le cas
=> ajouter "(Attention, changement structure BDD)" s'il y a eu une modif de la BDD
=> "Demande (terminée)" ou "Demande (en cours)", ou pas de demande du tout (exceptionnellement)
=> ces infos permettront de savoir quelle version (et date) exacte du projet on a actuellement sur son disque

4) S'il y a eu un changement de structure de la BD

Copier la requête sql de modif dans un script db-update-AAAA-MM-JJ.sh du dossier database/update/
Mettre à jour le script sql complet de création de la BD database/labinvent_2.1_12-05-16.sql (et les autres scripts sql associés si besoin, insert_users...)
Mettre à jour le schéma (image png) de la BD (avec Mysql Workbench) dans le projet et sur le wiki (page "Documentation technique")
Avertir dans le README (Attention, changement de structure de la BDD, il faut exécuter le script de mise à jour database/update/xxx ...)

5) Si c'est la fin d'une version majeure (2.0, 2.1, 2.2, ...)

On doit normalement avoir écrit quelques nouveaux tests pour cette version, n'est-ce pas ??? (sinon, c'est po bien) !!!
Ajouter cette version en tête de la section "MAIN CHANGES (MILESTONES)" dans le fichier README
Mettre à jour la doc install/INSTALLATION à partir du wiki (si nécessaire)
(On peut aussi tester une installation du logiciel from scratch)

6) PULL

(au cas où quelqu'un d'autre aurait fait un push)

7) COMMIT

Dans le message de commit, faire un simple copier/coller des infos du fichier README (sauf date):

Version: 2.1.9
Mise à jour doc install (bugfix)
(Attention, changement structure BDD)
Demande (terminée): https://projects.irap.omp.eu/issues/3542
Version majeure en cours (2.1): https://projects.irap.omp.eu/versions/101

5) Si c'est la fin d'une version majeure (2.0, 2.1, 2.2, ...)

On doit normalement avoir écrit quelques nouveaux tests pour cette version, n'est-ce pas ??? (sinon, c'est po bien) !!!
Ajouter cette version en tête de la section "MAIN CHANGES (MILESTONES)" dans le fichier README
Mettre à jour la doc install/INSTALLATION à partir du wiki (si nécessaire)
(On peut aussi tester une installation du logiciel from scratch)
Voir aussi étape 9

8) Optionnel : PUSH

(seulement si le commit est important/urgent, ou suite à un ensemble de commits sur un même thème)

9) Si c'est la fin d'une version majeure (2.0, 2.1, 2.2, ...), TAGUER la version

Exemple:

git tag 2.8 1b2e1d63ff

The 1b2e1d63ff stands for the first 10 characters of the commit id you want to reference with your tag.
You can get the commit id by looking at the log :

git log

Procédure à suivre pour MERGER le code entre 2 labos¶

0) Etat initial :
- dev-LATMOS : état ok (tests passés & push fait)
- dev-IRAP : état ok (tests passés & push fait)

A faire à l'IRAP :

1) Merger dev-IRAP => dev
git checkout dev-IRAP
(dev-IRAP) Incrémenter date + version + commit/push
git checkout dev
git merge --no-ff dev-IRAP
Tests ok
git push [origin dev]

2) Merger dev-LATMOS => dev
git checkout dev-LATMOS
(dev-LATMOS) Tests ok
git checkout dev
git merge --no-ff dev-LATMOS
Si besoin, résoudre les conflits + add/commit/push
Si besoin, exécuter le(s) script(s) db-update.sh
si besoin, adapter le(s) script(s) db-update.sh
Tests ok
Faire un seul script db-update fusionnant toutes les modifs IRAP
Update le script de création général de la BD (en fonction du contenu de db-update.sh) + add/commit/push
Incrémenter date + version + add/commit/push

3) Merger dev => dev-IRAP et dev-LATMOS
git checkout dev-IRAP
git merge --no-ff dev
Tests ok
git push

git checkout dev-LATMOS
git merge --no-ff dev
Tests ok
git push

Si besoin : Prévenir LATMOS que db-update à faire (venant de dev-IRAP) ?

Installation from scratch (Sous UBuntu)¶

Création projet avec Composer¶

Télécharger composer.phar :
"curl -s https://getcomposer.org/installer | php"

Avec le Composer créer un nouveau projet :
"php composer.phar create-project --prefer-dist cakephp/app labinvent_2.0"

Voir structure projet : http://book.cakephp.org/3.0/fr/intro/cakephp-folder-structure.html

On rempli la base de données avec le fichier sql

On indique la BD utiliser à CakePHP dans le fichier config/app.php, propriété "Datasources".

On se place à la racine du projet

On génère le code Scaffold :
"bin/cake bake all nom_table" --> ça génére les modeles, les vues, et les controlleurs.

Commande (en une fois) :

bin/cake bake all categories && bin/cake bake all emprunts && bin/cake bake all groupes_metiers && bin/cake bake all groupes_thematiques && bin/cake bake all organismes && bin/cake bake all sites && bin/cake bake all sous_categories && bin/cake bake all suivis && bin/cake bake all sur_categories && bin/cake bake all type_suivis && bin/cake bake all documents && bin/cake bake all users && bin/cake bake all materiels

Modification de la base de données¶

Une version du sql corrigée au fur et à mesure est disponible dans le git :

Dans database/, le fichier labinvent_2.1_09-05-16 correspond à la création de la base.
Dans database/, le fichier labinvent_2.0_insert-irap_19-04-16 correspond aux insertions propre à l'IRAP, fichier insertion uniquement pour les dévellopeurs.

Création table "config"

Mise à jour dans le fichier de création de base
Mise à jour à part : db-update-2016-05-09.sql

Autres remarques lors du développement¶

Suivre les conventions de CakePHP est le top pour ne pas avoir à refaire de la config (bidouiller), il faudrait vérifier réguliérement que c'est le cas (outil "cakephp-codesniffer")...

Voir : http://book.cakephp.org/3.0/fr/contributing/cakephp-coding-conventions.html

La solution pour insérer un utilisateur directement dans la base et pouvoir se connecter avec dans l'application est de l'insérer avec un mot de passe haché de la méme façon.
Le mot de passe "login" = "$2y$10$LZzpws3oDidBcqO/Fy1RTedLLk3ENTmplny5J7bZ6R1PqFoGOw3Ma".
Le mot de passe vide "" = "$2y$10$nBQMNstgN.sgad1ZANznY.pbJI.ZG/.Q5qX4gC8SXCFQnDIZC8rcW".

Vérifier que la migration vers la prochaine version de cakephp3 (3.3 ?) sera facile... (décrire la procédure à suivre)
--> Une migration vers une version mineur 3.2 => 3.3, se réalise avec la mise à jour de CakePHP à l'aide de Composer
--> Puis il faut regarder les changements dans la page migration correspondant à la version voulu et adapter les changements au code.

Voir : http://book.cakephp.org/3.0/fr/appendices/3-2-migration-guide.html

Outil (plugin) "DebugKit" de CakePHP3 :
--> DebugKit est un plugin qui fournit une toolbar pour aider à debugger les applications CakePHP plus facilement.
--> Par défaut il est installé avec le squelette de l'application, pour l'activer, il faut se placer à la racine.
--> Puis il faut éxécuter la ligne suivante : bin/cake plugin load DebugKit .
--> La commande va aller modifier le fichier config bootstrap.php.
--> Le fichier bootstrap.php actuel de l'application sur le git, est configuré pour charger le plugin lorsque l'application est en mode debug de CakePHP, je ne pense pas que exécuter la commande précédente soit utile vu la configuration de ce fichier dans notre application.
--> Le plugin nécessite l'extension php5-sqlite par défaut (il supporte l'équivalent avec de la config).

Voir : http://book.cakephp.org/3.0/fr/debug-kit.html

Mode debug personnaliser :

Faire $this->myDebug($var) dans un controlleur pour afficher le contenu de la variable si mode debug personnalisé actif, à condition que le mode debug soit activé.

Voir : http://book.cakephp.org/3.0/fr/development/testing.html

Pour charger une librairie (ex : phpqrcode, ...)

Voir : http://book.cakephp.org/3.0/fr/core-libraries/app.html#charger-les-fichiers-de-vendor

Pour créer les fichiers pdf d'entrée et de sortie, on utilise fpdf 1.8.1, on pourrait utiliser le plugin développer pour CakePHP3.

Voir : https://github.com/FriendsOfCake/CakePdf

Pour le JavaScript, le JS Helper a été retiré

Voir : http://book.cakephp.org/3.0/fr/appendices/3-0-migration-guide.html#jshelper

Pour pouvoir éxécuter les tests depuis eclipse :

Voir : http://blog.loftdigital.com/running-phpunit-tests-in-eclipse-pdt

Avant de déployer l'application sur le serveur de production, optimiser les performances

Voir : http://book.cakephp.org/3.0/fr/deployment.html#ameliorer-les-performances-de-votre-application

Installation sur Mac (retour des pb)¶

1) install.sh
=>
chmod: Unable to change file mode on ./webroot/img//gqbee0pkerrl8h2rbekaa3t8j1.png: Operation not permitted
chmod: Unable to change file mode on ./tmp//cache/models/myapp_cake_model_default_configurations: Operation not permitted
chmod: Unable to change file mode on ./tmp//cache/models/myapp_cake_model_default_documents: Operation not permitted
chmod: Unable to change file mode on ./tmp//cache/persistent/myapp_cake_core_translations_cake_fr__f_r: Operation not permitted
chmod: Unable to change file mode on ./tmp//cache/persistent/myapp_cake_core_translations_debug_kit_fr__f_r: Operation not permitted
chmod: Unable to change file mode on ./tmp//cache/persistent/myapp_cake_core_translations_default_fr__f_r: Operation not permitted

=> sudo chmod -R 777 ../webroot/img
=> sudo chmod -R 777 ../tmp/
(=> sudo chmod -R 777 ../vendor)

2) connexion au site
=> mauvais affichage pourri
=> il faut configurer la BD dans app.php
'username' => 'labinvent2user',
'password' => 'labinvent2user',
'database' => 'labinvent2',

3) login
=> epallier/login

Pour mettre à jour CakePHP¶

Utiliser le composer : "php composer.phar update" à la racine de l'application

Voir : http://book.cakephp.org/3.0/fr/installation.html#rester-a-jour-avec-les-derniers-changements-de-cakephp

Puis il faut modifier le fichier : ./vendor/cakephp/cakephp/src/View/Helper/PaginatorHelper.php
Ce fichier contient le template de l'helper "paginator" et il faut modifier le tableau "$_defaultConfig" et remplacer les balise "li" par des balises "span".
Enfin dans le même tableau, il faut remplacer la ligne suivante :

'current' => '<span class="active"><a href="">{{text}}</a></span>',

Par :

'current' => '<span class="current">{{text}}</span>',

Puis il faut vider le cache de l'application (et du navigateur) pour que debug_kit fonctionne.

Pour utiliser php5.6 ET php7.0 sur le même OS (Fonctionne avec Ubuntu 14.04.5 - le 02/05/2017)¶

Installation de php 5.6 et de php 7.0 :

sudo add-apt-repository ppa:ondrej/php
sudo apt-get update
sudo apt-get install php7.0 php5.6 php5.6-mysql php-gettext php5.6-mbstring php-mbstring php7.0-mbstring php-xdebug libapache2-mod-php5.6 libapache2-mod-php7.0

Comment changer de version :

Depuis php5.6 vers php7.0 :

sudo a2dismod php5.6 ; sudo a2enmod php7.0 ; sudo service apache2 restart
sudo update-alternatives --set php /usr/bin/php7.0

Depuis php7.0 vers php5.6 :

sudo a2dismod php7.0 ; sudo a2enmod php5.6 ; sudo service apache2 restart
sudo update-alternatives --set php /usr/bin/php5.6

Rappel d'intervention par mail¶

Il faut définir un attribut "rappel" de type "int" dans la table suivis.
Cet attribut peut avoir 4 valeurs :

0 ==> Pas d'envoi de rappel programmé
1 ==> Rappel programmé 1 mois avant
2 ==> Rappel programmé 15 jours avant
3 ==> Rappel programmé 2 jours avant

Dans l'AppController, il faut définir une fonction "rappelIntervention()" qui :
- Parcourt tous les suivis et garde ceux qui ont une date inferieur à 1 mois de la date du jour et qui ont un attribut "rappel" à "0".
- Met cette attribut à 1
-

...........................

Dans l'UsersController, il faut executer la fonction précédente une fois que l'utilisateur est connecté (dans fonction login()).

AMELIORATIONS A VENIR (TODO)¶

1) POUR LE CODE SOURCE¶

Bien maîtriser les 4 étapes qui s'enchainent lors de l'appel d'une action :

a) Avant l'appel d'une action d'un controleur

Ex: src/MaterielsController/isAuthorized()

(NB: Au plus haut niveau, c'est vendor/cakephp/src/Controller/Component/AuthComponent.php::isAuthorized())

Définir qui a droit à quoi dans src/<Model>Controller/isAuthorized(),
action par action, et à l'intérieur d'une action, role par role

Respecter cette structure de code :

switch ($action) {

   case 'action1':
      switch ($role) :
         case USER:
         case RESP:
         case ADMIN:
         ...

   case 'action2':
      switch ($role) :

   ...

b) Dans le traitement de l'action, avant la vue

Ex: src/MaterielsController/add()

Définir TOUTES les données dont la vue aura besoin, dans src/<Model>Controller/<action()>
La vue ne doit faire AUCUN traitement, elle doit se contenter d'afficher les données qu'on lui passe.

En particulier, selon le role (profil) actif, positionner ces tableaux (listes de champs pour dire à quels champs ce role à accès et dans quelles conditions (lecture seule, obligatoire, ...) :

$hiddenFields = [ fields list ]
$readonlyFields = [ fields list ]
$mandatoryFields = [ fields list ]
$defaultValueForFields = [ field1 => value1, field2 => value2, ..., fieldN => valueN ]

Passer ensuite ces listes à la vue avec set()

c) Dans la vue correspondant à l'action

Ex: dans src/Template/Materiels/add.ctp

Dans src/Template/<Model>/<action.ctp>

Afficher les données passées par le controleur pour cette action

(faire le moins de traitements possibles, seulement de l'affichage)

En particulier, la vue affichera les champs (fields) un par un, en utilisant une fonction displayField() qui tiendra compte automatiquement des listes définies à l'étape précédente :
$hiddenFields, $readonlyFields, $mandatoryFields, et $defaultValueForField

d) (TODO) 4ème étape à envisager : ce qui se passe APRES que l'action a été exécutée

La sauvegarde dans la BD (voir aussi beforeSave())
Quelle redirection vers quelle vue ?

2) POUR LES TESTS¶

(https://book.cakephp.org/3.0/en/development/testing.html)

Les tests sont dans tests/TestCase/

Ils sont organisés par type :

Controller/
Model/
View/

La plupart des tests sont dans Controller, mais il faudra aussi faire quelques tests de Model et de View...

Concernant les tests liés aux controleurs (dans Controller/), ils sont organisés par controleur :

EmpruntsControllerTest.php
MaterielsControllerTest.php
PagesControllerTest.php
SuivisControllerTest.php
UsersControllerTest.php

(on prendra plutôt l'exemple des tests du controleur de Materiels, MaterielsControllerTest.php)

Il y a 2 manières de procéder :

La manière intuitive, moins exhaustive, mais PLUS LISIBLE car plus naturelle, et de plus haut niveau sémantique :

On organise les tests à la façon BDD (Behaviour Driven Dev) avec le GIVEN WHEN THEN :

"GIVEN a context, As a ADMIN, WHEN I do an ACTION, THEN I get this result"

Les tests sont organisés non pas par controleur, ni par action, mais par ROLE ("AS a ADMIN"), puis à l'intérieur de ce rôle, par ACTION

ex:

test_as_Unauthenticated_i_can_goto_APROPOS_page_and_HOME_page_and_LOGIN()

test_as_Authenticated_i_can_LOGOUT_and_LOGIN_again()

test_as_USER_i_can_ADD_a_MATERIEL_then_DELETE_it()

test_as_USER_i_can_ADD_a_MATERIEL_then_EDIT_it()

test_as_USER_i_cannot_EDIT_a_MATERIEL_that_is_not_mine()

test_as_USER_i_can_EDIT_a_MATERIEL_that_is_mine_even_if_VALIDATED()

test_as_ADMIN_i_can_VALIDATE_a_MATERIEL_that_is_CREATED()

On peut aussi avoir des tests qui permettent de vérifier les Règles de Gestion :

test_MATERIEL_date_reception_superieure_ou_egale_a_date_commande

test_MATERIEL_ne_doit_pas_etre_ni_technique_ni_inventoriable

La manière systématique, exhaustive, pour ne rien oublier, mais PEU LISIBLE (donc on préfèrera la manière précédente) :

On organise les tests pour un controleur donné (ex: MaterielsController) par ACTION, et pour chaque action tester les droits des différents ROLES.

CHAQUE TEST devrait dans l'idéal comporter 3 ou 4 parties correspondant aux 4 étapes présentées au point "1) POUR LE CODE SOURCE" ci-dessus :

a) Avant l'appel d'une action d'un controleur :

Tester qui a le droit de faire quoi

b+c) Dans la vue correspondant à l'action :

Tester que la vue a bien été générée comme il faut pour cette action, et que les listes $readonlyFields, $mandatoryFields, ... sont bien remplies comme il faut

d) Après la réalisation de l'action :

Tester que l'action attendue a bien été réalisée et qu'on est bien sur la vue de redirection prévue

Exemples :

testUnauthenticatedUserCanLogin() : tester qu'un user non logué peut appeler l'action "login", et se trouve bien ensuite sur la page accueil

testUnauthenticatedUserCanViewAboutPage() : tester qu'un user non logué peut voir la page "about"

testUnauthenticatedUserCannotDoAnythingElse() : tester qu'un user non logué ne peut voir que les pages "accueil" et "about", et rien d'autre

testAuthenticatedUserCanLogout() : tester qu'un user logué peut se déloguer et atteint bien la page de login

Tests spécifiques pour le controleur Materiels (les tests doivent être organisés PAR ACTION) :

testOnMaterielsActionViewCanBeDoneByAll() : tester que tout le monde peut voir un matériel

testOnMaterielsActionAddCanBeDoneByAll() : tester que tout le monde peut créer un matériel, sans toutefois voir les mêmes champs (et pas dans les mêmes conditions), et vérifier que l'ajout d'un matériel a bien été fait et qu'on arrive sur la vue détaillée du matériel (oui, tout ça doit être testé, les 4 étapes citées plus haut, et cela pour tous les profils)

testOnMaterielsActionEditCanBeDoneByXXXWithConditions() : tester que selon les profils, on ne peut pas éditer les mêmes matériels (USER doit être owner, RESP doit appartenir au même groupe thématique ou métier, ...)

Pour chaque test, on peut imaginer des SOUS-TESTS de ce type (on prend ici l'exemple du test précédent) :

testOnMaterielsInViewEditXXXCanSeeOnlyTheseFields (fields list) : test des hidden fields
testOnMaterielsInViewEditXXXCannotChangeTheseFields (fields list) : test des readonly fields
testOnMaterielsInViewEditXXXMustFillTheseFields (fields list) : test des mandatory fields
testOnMaterielsInViewEditXXXTheseFieldsHaveDefaultValues (fields list with default values) : test des default value fields

HOWTO (nouvelle version avec CakePhp3)¶

1) AUTHentication (authentification = connexion avec login) : Chemin parcouru lors d'une connexion au site web¶

(https://book.cakephp.org/3.0/en/controllers/components/authentication.html)

ATTENTION: voir aussi src/Model/Table/LdapConnectionsTable.php

Ce chemin est parcouru dans l'ordre :

webroot/index.php 

config/bootstrap.php => lit config/app.php

src/Controller/PagesController/display()

src/Controller/UsersController/login() sans POST

src/Template/Users/login.ctp => formulaire de login => POST

src/Controller/UsersController/login() avec POST

   user = $this->LdapAuth->connection();

     src/Controller/Component/LdapAuthComponent/connection()

        $resp = TableRegistry::get('LdapConnections')->ldapAuthentication($login, $password);

        src/Model/Table/LdapConnectionsTable.php::ldapAuthentication()

        if ($this->USE_LDAP) {
            $ldapConnection = ldap_connect($this->host, $this->port);
                       if (@ldap_bind($ldapConnection, $this->authenticationType . '=' . $login . ',' . $this->baseDn, $password)) {
                    return $this->getUserAttributes($login)[0];
        }
        else {
                $user = $this->getFakeLdapUser($login);
            if ($user != false && (new DefaultPasswordHasher)->check($password, $user['userpassword'][0]))
                return $user;
                }
                return FALSE

   if ($user != FALSE) {
      $this->LdapAuth->setUser($user);
      return $this->redirect($this->LdapAuth->redirectUrl());

Pour info, si ça bogue (par exemple, à une époque on retournait "YOLO" au lieu de FALSE en cas d'échec de connection ldap), c'est src/Template/Error/error400.ctp qui prend le relais...

2) AUTHorization (ACL, Autorisations, roles, profils des utilisateurs connectés)¶

C'est géré par la fonction isAuthorized()

a) beforeFilter() autorise les actions SANS connexion (pour les utilisateurs NON authentifiés)
b) puis, isAuthorized() autorise les actions APRES connexion (pour les utilisateurs authentifiés)

Comment définir qui a droit de faire quelles actions (c'est à dire qui a le droit d'accéder à quelles vues) ?

=> a) Régles générales par défaut pour tous les controleurs : AppController.isAuthorized()
src/Controller/AppController.php/isAuthorized()
(héritage de Cake\Controller\Component\AuthComponent::isAuthorized(), c'est à dire vendor/cakephp/src/Controller/Component/AuthComponent.php::isAuthorized())

(cf https://book.cakephp.org/3.0/fr/controllers/components/authentication.html et https://book.cakephp.org/3.0/fr/tutorials-and-examples/blog-auth-example/auth.html)

=> b) Régles pour un controleur donné (ex: MaterielsController) : MaterielsController.isAuthorized()
src/Controller/MaterielsController.php/isAuthorized()

Une fois qu'on est dans une vue, comment définir qui a droit de voir quels éléments de la vue ?
=> src/Template/<Model>/nom_de_la_vue.ctp
ex : src/Template/Materiels/edit.ctp pour les règles concernant la vue "edit" des materiels

3) Ajouter une nouvelle action sur un controleur¶

Ex: ajout de l'action statusCreated() dans le controleur Materiel

Il faut l'ajouter à 2 endroits dans MaterielsController.php :

a) ajouter une methode statusCreated() :

public function statusCreated($id = null, $from = 'index') { ... }

b) ajouter un cas 'statusCreated' dans la methode isAuthorized() qui doit retourner true pour autoriser cette action :

case 'statusCreated': ... return true; ...

La voici en détail :

    case 'statusCreated': // de-validation d'un materiel (repasse à CREATED)
                $id = (int) $this->request->getParam('pass.0');
                // Admin + ok
                if ($this->USER_IS_ADMIN_AT_LEAST()) return true;
                // Resp ok if same group
                if ($this->USER_IS_RESP() && $this->isRespGroup($id, $user[$ldapAuthType])) return true;
                // User not ok
                break;

4) Champ facultatif/obligatoire : Comment rendre facultatif ou obligatoire un champ, et définir les vérifications à faire sur ce champ ?¶

=> src/Model/Table/<Model>Table.php
ex : src/Model/Table/MaterielsTable.php pour définir les règles sur les champs de la table "materiels"

Où définir les éléments passés à une vue (c'est à dire à une action) ?
=> src/Controller/<Model>Controller/nom_de_la_vue_ou_action()
ex : src/Controller/MaterielsController/edit() pour définir (avec set()) les éléments passés à la vue "edit" des materiels

HOWTO (ancienne version LabInvent 1.3 avec CakePhp2)¶

Attention, ce howto est sans doute obsolète car il concerne l'ancienne version LabInvent 1.3 avec CakePhp2, mais il contient sûrement des conseils encore bien utiles

Ce document est un HOWTO, c'est à dire un guide pour savoir "comment faire quoi".
Il donne des solutions à différents types de besoins ou problèmes, et explique aussi "où trouver quoi".

VERSION DE CAKEPHP

Version de cakephp ?
Configure::version(); // 2.1.3
Et aussi : fichier cakephp/lib/Cake/VERSION.txt

CYCLE DE DEVELOPPEMENT A SUIVRE (11 commandements)

Je veux apporter un changement (correction ou evolution) au projet, comment dois-je faire ?

1) Incrementer la version du projet, a la fin du fichier cakephp/app/View/Layouts/default.ctp, et mettre à jour la date

2) Selectionner le changement a apporter (une demande) dans le Redmine du projet (https://projects.irap.omp.eu/projects/inventirap) :
- soit depuis la liste des demandes : onglet Demandes
- soit depuis la roadmap : onglet Roadmap, cocher la case "Anomalie", cliquer sur Appliquer, puis "version 1.3" (la version en cours depuis fin 2012)
Commencer de préférence par les "anomalies" parmi celles qui ont la plus haute priorité (et faire les "évolutions" dans un 2ème temps).
Choisir une demande et cliquer dessus pour aller sur sa fiche detaillee et voir le travail a faire.
Cliquer sur "mettre a jour", selectionner le statut "En cours", modifier eventuellement d'autres champs..., puis cliquer sur "Soumettre".
Noter l'URL de cette fiche (par exemple : https://projects.irap.omp.eu/issues/1050)
NB : Si la demande n'existe pas encore, la creer :
- cliquer sur l'onglet "Nouvelle demande"
- Selectionner "Anomalie" ou "Evolution"
- Positionner le statut a "En cours" si on veut travailler aussitot dessus (sinon, laisser a "Nouveau")
- Completer le reste de la fiche de demande (mettre "Assigne a" a "<<moi>>", choisir la version cible "version 1.3" ou "version 1.4", ...)
- cliquer sur le bouton "Creer"

3) Verifier que cette nouvelle demande apparait bien dans la roadmap (cliquer sur onglet "Roadmap", ..., puis version 1.3)

ÉTAPE OPTIONNELLE MAIS FORTEMENT CONSEILLÉE :
4) Ecrire un test qui vérifie que cette fonctionnalité ne marche pas encore (bug) ou bien n'est pas encore implémentée
On utilise ici l'approche TDD (Test Driven Development)
Ce test ne devrait pas passer (il est au rouge) ; il passera plus tard, quand on aura écrit le code nécessaire.
Bien sur, c'est dans la mesure du possible, car on ne peut pas TOUT tester.
Dans tous les cas, il faut ecrire un test qui s'approche le plus possible de la réalité à tester.
Voir pour cela la section "TESTS" (à la fin de ce document)

5) Faire les changements necessaires dans le code Php
Si ce changement implique aussi un changement dans la base de donnees,
copier le script SQL correspondant à ce changement dans un fichier database/update/db-update-YYYY-MM-DD.sql
portant la date du jour (voir des exemples dans database/update/old/).
Plus tard, il faudra penser à intégrer ce changement dans le script general de creation de la BDD database/BDD_IRAP.sql
(et/ou éventuellement les fichiers Insert_TablesFunct.sql, Insert_Users.sql, et Upd_TableConstraints.sql)
et donc deplacer le script de modification database/update/db-update-YYYY-MM-DD.sql dans database/update/old/db-update-YYYY-MM-DD.sql

6) Tester manuellement ce changement jusqu'a ce qu'il soit totalement OK
a) faire quelques tests manuels
b) Le test écrit à l'étape (4) doit maintenant passer (il est au vert).
Il doit être inclus dans l'ensemble des tests accessibles par le lien "AllTests".
c) Test de non régression : afin de s'assurer que cette modification du code n'entraîne aucune régression sur le reste du code,
tous les autres tests écrits avant doivent aussi passer (vert) : pour cela, exécuter l'url /test.php?case=AllTests

7) Compléter le fichier /README.txt, section HISTORIQUE DES VERSIONS (fichier situé à la racine du projet)
Y mettre le même commentaire que ce que tu mettras lors du commit

8) Mettre a jour TON code (en mode console, "svn update" depuis la racine du projet, ou bien depuis Eclipse, clic droit sur le projet, "Team/Update")
C'est important, au cas ou quelqu'un d'autre aurait fait des modifs (avant ou en meme temps que toi), et pour etre bien sur d'avoir la derniere version

9) Faire un "commit" du code, en collant dans le commentaire l'URL de la demande realisee (exemple : https://projects.irap.omp.eu/issues/1050)

10) Fermer la demande sur redmine
Sur la fiche detaillee, cliquer sur "Mettre a jour", changer le statut a "ferme", changer "% realise" a 100%, (copier l'URL de la fiche), cliquer sur Soumettre

11) Si c'est un changement important, le répercuter sur le site officiel
Le changement est important si c'est une anomalie ou bien si c'est une évolution attendue.
Demander alors au service informatique de le répercuter sur l'installation officielle (faire un "svn update", mail à loic.jahan@irap.omp.eu).
Si ce changement implique aussi la base de données, donner la directive que le fichier database/update/db-update-YYYY-MM-DD.sql doit être exécuté sur leur BDD.
Si ce changement impliquer une modification du fichier de configuration labinvent.php, donner la procédure à suivre dans le mail.

CORRIGER UNE ERREUR, RESOUDER UN PROBLEME, COMMENT DEBOGUER (DEBUG)

Cakephp vous affiche une erreur, mais vous ne savez pas d'ou vient le probleme.
Don't panic.
En general, un bon moyen de le savoir est de lire le fichier de log des erreurs
dans cakephp/app/tmp/logs/error.log

Dans le dossier logs, vous trouverez d'autres logs utiles :
- labinvent.log
- debug.log (pas sur que ce fichier soit encore utilisé...)

Remarque :
$this->log('Something broke');

écrit dans cakephp/app/tmp/logs/ :

- error.log
- inventirap.log

OU EST QUOI (WHERE IS WHAT) ?

- OU mettre a jour la VERSION du soft (AVANT CHAQUE COMMIT) ?
En attendant mieux, on fait cela a la fin du fichier cakephp/app/View/Layouts/default.ctp

- OU EST LA PAGE GENERALE (qui contient tous les elements) ? : cakephp/app/View/Layouts/default.ctp

- OU EST LA PAGE D'ACCUEIL ? : app/View/Pages/home.ctp

- OU SONT LES MENUS ? : app/View/Elements/
- menu general + Recherche generale : menu.ctp
- sous le menu general, et sous le champ "Recherche", titre du modele a ajouter : menu_index.ctp

- OU EST LA FEUILLE DE STYLE CSS ? : cakephp/app/webroot/css/inventirap.css

- OU EST DEFINIE LA PAGINATION ?
Dans le Controleur
Ex : la pagination des materiels est definie dans app/Controller/MaterielsController.php
public $paginate = array(
'limit' => 50,
'order' => array('Materiel.id' => 'desc'));

- OU SONT LES INFOS CONCERNANT UNE ENTITE quelconque (Materiel, Emprunt, Suivi, Utilisateur) ?
par exemple, ou trouver les infos sur l'entite "Materiel" ? : Aller dans cakephp/app/
- le Modele : Model/Materiel.php
- le Controleur : Controller/MaterielsController.php
- les Vues (templates) : View/Materiels
- Vue de consultation : scaffold.view.ctp
- Vue d'ajout (add) et edition (edit) : scaffold.form.ctp
- vue de liste : index.ctp

- OU SONT DEFINIS LES ROLES (ACL) ?
Dans app/Model/Utilisateur.php :
private $acceptedRoles = array ('Utilisateur', 'Responsable', 'Administration', 'Super Administrateur');
public function getAuthenticationLevelFromRole($role) {
if ($role 'Utilisateur')
return 1;
elseif ($role 'Responsable')
return 2;
elseif ($role 'Administration')
return 3;
elseif ($role 'Super Administrateur')
return 4;
return 0;
}

WORKFLOW des materiels

Le statut d'un materiel change selon le workflow suivant :
1) Un utilisateur lambda le cree (n'importe qui du labo) --> CREATED
2) L'Administration le valide (apres avoir eventuellement complete la fiche) --> VALIDATED
3) Un utilisateur lambda demande a l'archiver --> TOBEARCHIVED
4) L'Administration le sort de l'inventaire --> ARCHIVED

Notes :
- Dans l'ideal, le materiel est premierement cree par l'utilisateur concerne,
puis mis a jour par l'administration au moment de la commande (puis validé)
- L'administration peut toujours retrograder le statut d'un materiel (ce qui revient a annuler un changement de statut)

STRUCTURE GENERALE D'UNE PAGE WEB (TEMPLATE) = default.ctp

app/View/Layouts/default.ctp contient la structure suivante :

&lt;div id="container"&gt;
        &lt;div id="header"&gt;
            LE HEADER AVEC SON LOGO
            &lt;div class="user"&gt;
                BIENVENUE $userName (ou invité)
            &lt;/div&gt;
        &lt;/div&gt;
        &lt;div id="content"&gt;
            <?php echo $this->Session->flash(); ?>
            <?php echo $this->fetch('content'); ?>
        &lt;/div&gt;
        &lt;div id="footer"&gt;
            LE FOOTER
        &lt;/div&gt;
    &lt;/div&gt;

La DIV "content" insère 2 contenus :
- le message flash éventuel (qui dit si une opération demandée s'est bien passée ou pas...)
- la section "content", qui n'est autre que le coeur de la page

La page d'ACCUEIL n'est qu'un "content" parmi d'autres.
Elle se trouve dans app/View/Pages/home.ctp
(elle est affichée par le controleur de pages nommé PagesController)

COMMENT VOIR LES REQUETES SQL FAITES PAR CAKEPHP ?

Dans le layout general (cakephp/app/View/Layouts/default.php), ajouter cette ligne :
element('SQL_DUMP'); ?>
Vous devez aussi vous assurer que vous etes bien en mode DEBUG=2 (et non pas 0 ou 1)
dans le fichier de configuration Config/labinvent.php (ou bien dans le fichier Config/core.php)

OU EST FAIT LE CHARGEMENT DU FICHIER CONFIG database.php ?

lib/Cake/Model/ConnectionManager.php (fonction _init())
Ce fichier fait partie de la librairie standard de CakePhp. Il ne faut donc pas y toucher.
A l'origine, j'avais (EP) changé ici le nom du fichier config "database.php" en "config.php",
ce qui marchait très très bien...
MAIS il ne vaut mieux pas modifier le comportement par défaut de cakephp,
car si un jour on change de version de cakephp, ça ne marchera plus.

CREATION ET GESTION DU NOUVEAU FICHIER DE CONFIG labinvent.php

(cf http://book.cakephp.org/2.0/fr/development/configuration.html#loading-configuration-files)

1) J'ai créé le nouveau fichier de config dans app/Config/ (par exemple labinvent.php)
Ce fichier doit au minimum contenir un tableau nommé $config :
$config = array(
'labName' => 'IRAP',
...
);

2) Charger ce nouveau fichier de config au démarrage
Pour cela, ajouter cette ligne dans app/Config/bootstrap.php :
Configure::load('labinvent');

3) Lire (ou même modifier) les paramètres de ce fichier de config, depuis N'IMPORTE OU (controleur, modèle, vue) :
debug(Configure::version()); // pour afficher la version de Cakephp
debug(Configure::read()); // tout lire
debug(Configure::read('localisation')); // le tableau $localisation
$labName = strtoupper(Configure::read('localisation.labNameShort'));
debug(Configure::read('localisation.labName'));
if (Configure::read('USE_LDAP')) ...
if (Configure::read('debug') > 0 ) ...
On peut même modifier la valeur d'un paramètre dynamiquement comme ceci :
Configure::write('debug',2)
C'est d'ailleurs ce qui est fait dans app/Config/core.php

4) Penser à modifier le script d'installation install/installation.sh pour qu'il prenne en compte ce nouveau fichier

LOCALISATION (adapatation du logiciel à l'entité locale)

Vues (Pages) impactées :
- app/View/Layouts/default.ctp (template)
- app/View/Pages/home.ctp (Accueil)
- app/View/Pages/about.ctp (A propos)

Controleurs impactés :
- MaterielsController.php (fonction getLabNumber())

Documents impactés :
- Etiquette
- app/View/Documents/admission.ctp (Document d'admission)
- app/View/Documents/admission_cnrs.ctp (Document d'admission CNRS)
- app/View/Documents/admission_ups.ctp (Document d'admission UPS)

AJOUTER UNE NOUVELLE PAGE WEB

Par exemple, voici ce que j'ai fait pour ajouter la page "about", qui est accessible via l'url https://inventirap.irap.omp.eu/pages/about
1) Aller dans app/View/Pages/
1) Faire un copier/coller d'une page existante, par exemple infos.ctp, et l'appeler about.ctp
2) Remplir cette page avec le contenu souhaité
3) Tester que cette page est bien accessible via l'url http://.../pages/about
4) Ajouter un lien vers cette page, soit dans le menu outils (app/View/Pages/tools.ctp), soit dans le menu général (app/View/Elements/menu.ctp)
5) Si cette page ne doit pas être accessible a tout le monde, définir le profil minimum exigé dans app/Controller/PagesController.php, en ajoutant une ligne dans le tableau $minProfileAllowedForPage

LOGIN workflow

Controller/UtilisateursController/login() :
; cherche l'utilisateur dans la table utilisateurs pour voir si c'est un user SPECIAL ou bien un user quelconque
; appelle Controller/Component/LdapAuthComponent/connection() et getUserName($ldapAuthentication)

Controller/Component/LdapAuthComponent : contient les 2 méthodes
- connection() : appelle Model/LdapConnection/ldapAuthentication($login, $password)
- getUserName() : appelle Model/LdapConnection/getUserAttributes($ldapAuthentication)

Page d'accueil = View/Pages/home.ctp
(Controleur des pages simples = Controller/PagesController.php)

LOG

$this->log('Something broke');
> écrit dans cakephp/app/tmp/logs/ :
- error.log
- inventirap.log

GOOGLE ANALYTICS INTEGRATION

adapté de http://blog.janjonas.net/2010-01-31/cakephp-google-analytics-integration

1) Copier ce code dans app/View/Elements/google-analytics.ctp :
$gaCode = Configure::read('google-analytics.tracker-code');
if ($gaCode) {
$googleAnalytics = <<<EOD
<script type="text/javascript">
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-45668893-3', 'omp.eu');
  ga('send', 'pageview');

</script>
EOD;
echo $googleAnalytics;
}
?>

/* ANCIEN CODE JAVASCRIPT :
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
try {
var pageTracker = _gat._getTracker("$gaCode");
pageTracker._trackPageview();
} catch(err) {}</script>
*/

2) Inclure le view element dans app/View/Layouts/default.ctp (juste avant </body>):
element('google-analytics'); ?>

3) Définir le tracker code dans la configuration (/app/Config/core.php):
Configure::write('google-analytics.tracker-code', false); // disables Google Analytics
Configure::write('google-analytics.tracker-code', 'YOUR-TRACKING-CODE'); // enables Google Analytics

GENERALITES

- URL : http://localhost/inventirapsvn/cakephp/

- BD admin : http://localhost/phpmyadmin

- LOG : cakephp/app/tmp/logs/inventirap.log

- (UPDATE : cd Inventirap/ ; chmod -R 777 ./cakephp/app/tmp/)

- (SORTIE INVENTAIRE a faire : pc portable DELL (ex Nicolas Andre) - sept 2012 CNES 4017 (carte mere hs))

- Eclipse config :
Setup syntax highlighting for .ctp files:
Window > Preferences > General > Appearance > content Types > Text > PHP Content type > Add.. , then put in *.ctp.

- Cakephp config : cakephp/app/Config/
Mode debug ON (pour voir les erreurs et pour vider le cache en cas de changement sur la BD)
core.php : Configure::write('debug', 1);

- Fichier de demarrage :
cakephp/index.php (qui pointe sur cakephp/app/webroot/index.php)
(Attention, il y a aussi un fichier cakephp/app/index.php qui pointe sur webroot/index.php)
(ROOT doit pointer sur le dossier cakephp/)
Le fichier execute ensuite est cakephp/lib/Cake/bootstrap.php qui lance ./Core/App.php
and so on...

RECHERCHE de materiels

3 methodes :
- recherche generale (sous le menu general) : cakephp/app/View/Elements/menu.ctp
- VUE de recherche : cakephp/app/View/Materiels/find.ctp
- ACTION de recherche : cakephp/app/Controller/MaterielsController (methode find())

ACL (Controle d'acces aux ressources)

NB: Cette section n'est sans doute plus très à jour ; sur ce sujet, il est préférable de lire le document docs/userguide/ACL.doc (ou .pdf)

Synthese sur les droits selon le profil

Profils (roles), dans le sens du pouvoir croissant :
Qq = Utilisateur Quelconque (lambda)
Rp = Responsable
Ad = Administration
Sa = Superadmin

Actions :
C = Create
R = Read (voir, consulter)
U = Update (mettre a jour)
D = Delete (supprimer)
V = Valider un materiel CREATED --> passe alors en statut VALIDATED
A = Demander l'Archivage d'un materiel VALIDATED --> passe alors en statut TOBEARCHIVED
S = Sortir de l'inventaire (Valider une demande d'archivage d'un materiel TOBEARCHIVED) --> passe alors en statut ARCHIVED
E = Exporter

Par defaut, le superadmin a acces a TOUT

Materiels :
- Qq a les droits C, R (sauf champs admin), U (si createur et sauf champs admin), A, D (si CREATED et owner)
- Rp a les droits C, R (sauf champs admin), U (sauf champs admin), D (si CREATED), V, A, E
- Ad a les droits C, R, U (ssi NOT ARCHIVED), D (si CREATED), V, (A mais inutile car fait directement S sans passer par A), S, E

Suivis et Emprunts :
- Dans tous les cas, on ne doit pas pouvoir emprunter ou suivre un materiel non valide (CREATED)
- Qq a les droits C, R, U (si createur), D (si createur)
- Rp a les droits C, R, U, D
- Ad a les memes droits que Rp

VUES specifiques :
- Acces aux Outils : reserve a Rp et Ad (vue contenant des liens vers differentes ressources telles que utilisateurs, materiels, categories...)
- L'administration a une vue resumee sur la page d'accueil (liens directs vers actions a faire)
- L'administration a une vue enrichie de la liste des materiels :
- filtres (y-compris sur ARCHIVED)
- export en CSV (pour tableur Excel)
- upgrade du statut (validation et sortie)

Autres regles (de gestion) importantes :
- un materiel non valide (CREATED) peut etre supprime uniquement par le createur de la fiche, le responsable (Roger), et l'administration
Idem pour la mise a jour de cette fiche
- un materiel valide (VALIDATED) n'est pas supprimable
- les champs ADMINISTRATIFS d'un materiel ne sont visibles et modifiables que par l'administration
- par defaut, la liste des materiels affiche tous les materiels SAUF ceux qui sont sortis de l'inventaire (ARCHIVED) qui sont donc masques.
Il est de toutes facons toujours possible (pour l'administration seulement) de les voir, grace au nouveau filtre "Archives" present sur la liste des materiels
- la recherche doit s'effectuer dans TOUS les materiels (y-compris ARCHIVED)

COMMENT CONTOURNER LE LDAP officiel

(ATTENTION: CONTENU OBSOLETE A METTRE A JOUR (EP))

(cf Controller/UtilisateursController.php : methode login())

1) Si on veut tester le LDAP, on peut utiliser le LDAP de la Virtual Machine Upsilon (CentOS 6)
Dans ce cas, il faut ajouter dans la BD les utilisateurs specifiques suivants :

Ajout d'utilisateurs de TEST (LDAP upsilon)
INSERT INTO utilisateurs (nom, login, email, role, groupes_metier_id) VALUES
('Hillembrand Cedric', 'Cedric', 'Cedric.Hillembrand@irap.omp.eu', 'Super Administrateur', 1),
('Turner Daniel', 'Daniel', 'Daniel.Turner@irap.omp.eu', 'Administration', 1),
('Sky Gin', 'Gin', 'Gin.Sky@irap.omp.eu', 'Responsable', 1),
('Robert Henri', 'Henri', 'Henri.Robert', 'Utilisateur', 1);

2) Sinon, le plus simple est d'utiliser un FAUX (fake) LDAP interne a l'application
Dans ce cas, il faut decommenter la variable $fakeLDAP dans le fichier config.php et ajouter dans la BD les utilisateurs specifiques suivants :

Ajout d'utilisateurs de TEST (hors LDAP)
INSERT INTO utilisateurs (nom, login, email, role, groupes_metier_id) VALUES
('Hubert SuperAdmin', 'superadmin', 'hubert.superadmin@irap.omp.eu', 'Super Administrateur', 1),
('Pierre Responsable', 'responsable', 'pierre.resp@irap.omp.eu', 'Responsable', 2),
('Jean Administration', 'admin', 'Jean.Administration@irap.omp.eu', 'Administration', 5),
('Jacques Utilisateur', 'user', 'Jacques.Utilisateur@irap.omp.eu', 'Utilisateur', 7);

Informations sur le LDAP :

Classe LdapAuthComponent (extends AuthComponent), definie dans : app/Controller/Component/LdapAuthComponent.php

Definition des roles (ACL) : app/Model/Utilisateur.php :
private $acceptedRoles = array ('Utilisateur', 'Responsable', 'Administration', 'Super Administrateur');
public function getAuthenticationLevelFromRole($role) {
if ($role 'Utilisateur')
return 1;
elseif ($role 'Responsable')
return 2;
elseif ($role 'Administration')
return 3;
elseif ($role 'Super Administrateur')
return 4;
return 0;
}

Lecture du fichier de config : app/Model/LdapConnection.php :
private function checkConfiguration()

Workflow du LDAP :
1) Page d'accueil : j'entre mon login et pwd
2) clic sur bouton "Se Connecter" --> execute l'action Utilisateurs/login (dans app/Controller/UtilisateursController.php)

COMMENT AJOUTER UNE NOUVELLE TABLE DANS LA BD

On explique ici ce qu'il faut faire quand on veut ajouter une nouvelle table dans la base de données,
table qui doit être prise en compte dans l'application.
Cette explication est donnée avec 2 exemples.

1) Premier exemple : ajout de la table sur-categorie (EP)

Avant cet ajout, il n'y avait que la table categorie et la table sous-categorie.
Vous trouverez plus de détails sur ce sujet dans la section suivante nommée "COMMENT J'AI FAIT POUR AJOUTER UN 3eme niveau de categorie appele sur_categorie (ou domaine)"

a) impact sur la BD
- ajout d'une nouvelle table sur_categories(id,nom) :
CREATE TABLE IF NOT EXISTS sur_categories (
id int(11) NOT NULL AUTO_INCREMENT,
nom varchar(45) DEFAULT NULL,
PRIMARY KEY (id),
UNIQUE KEY nom_UNIQUE (nom)
) ENGINE=InnoDB DEFAULT CHARSET=latin1;

- ajout dans la table categories d'une cle etrangere sur_categorie_id :
ALTER TABLE categories
ADD sur_categorie_id INT NULL DEFAULT NULL,
ADD CONSTRAINT fk_sur_categorie_id FOREIGN KEY (sur_categorie_id) REFERENCES sur_categories (id) ON DELETE NO ACTION ON UPDATE NO ACTION;

- ajout dans la table materiels d'une cle etrangere sur_categorie_id :
ALTER TABLE materiels
ADD sur_categorie_id INT NOT NULL after designation,
ADD CONSTRAINT fk_materiels_sur_categorie_id FOREIGN KEY (sur_categorie_id) REFERENCES sur_categories (id) ON DELETE NO ACTION ON UPDATE NO ACTION;

(attention, il faut d'abord vider les lignes des tables suivis, emprunts, et materiels)
delete from suivis;
delete from emprunts;
delete from materiels;

Il faut aussi ajouter des sur-categories :

Ajout de quelques sur-categories
insert into sur_categories (id,nom) values
(1,'Electronique'),
(2,'Informatique'),
(3,'Instrumentation')
(4, 'Logistique'),
(5, 'Mecanique'),
(6, 'Optique')
;

Relier toutes les categories a une sur-categorie (la 1)
update categories set sur_categorie_id=1 where id<10;
update categories set sur_categorie_id=2 where id>=10 and id<20;
update categories set sur_categorie_id=3 where id>=20;

b) impact sur les modeles (cakephp/app/Model)
- Ajout du nouveau modèle SurCategorie.php : copie de Categorie.php avec "hasMany categorie"
- Modif du modèle Categorie.php : + belongsTo="SurCategorie"

c) impact sur les controleurs (cakephp/app/Controller)
- Ajout du nouveau controleur SurCategoriesController.php : minimaliste (comme CategoriesController)
- Modif du controleur CategoriesController.php : +getBySurCategorie()

d) impact sur les vues (cakephp/app/View)
- SurCategorie : no view (scaffold ?)
- Categorie : actuellement no view (scaffold ?)
--> creer une vue (comme SousCategorie)
+ get_by_surcategorie.ctp
+ scaffold.form.ctp

e) View/Pages/tools.ctp : ajouter une entree au menu pour les Sur-Categories

f) impact sur TOUTES les vues de Materiel
add/edit/view/index
dans la vue index, remplacer la categorie par la sur-categorie
GROS BOULOT sur la vue ADD/EDIT (+ javascript)

2) Deuxième exemple : ajout de la table type_suivis (VM)

Un peu plus haut est expliqué comment créer une table, je vais ici expliquer comment créer et remplir tout ce qui est basiquement
nécessaire pour l'utiliser, en prenant pour exemple la table type_suivis.

Après avoir créé la table, on lui crée :
- Un controller : Héritant de AppController, avec une variable $scaffold sui se chargera de presque tout et une variable $name avec son nom.
- Un model : Avec la même variable $name et une variable $displayField qui correspond a la designation dans la BDD (ex: "nom");
Il doit contenir la fonction typeSuiviNameIsUnik($name) {} (qu'on retrouve dans sites ou organisme) ainsi que le $validate comprenant les validations necessaires.
- Une vue, selon l'utilité, n'est pas forcément nécessaire grâce au scaffold.
Par la suite, pour lister son contenu via un lien dans "outils" par exemple, il suffit de créer le chemin dans view/pages/tools.ctp.

CREER UN CHAMP DATE (VM)

Pour expliquer comment créer un champ date fonctionnel, je vais prendre l'exemple de la Date de reception.
Une fois vôtre colonne créé dans la table marteriel, vous devrez faire des modifications dans :

MaterielController : //Passer la date au format français

if(isset($this->request->data['Materiel']['date_reception'])){
        $this->request->data['Materiel']['date_reception'] = date("d-m-Y", strtotime($this->request->data['Materiel']['date_reception'])); }

le Model Materiel : Créer un champ de validation adapté à la date, avec un regex. Et surtout remplir le formatage de date à l'américaine :

if (isset($this->data['Materiel']['date_reception'])) {
            $originalDate = $this->data['Materiel']['date_reception'];
            $this->data['Materiel']['date_reception'] = date("Y-m-d", strtotime($originalDate));
        }

La vue Materiel : - Scaffold.view : Repasser la date en français et l'afficher.
- Scaffold.form : Créer le champ date du formulaire

Puis il faut adapter le champ date reception presque partout ou il y a le champ date acquisition.

COMMENT J'AI FAIT POUR AJOUTER UN 3eme niveau de categorie appele sur_categorie (ou domaine) (EP) ?

je me rends compte d'une incoherence de stockage dans la table Materiels.
En effet, quand on saisit un materiel, on doit choisir une categorie ET une sous-categorie.
Du coup, les 2 id (categorie + sous-categorie) sont stockes dans la table Materiels...
Or, c'est inutile car la sous-categorie suffit a determiner la categorie...
Cette redondance pourrait meme amener des incoherences dans la table Materiels si par exemple on fait des modifications
dans les tables categories et sous_categories sans les repercuter dans la table materiels !!
Je suppose que c'est un choix de facilite qui a ete fait par upsilon.

Donc, si vous etes ok, et a moins que Upsilon me dise qu'il y avait une bonne raison de faire ce choix (j'en doute),
je propose de modifier le code pour que seule la sous-categorie soit stockee (on ne stocke plus la categorie).

En plus, cela simplifiera l'ajout du 3eme niveau "sur-categorie" puisque lui-meme n'aura pas besoin d'etre stocke etant donne qu'il est automatiquement determine par la categorie.
On aura alors :
sous_categorie_id -> categorie_id -> sur_categorie_id
Avec seulement la sous_categorie, on pourra determiner la categorie, et donc la sur_categorie.

Du coup, si je fais cette modif, on pourrait meme se permettre de demarrer officiellement INVENTIRAP rapidement.
En effet, l'ajout de la sur-categorie ne change rien au contenu des tables "administratives" (materiels, emprunts, suivis),
et donc on pourra le faire plus tard, meme apres que l'administration ait commence a remplir la BD.
Ca sera totalement transparent.

1) suppression de la redondance (categorie_id) dans la table materiels

a) impact sur la vue index de Materiel
add/edit/view/index

2) ajout d'une sur-categorie

(attention, il faut d'abord vider les lignes des tables suivis, emprunts, et materiels)
delete from suivis;
delete from emprunts;
delete from materiels;

Il faut aussi ajouter des sur-categories :

Ajout de quelques sur-categories
insert into sur_categories (id,nom) values
(1,'Electronique'),
(2,'Informatique'),
(3,'Instrumentation')
(4, 'Logistique'),
(5, 'Mecanique'),
(6, 'Optique')
;

Relier toutes les categories a une sur-categorie (la 1)
update categories set sur_categorie_id=1 where id<10;
update categories set sur_categorie_id=2 where id>=10 and id<20;
update categories set sur_categorie_id=3 where id>=20;

b) impact sur les modeles (cakephp/app/Model)
- SurCategorie.php : copie de Categorie.php avec "hasMany categorie"
- Categorie.php : + belongsTo="SurCategorie"

c) impact sur les controleurs (cakephp/app/Controller)
- SurCategoriesController.php : minimaliste (comme CategoriesController)
- CategoriesController.php : +getBySurCategorie()

e) View/Pages/tools.ctp : ajouter une entree au menu pour les Sur-Categories

f) impact sur TOUTES les vues de Materiel
add/edit/view/index
dans la vue index, remplacer la categorie par la sur-categorie
GROS BOULOT sur la vue ADD/EDIT (+ javascript)

TESTS

A - EXECUTION

Prérequis : PHPUNIT 3 doit être déjà installé et accessible depuis la console (phpunit -version) via le fichier php.ini
(ATTENTION : cakephp 2.x n'est pas compatible avec PhpUnit 4)

Avec XAMPP (conseillé) : PhpUnit 3 est déjà inclus
Avec MAMP (+ difficile) : pour installer PhpUnit, suivre cette documentation : http://www.dolinaj.net/software-installation/mac/how-to-install-phpunit-with-mamp-on-mac/

Procédure à suivre pour pouvoir exécuter les tests unitaires et fonctionnels livrés avec le logiciel :

1) Ajouter une nouvelle configuration de base de données dans votre fichier app/Config/database.php pour la BD de test

Exemple de configuration :

public $test = array(
        'datasource' => 'Database/Mysql',
        'persistent' => false,
        'host' => 'localhost',
        'database' => 'test_labinvent',
        'login' => 'root',
        'password' => '',
    );

2) Créer la BD de test (vide)
A l'aide de phpmyadmin ou bien avec un client mysql quelconque,
créer une BD de test vide que vous nommerez avec le même nom que celui donné dans la configuration ci-dessus,
soit pour l'exemple, "test_labinvent"
Syntaxe SQL : "create database test_labinvent"

3) Passer en mode "debug"
Dans votre fichier de configuration labinvent.php, mettez votre paramètre "debug" à 1 ou 2 (mais pas à 0) :
'debug' => 2,

4) Se connecter à l'application
Les test ne passeront pas si vous n'êtes pas connectés

5) Exécuter les tests

a) Exécution depuis l'application (conseillé) :
ATTENTION : vous devez être logué pour que les tests passent !!!
Il suffit d'aller à l'URL /test.php de votre installation du logiciel LabInvent
(vous pouvez aussi essayer l'URL "/app/webroot/test.php", ou encore "/cakephp/test.php")
Cette page de tests se trouve dans cakephp/app/webroot/
Vous avez alors accès à 2 types de tests :
- App : Tests > les tests écris pour tester l'application Labinvent
- Core : Tests > les tests fournis avec cakephp pour tester le framework
Pour exécuter tous les tests liés à l'application Labinvent (à faire systématiquement avant de commiter tout changement) :
cliquer sur "Tests" sous "App", puis sur "AllTests"
("AllController" exécute tous les tests de controleurs ; "AllModel" exécute tous les tests de modèles)

b) Execution depuis la console :
Aller dans le repertoire app/
Pour tester le controleur MaterielsController :
./Console/cake test app Controller/MaterielsController

B - ECRITURE DE NOUVEAUX TESTS

cf http://book.cakephp.org/2.0/en/development/testing.html

Aller dans app/Test/

Ce dossier contient l'arborescence suivante :

- Case/ : les tests
- Controller/ : les tests de controleurs
- Model/ : les tests de modèles
- View/ (peu ou pas utilisé) : les tests de vues (ou de helpers)
- AllControllerTest.php : exécution de tous les tests de controleurs
- AllModelTest.php : exécution de tous les tests de modèles
- AllTestsTest.php : éxécution de TOUS les tests

- Fixture/ : les différentes initialisations nécessaires dans la BD de test pour pouvoir executer les tests
Ces "fixtures" sont automatiquement executees AU DEBUT de chaque test.
Ce dossier contient un fichier pour chaque table pour laquelle on a besoin d'une "fixture".

1) Les "fixtures"

La façon la plus basique de creer une fixture pour une table donnee est de la realiser automatiquement a partir d'une copie de la table de la vraie BD.
Par exemple, pour que la table "categories" de la BD de test contienne la meme chose que la table de la vraie BD, il suffit de creer un fichier CategorieFixture.php contenant ceci :

class CategorieFixture extends CakeTestFixture {
public $import = array('model' => 'Categorie', 'records' => true);
}

Au demarrage des tests, cette table sera chargee automatiquement avec les vraies donnees.
A la fin des tests, cette table sera vidée.

Dans le cas particulier de la table "materiels", on prefere l'initialiser nous-memes avec des valeurs choisies.
Exemple d'une fixture avec 2 materiels (dans le fichier MaterielFixture.php) :

class MaterielFixture extends CakeTestFixture {

public $import = 'Materiel'; // import only structure, no record

public $records = array(
            array(
                    'designation' => 'matos1', 
                    'sur_categorie_id' => 1, 
                    'categorie_id' => 11, 
                    'materiel_administratif' => 0, 
                    'materiel_technique' => 1, 
                    'status' => 'CREATED', 
                    'nom_createur' => 'Pallier Etienne', 
                    'nom_modificateur' => 'Jean Administration', 
                    'nom_responsable' => 'Jacques Utilisateur', 
                    'email_responsable' => 'Jacques.Utilisateur@irap.omp.eu', 
            ),
            array(
                    'designation' => 'matos2',
                    'sur_categorie_id' => 1,
                    'categorie_id' => 11,
                    'materiel_administratif' => 0,
                    'materiel_technique' => 1,
                    'status' => 'CREATED',
                    'nom_createur' => 'Pallier Etienne',
                    'nom_modificateur' => 'Jean Administration',
                    'nom_responsable' => 'Jacques Utilisateur',
                    'email_responsable' => 'Jacques.Utilisateur@irap.omp.eu',
            ),
    );
}

2) Les tests

Prenons l'exemple des tests ecrits pour le controleur des materiels (MaterielsController). Il devra s'appeler MaterielsControllerTest et aura la structure suivante :

class MaterielsControllerTest extends ControllerTestCase {

// Liste des fixtures à charger avant l'execution des tests
    public $fixtures = array('app.materiel', 'app.sur_categorie', 'app.categorie', 'app.sous_categorie', 
            'app.groupes_thematique', 'app.groupes_metier', 'app.suivi', 'app.emprunt'
    );

// Initialisations diverses a faire avant chaque test
    public function setUp() {
        parent::setUp();
    }

// un 1er test    
    public function testMonPremier() {
        $result = $this->testAction(...);
        $this->assert...('resultat attendu', $result);
    }

// un 2eme test
    public function testMonDeuxieme() {
        $result = $this->testAction(...);
        $this->assert...('resultat attendu', $result);
    }

...

}

Voir le vrai fichier Test/Case/Controller/MaterielsControllerTest.php

3) Execution

Exemple avec l'execution du test MaterielsControllerTest

a) Execution depuis le site web :
/test.php?case=Controller%2FMaterielsController
Ajouter &debug=1 à l'url pour voir tous les messages de debug

b) Execution depuis la console :
Dans le repertoire app : ./Console/cake test app Controller/MaterielsController
Ajouter --debug pour voir tous les messages de debug

DATE PICKERS

Pour fontionner, le datePicker fait appel dans la page "View/Layout/default" à 3 scripts (jquery-1.5.2.js, jquery-1.8.12.js, DatepickerConfig.js)
présents dans le repertoire "webroot/js/" et à un fichier "Theme" (smoothness.css) présent dans le repertoire "webroot/css/"

Le thème global peut très facilement être changé en téléchargeant le fichier css de son choix, à cette adresse: "http://jqueryui.com/themeroller/"
et en remplaçant celui se trouvant dans "webroot/css/"

Les options du datePicker sont modifiables dans le fichier "webroot/js/DatepickerConfig.js" et sont assez explicites.
Malgré cela, pour plus de précisions, la doc est facilement consultable à cette adresse: "http://jqueryui.com/datepicker/"

A L'ATTENTION DES UTILISATEURS D'ECLIPSE¶

0) Installer Eclipse (Si nécessaire), voire Java

En effet, même si la version que vous allez installer est une version pour PHP, Eclipse à besoin de Java pour pouvoir s'exécuter.
Vérifiez que Java soit bien installé sur votre système :

java -version

Si ce n'est pas le cas, exécutez les lignes suivantes :

sudo apt-add-repository ppa:webupd8team/java
sudo apt-get update
sudo apt-get install oracle-java8-installer

Pour installer Eclipse, allez sur : http://www.eclipse.org/downloads/packages/release/Neon/3
Selectionnez la version que vous désirez (Neon, Oxygen, Mars ...) puis sélectionnez "Eclipse for PHP Developers".
Téléchargez la version correspondant à votre système d'exploitation.
Placez-vous dans le dossier ou vou voulez installer Eclipse avec l'archive précédement téléchargée (renommez-la en eclipse.tar.gz), puis exécutez la commande suivante :

tar -zxvf eclipse.tar.gz

Si vous voulez Eclipse dans le menu des applications sous Ubuntu, il vous faudra crééer le fichier eclipse.desktop :

gksudo gedit /usr/share/applications/eclipse.desktop

puis collez-y ce qui suit, en modifiant le chemin des lignes Exec et Icon au besoin :

[Desktop Entry]
Name=Eclipse 
Type=Application
Exec=/opt/eclipse/eclipse
Terminal=false
Icon=/opt/eclipse/icon.xpm
Comment=Integrated Development Environment
NoDisplay=false
Categories=Development;IDE
Name[en]=eclipse.desktop

Puis donnez les droits à tous les utilisateurs sur ce fichier :

sudo chmod a+r /usr/share/applications/eclipse.desktop

1) Désactiver la vérification du certificat

Window -> Preferences -> Team -> git -> configuration -> Add entry

Key = http.sslVerify
Value = false

2) Récupérer le projet

(Si le projet git n'existe pas déjà sur votre machine)

File/Import project from git

Select repository source: Clone URI: https://gitlab.irap.omp.eu/epallier/labinvent.git

Directory:
- par défaut, il propose : /Users/epallier/git/labinvent
- mais on peut le mettre n'importe où ailleurs,
par exemple, on pourrait le mettre directement dans le repertoire web de Apache:
/Applications/XAMPP/xamppfiles/htdocs
(si on veut que le projet s'execute directement dans le dossier web apache htdocs, mais ca n'est pas obligatoire...)

initial branch: master
remote name: origin

Import as general project

Project name: LABINVENT

(si le projet git existe déjà sur votre machine)

File/Import project from git

Existing local repository

Installer un serveur LDAP et un serveur web sur deux VMs différentes¶

Si vous êtes là c'est que vous avez déjà une VM avec votre serveur web, sinon je vous renvoie à la page d'installation du serveur web :

https://projects.irap.omp.eu/projects/inventirap/wiki/Installation

Ceci est une VM LDAP déjà installée et configurée (si vous en avez pas déjà) :

https://www.turnkeylinux.org/openldap

Après avoir installer vos deux VMs, on va les configurer.

Par la suite, j'utiliserais ces termes pour éviter de tout réécrire à chaque fois :

Machine hôte = Machine physique avec laquelle vous travaillez
VM_1 = Machine virtuelle qui héberge votre serveur Web/Apache/MySQL ...
VM_2 = Machine virtuelle qui héberge votre serveur LDAP

La configuration qui a servi a réaliser ce tutoriel :

Machine hôte : Windows 7 Pro 64bits
VM_1 : Ubuntu 14.04.5 32bits
VM_2 : TURNKEY OPENLDAP 64bits

A faire sur la machine hôte :

Configuration des 2 cartes réseau de la VM_1 :

Carte n°1 :

Activer la carte réseau
Mode d'accès : NAT

(Si vous voulez pouvoir utiliser votre serveur web depuis votre machine hôte)

-> Avancé -> Redirection de ports

Ajoutez une règle de redirection :
IP hôte : 127.0.0.1
Port hôte : 8080
Port invité : 80
(Le reste n'y touchez pas)

(Un exemple)

Carte n°2 :

Activer la carte réseau
Mode d'accès : Réseau interne
Nom : Connexion_LDAP (ceci est un exemple, mettez ce que vous voulez)
-> Avancé
Mode Promiscuité : Tout autoriser

(Un exemple)

Configuration de la carte réseau de la VM_2 :

Carte n°1 :

Activer la carte réseau
Mode d'accès : Réseau interne
Nom : Connexion_LDAP (ceci est un exemple, mettez ce que vous voulez, faut juste que ce soit le même que celui de la carte 2 de la VM_1)
-> Avancé
Mode Promiscuité : Tout autoriser

(Un exemple)

Voila, on est bon pour la machine hôte, maintenant on passe à la configuration des VMs.

A faire sur la VM_1 :

Carte réseau n°1 : Adresse IPv4 : Méthode d’obtention : DHCP

Carte réseau n°2 : Adresse IPv4 : Méthode d’obtention : Manuelle :

Adress (Adresse): 192.168.1.2
Netmask (Masque de sous-réseau) : 255.255.255.0
Gateway (Passerelle) : 255.255.255.0

Cela devrait ressembler plus ou moins à ceci :

A faire sur la VM_2 :

-> Advanced Menu -> Networking -> StaticIP

IP Adress : 192.168.1.3
Netmask : 255.255.255.0
(laissez le reste vide)

-> Apply

Cela devrait ressembler à ça :

Et voila, maintenant pour accéder à votre site depuis votre machine hôte, rendez-vous à l'adresse 127.0.0.1:8080 dans votre navigateur préféré.
Pour ce qui est du LDAP, les adresses vous sont données en page d'accueil lorsque vous lancez votre VM LDAP. Sachez cependant que votre machine hôte ne pourra en aucun cas communiquer avec la VM LDAP, et vice-versa. Le LDAP, quand à lui, n'aura aucun accès à internet.

BDD_IRAP.png (171 KB) Alexandre Cases, 06/30/2016 03:40 pm

equipment_status_state_diagram.png (144 KB) Etienne Pallier, 07/07/2016 02:35 pm

equipment_interactions_sequence_diagram.png (156 KB) Etienne Pallier, 07/07/2016 02:35 pm

ACLs Droits selon les Roles.pdf (44.1 KB) Etienne Pallier, 07/08/2016 06:30 pm

Config_cartes_reseau_VM_1.png (608 KB) Thibaud Ajas, 05/23/2017 04:47 pm

Config_cartes_reseau_VM_1_unDemi.png (285 KB) Thibaud Ajas, 05/23/2017 04:50 pm

Config_cartes_reseau_VM_1.png (365 KB) Thibaud Ajas, 05/23/2017 04:53 pm

Config_carte1_VM_1.png (127 KB) Thibaud Ajas, 05/23/2017 05:09 pm

Config_carte2_VM_1.png (54.4 KB) Thibaud Ajas, 05/23/2017 05:09 pm

Config_carte1_VM_2.png (66.9 KB) Thibaud Ajas, 05/23/2017 05:09 pm

Config_carte_reseau_VM_2.png (5.05 KB) Thibaud Ajas, 05/23/2017 05:18 pm

BDD_schema.png (367 KB) Etienne Pallier, 06/16/2017 05:16 pm

LABINVENT (InventIrap)

Wiki

Labinvent 2 (cakephp3) - Développement¶

LIENS UTILES¶

CONVENTIONS CAKEPHP¶

TODOLIST¶

A propose de Composer¶

Modèle de données (Data model)¶

Schéma de la base de données (v2.6)¶

Schéma de la base de données (v2.0)¶

Cycle de vie du Matériel¶

Diagramme d'états-transitions¶

Diagramme de séquences¶

ACL - Gestion des droits selon le profil¶

Deux environnements de dev pour avoir php5.6 et php7.X¶

Utilisation du serveur web de dev de CakePHP (à la place de apache)¶

ROADMAP - Plan de développement¶

COMMIT : Procédure à suivre à chaque commit¶

Procédure à suivre pour MERGER le code entre 2 labos¶

Installation from scratch (Sous UBuntu)¶

Création projet avec Composer¶

Modification de la base de données¶

Autres remarques lors du développement¶

Installation sur Mac (retour des pb)¶

Pour mettre à jour CakePHP¶

Pour utiliser php5.6 ET php7.0 sur le même OS (Fonctionne avec Ubuntu 14.04.5 - le 02/05/2017)¶

Rappel d'intervention par mail¶

AMELIORATIONS A VENIR (TODO)¶

1) POUR LE CODE SOURCE¶

2) POUR LES TESTS¶

HOWTO (nouvelle version avec CakePhp3)¶

1) AUTHentication (authentification = connexion avec login) : Chemin parcouru lors d'une connexion au site web¶

2) AUTHorization (ACL, Autorisations, roles, profils des utilisateurs connectés)¶

3) Ajouter une nouvelle action sur un controleur¶

4) Champ facultatif/obligatoire : Comment rendre facultatif ou obligatoire un champ, et définir les vérifications à faire sur ce champ ?¶

HOWTO (ancienne version LabInvent 1.3 avec CakePhp2)¶

A L'ATTENTION DES UTILISATEURS D'ECLIPSE¶

Installer un serveur LDAP et un serveur web sur deux VMs différentes¶