scores/webservice
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Ajout documentation

Browse Source
This commit is contained in:
Michael RICOIS 2012-08-03 19:23:35 +00:00
parent 29a5948892
commit 32083229ba
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/README.txt
View File

@ -48,6 +48,26 @@ retrouve visible dans le service (wsdl, requête)
Si des fonctions ne doivent pas être rendu visible il faut donc les séparer Si des fonctions ne doivent pas être rendu visible il faut donc les séparer
dans un autre controller utilisant une autre class. dans un autre controller utilisant une autre class.
Documentation des méthodes et ajout spécial
===========================================
La documentation est géneré en automatique.
Voici comment définir simplement la documentation d'une méthode
/**
* Retourne les informations identitaires de l'entreprise ou de l'établissement demandé
* @param string $key Siren de l'entreprise ou siret de l'établissement
* @return Identite
*/
public function test($key)
{
}
Attention ces informations servent aussi pour la structure du WSDL
Pour spécifier un lien vers un fichier ou pour générer un fichier depuis une Pour spécifier un lien vers un fichier ou pour générer un fichier depuis une
requête SQL à partir de la documentation du service. requête SQL à partir de la documentation du service.
Ajouter dans le docblock : Ajouter dans le docblock :
@ -59,6 +79,10 @@ Ajouter dans le docblock :
Les fichiers a télécharger sont à placer dans le répértoire public/fichier et Les fichiers a télécharger sont à placer dans le répértoire public/fichier et
les fichiers sql dans public/sql les fichiers sql dans public/sql
Pour spécifier des éléments de taille (non pris en compte sur le WSDL)
@xsd minLength=9
@xsd maxLength=15
Configuration PHP Configuration PHP
================= =================