DefiningFile
extends PhpFile
in package
Fichier Php avec les blocs dont certains sont des définitions de classe ou fonction
Table of Contents
Constants
- EXCLUDED = ['.', '..', '.git', '.phpdoc', 'vendor', 'shomgeotiff', 'gan', 'data', 'temp']
- liste des sous-répertoires exclus du parcours lors de la construction de l'arbre
Properties
- $blocks : array<string|int, PhpBlock>
- $includes : array<int, string>
- $namespace : string
- $root : string
- $rpath : string
- $title : string
Methods
- __construct() : mixed
- asArray() : array<string|int, mixed>
- Retourne l'objet comme array.
- blocksAsHtml() : string
- représente les blocks contenus dans le fichier comme une table Html
- buildTree() : array<string, mixed>|PhpFile
- Construit et retourne l'arbre des répertoires et fichiers
- chooseClassOrFunction() : void
- parcourt tous les fichiers Php pour afficher les classes et les fonctions définies
- chooseFile() : void
- affiche tous les noms de fichiers avec un lien vers chacun
- classes() : array<string, PhpClass>
- Récupère les classes dans les blocks
- functions() : array<string, PhpFunction>
- Récupère les fonctions dans les blocks
- includes() : array<int, string>
- Retourne la liste des fichiers inclus dans le fichier Php.
- namespace() : string
- retourne le namespace du fichier ou '' si aucun n'est défini
- title() : string
- Retourne le titre du fichier extrait du commentaire PhpDoc
- treeAsArray() : array<string|int, mixed>
- transforme l'arbre des fichiers en un arbre composé d'Array.
Constants
EXCLUDED
liste des sous-répertoires exclus du parcours lors de la construction de l'arbre
public
mixed
EXCLUDED
= ['.', '..', '.git', '.phpdoc', 'vendor', 'shomgeotiff', 'gan', 'data', 'temp']
Properties
$blocks read-only
public
array<string|int, PhpBlock>
$blocks
liste des blocks contenus dans le fichier
$includes read-only
public
array<int, string>
$includes
liste des fichiers inclus
$namespace read-only
public
string
$namespace
$root
public
static string
$root
chemin de la racine de l'arbre
$rpath read-only
public
string
$rpath
chemin relatf par rapport à $root
$title read-only
public
string
$title
Methods
__construct()
public
__construct(string $rpath[, TokenArray $tokens = null ]) : mixed
Parameters
- $rpath : string
- $tokens : TokenArray = null
asArray()
Retourne l'objet comme array.
public
asArray() : array<string|int, mixed>
Return values
array<string|int, mixed>blocksAsHtml()
représente les blocks contenus dans le fichier comme une table Html
public
blocksAsHtml() : string
Return values
stringbuildTree()
Construit et retourne l'arbre des répertoires et fichiers
public
static buildTree(string $class[, string $rpath = '' ][, bool $verbose = false ]) : array<string, mixed>|PhpFile
Structure récursive de l'arbre: TREE ::= PhpFile # pour un fichier | {{rpath} => TREE} # pour un répertoire
Peut être appelé avec un nom de sous-classe de PhpFile pour construire un arbre d'objet de cette sous-classe.
Parameters
- $class : string
- $rpath : string = ''
- $verbose : bool = false
Return values
array<string, mixed>|PhpFilechooseClassOrFunction()
parcourt tous les fichiers Php pour afficher les classes et les fonctions définies
public
static chooseClassOrFunction([string $rpath = '' ]) : void
Parameters
- $rpath : string = ''
chooseFile()
affiche tous les noms de fichiers avec un lien vers chacun
public
static chooseFile(string $action[, string $rpath = '' ]) : void
Parameters
- $action : string
- $rpath : string = ''
classes()
Récupère les classes dans les blocks
public
classes() : array<string, PhpClass>
Return values
array<string, PhpClass>functions()
Récupère les fonctions dans les blocks
public
functions() : array<string, PhpFunction>
Return values
array<string, PhpFunction>includes()
Retourne la liste des fichiers inclus dans le fichier Php.
public
includes(TokenArray $tokens) : array<int, string>
Si le fichier inclus est dans root alors fournit un path relatif par rapport à root avec {root} au début du chemin. Si le fichier inclus n'existe pas alors:
- signale une erreur
- retourne le chemin absolu suivi de " (BAD)"
Parameters
- $tokens : TokenArray
Return values
array<int, string>namespace()
retourne le namespace du fichier ou '' si aucun n'est défini
public
namespace(TokenArray $tokens) : string
Parameters
- $tokens : TokenArray
Return values
stringtitle()
Retourne le titre du fichier extrait du commentaire PhpDoc
public
title(TokenArray $tokens) : string
Parameters
- $tokens : TokenArray
Return values
stringtreeAsArray()
transforme l'arbre des fichiers en un arbre composé d'Array.
public
static treeAsArray(array<string|int, mixed>|PhpFile $tree) : array<string|int, mixed>
Parameters
- $tree : array<string|int, mixed>|PhpFile