SPIP Code

Documentation du code de SPIP et de ses plugins

SPIP

URLs

Table of Contents

Functions

urls_decoder_url()  : array<string|int, mixed>
Décoder une URL en utilisant les fonctions inverses
urls_transition_retrouver_anciennes_url_propres()  : array<string|int, mixed>
Le bloc qui suit sert a faciliter les transitions depuis le mode 'urls-propres' vers les modes 'urls-standard' et 'url-html'
urls_transition_retrouver_anciennes_url_html()  : array<string|int, mixed>
Le bloc qui suit sert a faciliter les transitions depuis le mode 'urls-html/standard' vers les modes 'urls propres|arbos'
urls_liste_objets()  : string|array<string|int, mixed>
Lister les objets pris en compte dans les URLs c'est à dire suceptibles d'avoir une URL propre
nettoyer_url_page()  : array<string|int, mixed>
Nettoyer une URL, en repérant notamment les raccourcis d'objets
generer_objet_url_ecrire()  : string
Générer l'URL d'un objet dans l'espace privé

Functions

urls_decoder_url()

Décoder une URL en utilisant les fonctions inverses

urls_decoder_url(string $url[, string $fond = '' ][, array<string|int, mixed> $contexte = [] ][, bool $assembler = false ]) : array<string|int, mixed>

Gère les URLs transformées par le htaccess.

Parameters
$url : string

URL à décoder

$fond : string = ''

Fond initial par défaut

$contexte : array<string|int, mixed> = []

contexte initial à prendre en compte

$assembler : bool = false

true si l'URL correspond à l'URL principale de la page qu'on est en train d'assembler dans ce cas la fonction redirigera automatiquement si besoin et utilisera les eventuelles globales $_SERVER['REDIRECT_url_propre'] et $_ENV['url_propre'] provenant du htaccess

Tags
note

$renommer = 'urls_propres_dist'; renvoie array($contexte, $type, $url_redirect, $nfond)

$nfond n'est retourné que si l'URL est définie apres le ? et risque d'être effacée par un form en get. Elle est utilisée par form_hidden exclusivement.

Compat ascendante si le retour est NULL en gérant une sauvegarde/restauration des globales modifiées par les anciennes fonctions

Return values
array<string|int, mixed> —

Liste $fond, $contexte, $url_redirect.

Si l'url n'est pas valide, $fond restera à la valeur initiale passée. Il suffit d'appeler la fonction sans $fond et de vérifier qu'à son retour celui-ci est non vide pour vérifier une URL

urls_transition_retrouver_anciennes_url_propres()

Le bloc qui suit sert a faciliter les transitions depuis le mode 'urls-propres' vers les modes 'urls-standard' et 'url-html'

urls_transition_retrouver_anciennes_url_propres(string $url_propre, string $entite[, array<string|int, mixed> $contexte = [] ]) : array<string|int, mixed>
Parameters
$url_propre : string
$entite : string
$contexte : array<string|int, mixed> = []
Return values
array<string|int, mixed>

urls_transition_retrouver_anciennes_url_html()

Le bloc qui suit sert a faciliter les transitions depuis le mode 'urls-html/standard' vers les modes 'urls propres|arbos'

urls_transition_retrouver_anciennes_url_html(string $url, string $entite[, array<string|int, mixed> $contexte = [] ]) : array<string|int, mixed>
Parameters
$url : string
$entite : string
$contexte : array<string|int, mixed> = []
Return values
array<string|int, mixed>

urls_liste_objets()

Lister les objets pris en compte dans les URLs c'est à dire suceptibles d'avoir une URL propre

urls_liste_objets([bool $preg = true ]) : string|array<string|int, mixed>
Parameters
$preg : bool = true

Permet de définir si la fonction retourne une chaine avec | comme séparateur pour utiliser en preg, ou un array()

Return values
string|array<string|int, mixed>

nettoyer_url_page()

Nettoyer une URL, en repérant notamment les raccourcis d'objets

nettoyer_url_page(string $url[, array<string|int, mixed> $contexte = [] ]) : array<string|int, mixed>

Repère les entités comme ?article13, ?rubrique21 ... les traduisant pour compléter le contexte fourni en entrée

Parameters
$url : string
$contexte : array<string|int, mixed> = []
Return values
array<string|int, mixed>

generer_objet_url_ecrire()

Générer l'URL d'un objet dans l'espace privé

generer_objet_url_ecrire(int|string|null $id, string $objet[, string $args = '' ][, string $ancre = '' ][, bool|null $public = null ][, string $connect = '' ]) : string

L'URL est calculée en fonction de son état publié ou non, calculé à partir de la déclaration de statut.

Parameters
$id : int|string|null

Identifiant de l'objet

$objet : string

Type d'objet

$args : string = ''
$ancre : string = ''
$public : bool|null = null
$connect : string = ''
Return values
string 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results