Projet

Général

Profil

Amélioration #7252

[utag] L'api Utag manque de cohérence

Ajouté par Charles Bonnissent il y a environ 2 ans.

Statut:
Nouveau
Priorité:
Normal
Assigné à:
-
Version cible:
-
Début:
27/03/2018
Echéance:
% réalisé:

0%

Version source:
Solution proposée:

Déprécier l'ensemble des fonctions et les remplacer par des fonctions de type addUserTag, getUserTag, etc... ayant toute une signature homogène (pas de uid par défaut et un objet tag qui reste sous la même forme que l'on le set ou le get)

Principaux fichiers impactés:
Wiki Détail:
Contrôle:
Jalons:

Description

Les signatures des fonctions et les retours ne sont pas cohérents les uns avec les autres.

Les fonctions en cause sont les suivantes :

  • final public function getUTag($tag, $allrevision = true, $uid = null) => @return bool|DocUTag
  • final public function delUTag($uid, $tag, $allrevision = true) => @return string error message
  • final public function hasUTag($tag, $allrevision = true) => @return bool
  • final public function addUTag($uid, $tag, $datas = "", $allrevision = true) => @return string error message

Alors, les soucis sont les suivants :

  • certaines fonctions prennent en entrée uid, d’autres le déduise du contexte, d’autres ne permettent pas de le passer, ce qui aboutit a des signatures incohérentes dans leur ordonnancement et dans le côté optionnel des paramètres,
  • le utag passe d’une string (addUTag) a un objet (getUTag) => le simple code suivant (qui devrait être idempotent) est impossible $doc->addUTag(“myTag”, $doc->getUTag(“myTag”));

Formats disponibles : Atom PDF