SPIP Code

Documentation du code de SPIP et de ses plugins

SPIP

path.php

Table of Contents

Constants

_SPIP_THEME_PRIVE  = 'spip'

Functions

spip_paths()  : AggregatorInterface
Return unique Aggregator class
spip_paths_loader()  : Loader
_chemin()  : array<string|int, mixed>
Gestion des chemins (ou path) de recherche de fichiers par SPIP
creer_chemin()  : array<string|int, mixed>
Retourne la liste des chemins connus de SPIP, dans l'ordre de priorité
lister_themes_prives()  : array<string|int, string>
Retourne la liste des thèmes du privé utilisables pour cette session
find_in_theme()  : mixed
chemin_image()  : string
Cherche une image dans les dossiers d'images
find_in_path()  : string|bool
Recherche un fichier dans les chemins de SPIP (squelettes, plugins, core)
clear_path_cache()  : mixed
load_path_cache()  : mixed
save_path_cache()  : mixed
find_all_in_path()  : array<string|int, mixed>
Trouve tous les fichiers du path correspondants à un pattern

Constants

_SPIP_THEME_PRIVE

public mixed _SPIP_THEME_PRIVE = 'spip'

Functions

spip_paths()

Return unique Aggregator class

spip_paths([null|array<string|int, mixed> $add = null ]) : AggregatorInterface
Parameters
$add : null|array<string|int, mixed> = null

List of «plugins» directories to add

Return values
AggregatorInterface

spip_paths_loader()

spip_paths_loader() : Loader
Return values
Loader

_chemin()

Gestion des chemins (ou path) de recherche de fichiers par SPIP

_chemin([string|array<string|int, mixed>|null $dir_path = null ]) : array<string|int, mixed>

Empile de nouveaux chemins (à la suite de ceux déjà présents, mais avant le répertoire squelettes ou les dossiers squelettes), si un répertoire (ou liste de répertoires séparés par :) lui est passé en paramètre.

Ainsi, si l'argument est de la forme dir1:dir2:dir3, ces 3 chemins sont placés en tête du path, dans cet ordre (hormis squelettes & la globale $dossier_squelette si définie qui resteront devant)

Retourne dans tous les cas la liste des chemins.

Parameters
$dir_path : string|array<string|int, mixed>|null = null
  • Répertoire(s) à empiler au path
Tags
note

Cette fonction est appelée à plusieurs endroits et crée une liste de chemins finale à peu près de la sorte :

  • dossiers squelettes (si globale précisée)
  • squelettes/
  • plugins (en fonction de leurs dépendances) : ceux qui dépendent d'un plugin sont devant eux (ils peuvent surcharger leurs fichiers)
  • racine du site
  • squelettes-dist/
  • prive/
  • ecrire/
Return values
array<string|int, mixed> —

Liste des chemins, par ordre de priorité.

creer_chemin()

Retourne la liste des chemins connus de SPIP, dans l'ordre de priorité

creer_chemin() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Liste de chemins

lister_themes_prives()

Retourne la liste des thèmes du privé utilisables pour cette session

lister_themes_prives() : array<string|int, string>
Tags
see
inscription_nouveau()

pour une particularité historique du champ 'prefs'

Return values
array<string|int, string> —

Nom des thèmes.

find_in_theme()

find_in_theme(mixed $file[, mixed $subdir = '' ][, mixed $include = false ]) : mixed
Parameters
$file : mixed
$subdir : mixed = ''
$include : mixed = false

chemin_image()

Cherche une image dans les dossiers d'images

chemin_image(string $icone) : string

Cherche en priorité dans les thèmes d'image (prive/themes/X/images) et si la fonction n'en trouve pas, gère le renommage des icones (ex: 'supprimer' => 'del') de facon temporaire le temps de la migration, et cherche de nouveau.

Si l'image n'est toujours pas trouvée, on la cherche dans les chemins, dans le répertoire défini par la constante _NOM_IMG_PACK

Parameters
$icone : string

Nom de l'icone cherchée

Tags
see
find_in_theme()
see
inc_icone_renommer_dist()
Return values
string —

Chemin complet de l'icone depuis la racine si l'icone est trouée, sinon chaîne vide.

find_in_path()

Recherche un fichier dans les chemins de SPIP (squelettes, plugins, core)

find_in_path(string $file[, string $dirname = '' ][, bool|string $include = false ]) : string|bool

Retournera le premier fichier trouvé (ayant la plus haute priorité donc), suivant l'ordre des chemins connus de SPIP.

Parameters
$file : string

Fichier recherché

$dirname : string = ''

Répertoire éventuel de recherche (est aussi extrait automatiquement de $file)

$include : bool|string = false
  • false : ne fait rien de plus
  • true : inclut le fichier (include_once)
  • 'require' : idem, mais tue le script avec une erreur si le fichier n'est pas trouvé.
Tags
see
charger_fonction()
uses
creer_chemin()

Pour la liste des chemins.

example 
$f = find_in_path('css/perso.css');
$f = find_in_path('perso.css', 'css');
used-by
include_spip()
used-by
require_spip()
Return values
string|bool —
  • string : chemin du fichier trouvé
  • false : fichier introuvable

find_all_in_path()

Trouve tous les fichiers du path correspondants à un pattern

find_all_in_path(string $dir, string $pattern[, bool $recurs = false ][, bool $all_files = false ]) : array<string|int, mixed>

Pour un nom de fichier donné, ne retourne que le premier qui sera trouvé par un find_in_path(), sauf si l'option all_files est activée.

Parameters
$dir : string
$pattern : string
$recurs : bool = false
$all_files : bool = false
Tags
uses
creer_chemin()
uses
preg_files()
used-by
selecteur_lister_objets()
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results