phpDocumentor

UsingFile extends PhpFile
in package

Fichier Php avec les utilisations de fonctions et classes

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

$includes  : array<int, string>
$namespace  : string
$root  : string
$rpath  : string
$title  : string
$uses  : array<int, PhpUse>

Methods

__construct()  : mixed
Création des utilisations de fonctions et classes à partir d'un fichier Php
asArray()  : array<string|int, mixed>
Retourne l'objet comme array.
buildTree()  : array<string, mixed>|PhpFile
Construit et retourne l'arbre des répertoires et fichiers
chooseFile()  : void
affiche tous les noms de fichiers avec un lien vers chacun
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.
usingClassOrFunction()  : void
Affiche les appels à la classe ou la fonction $name

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

$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

$uses read-only

public array<int, PhpUse> $uses

liste des utilisations détectées dans le fichier

Methods

__construct()

Création des utilisations de fonctions et classes à partir d'un fichier Php

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>

buildTree()

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>|PhpFile

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 = ''

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
string

title()

Retourne le titre du fichier extrait du commentaire PhpDoc

public title(TokenArray $tokens) : string
Parameters
$tokens : TokenArray
Return values
string

treeAsArray()

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
Return values
array<string|int, mixed>

usingClassOrFunction()

Affiche les appels à la classe ou la fonction $name

public static usingClassOrFunction(string $type, string $name[, string $rpath = '' ]) : void
Parameters
$type : string
$name : string
$rpath : string = '' 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results