<usesrole>

<usesrole> – Documente les fichiers de rôles personnalisés utilisés dans la balise <contents>

Documenter les fichiers de rôles personnalisés

Les fichiers de rôles standards, fournis par défaut avec PEAR, sont :

  • php

  • data

  • doc

  • test

  • script

  • src

  • ext

Si votre paquet choisit d'utiliser un rôle fourni par une troisième partie qui implémente un gestionnaire de fichiers d'installations avancés, tout ce dont vous avez à faire est de spécifier le rôle dans le xml, dans la balise <file>, comme ceci :

<file role="foo"/>

Dependant, si un utilisateur n'a pas installé le paquet qui fournit le rôle personnalisé "foo", alors, le message d'erreur lors de l'installation affichera simplement : "unknown role 'foo'", ce qui n'est pas très parlant.

La balise <usesrole> informe l'installeur d'informer l'utilisateur en ces termes : "this package uses the custom role 'foo', install package pear.example.com/Foo to use"

<usesrole>
 <role>foo</role>
 <package>Foo</package>
 <channel>pear.example.com</channel>
</usesrole>

Notez que les paquets URI statiques (paquets supportant les canaux) sont également supportés :

<usesrole>
 <role>foo</role>
 <uri>http://pear.example.com/Foo-1.2.0</uri>
</usesrole>

Dependency Specification in package.xml 2.0 (Previous) Documente une tâche personnalisée dans la balise <contents> (Next)
Last updated: Sun, 29 Aug 2010 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report or add a note.
View this page in:

User Notes:

There are no user contributed notes for this page.