Menu : | html | yaml | json | edit | check | reindex | dump | unset |
name | yamldoc.inc.php | ||||||||||||||||||
title | yamldoc.inc.php - classes abstraites Doc et YamlDoc et interface YamlDocElement | ||||||||||||||||||
doc |
La classe abstraite Doc correspond à un document affichable ; certains documents ne sont pas des documents YamlDoc comme par exemple PdfDoc ou OdtDoc La classe abstraite YamlDoc correspond à un document Yaml. L'interface YamlDocElement définit l'interface que doit respecter un élément de YamlDoc. | ||||||||||||||||||
journal |
|
title | classe abstraite correspondant à un document affichable |
doc |
La classe abstraite Doc définit:
- 2 méthodes abstraites que chaque sous-classe doit définir
- des fonctions génériques utiles aux sous-classes
En plus de définir les 2 méthodes abstraites, une classe héritant de Doc doit aussi
soit définir la méthode __get(), soit définir les 6 propriétés suivantes:
- $authorizedReaders, $authRd, $authorizedWriters, $authWr
- $yamlPassword |
title | classe abstraite correspond à un document Yaml |
doc |
La classe abstraite YamlDoc définit:
- 4 méthodes abstraites que chaque sous-classe doit définir
- des fonctions génériques utiles aux sous-classes
- des méthodes statiques s'appliquant à des fragments structurés comme array Php
En plus de définir les 4 méthodes abstraites, une classe héritant de YamlDoc doit aussi
soit définir la méthode __get(), soit définir les 6 propriétés suivantes:
- $authorizedReaders, $authRd, $authorizedWriters, $authWr
- $yamlPassword |
title | Declaration de l'interface 'YamlDocElement' |
doc |
Tout élément d'un YamlDoc doit être soit: - un type Php généré par l'analyseur Yaml y compris des objets de type DateTime - un objet d'une classe conforme à l'interface YamlDocElement Un YamlDocElement possède les méthodes: - extract(string $ypath) // extrait le sous-élément de l'élément défini par $ypath - asArray() // décapsule l'objet et retourne son contenu sous la forme d'un array |