SPIP Code

Documentation du code de SPIP et de ses plugins

SPIP

url_.php

SPIP, Système de publication pour l'internet

Copyright © avec tendresse depuis 2001 Arnaud Martin, Antoine Pitrou, Philippe Rivière, Emmanuel Saint-James

Ce programme est un logiciel libre distribué sous licence GNU/GPL.

Table of Contents

Functions

generer_generer_url()  : string
Génère le code compilé des balises d'URL
generer_generer_url_arg()  : string
Génère le code compilé des balises d'URL (en connaissant l'identifiant)
balise_URL__dist()  : Champ
Compile la balise générique `#URL_xxx` qui génère l'URL d'un objet
balise_URL_ARTICLE_dist()  : Champ
Compile la balise `#URL_ARTICLE` qui génère l'URL d'un article
balise_URL_SITE_dist()  : Champ|null
Compile la balise `#URL_SITE` qui génère l'URL d'un site ou de cas spécifiques
balise_URL_SITE_SPIP_dist()  : Champ
Compile la balise `#URL_SITE_SPIP` qui retourne l'URL du site telle que définie dans la configuration
balise_URL_PAGE_dist()  : Champ
Compile la balise `#URL_PAGE` qui retourne une URL de type « page »
balise_URL_ECRIRE_dist()  : Champ
Compile la balise `#URL_ECRIRE` qui retourne une URL d'une page de l'espace privé
balise_URL_ACTION_AUTEUR_dist()  : Champ
Compile la balise `#URL_ACTION_AUTEUR` qui retourne une URL d'action sécurisée pour l'auteur en cours

Functions

generer_generer_url()

Génère le code compilé des balises d'URL

generer_generer_url(string $type, Champ $p) : string

Utilise le premier paramètre de la balise d'URL comme identifiant d'objet s'il est donné, sinon le prendra dans un champ d'une boucle englobante.

Parameters
$type : string

Type d'objet

$p : Champ

Pile au niveau de la balise

Tags
uses
generer_generer_url_arg()
used-by
balise_URL__dist()
used-by
balise_URL_ARTICLE_dist()
used-by
balise_URL_SITE_dist()
Return values
string —

Code compilé

generer_generer_url_arg()

Génère le code compilé des balises d'URL (en connaissant l'identifiant)

generer_generer_url_arg(string $type, Champ $p, string $_id) : string

  • Si ces balises sont utilisées pour la base locale, production des appels à generer_objet_url(id-courant, entite)

  • Si la base est externe et sous SPIP, on produit

    • l'URL de l'objet si c'est une pièce jointe, ou sinon
    • l'URL du site local appliqué sur l'objet externe, ce qui permet de le voir à travers les squelettes du site local

On communique le type-url distant à generer_objet_url mais il ne sert pas car rien ne garantit que le .htaccess soit identique. À approfondir.

Parameters
$type : string

Type d'objet

$p : Champ

Pile au niveau de la balise

$_id : string

Code compilé permettant d'obtenir l'identifiant de l'objet

Tags
see
generer_objet_url()
used-by
generer_generer_url()
Return values
string —

Code compilé

balise_URL__dist()

Compile la balise générique `#URL_xxx` qui génère l'URL d'un objet

balise_URL__dist(Champ $p) : Champ

S'il existe une fonction spécifique de calcul d'URL pour l'objet demandé, tel que balise_URL_ARTICLE_dist(), la fonction l'utilisera. Sinon, on calcule une URL de façon générique.

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
uses
generer_generer_url()
example 
#URL_ARTICLE
#URL_ARTICLE{3}
Return values
Champ —

Pile complétée par le code à générer

balise_URL_ARTICLE_dist()

Compile la balise `#URL_ARTICLE` qui génère l'URL d'un article

balise_URL_ARTICLE_dist(Champ $p) : Champ

Retourne l'URL (locale) d'un article mais retourne dans le cas d'un article syndiqué (boucle SYNDIC_ARTICLES), son URL distante d'origine.

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
uses
generer_generer_url()
link
https://www.spip.net/3963
example 
#URL_ARTICLE
#URL_ARTICLE{3}
Return values
Champ —

Pile complétée par le code à générer

balise_URL_SITE_dist()

Compile la balise `#URL_SITE` qui génère l'URL d'un site ou de cas spécifiques

balise_URL_SITE_dist(Champ $p) : Champ|null

Génère une URL spécifique si la colonne SQL url_site est trouvée (par exemple lien hypertexte d'un article), sinon l'URL d'un site syndiqué

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
uses
generer_generer_url()
see
calculer_url()
link
https://www.spip.net/3861
Return values
Champ|null —

Pile complétée par le code à générer

balise_URL_SITE_SPIP_dist()

Compile la balise `#URL_SITE_SPIP` qui retourne l'URL du site telle que définie dans la configuration

balise_URL_SITE_SPIP_dist(Champ $p) : Champ
Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link
https://www.spip.net/4623
Return values
Champ —

Pile complétée par le code à générer

balise_URL_PAGE_dist()

Compile la balise `#URL_PAGE` qui retourne une URL de type « page »

balise_URL_PAGE_dist(Champ $p) : Champ
  • #URL_PAGE{nom} génère l'url pour la page nom
  • #URL_PAGE{nom,param=valeur} génère l'url pour la page nom avec des paramètres
  • #URL_PAGE sans argument retourne l'URL courante.
  • #URL_PAGE* retourne l'URL sans convertir les & en &
Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link
https://www.spip.net/4630
see
generer_url_public()
example 
#URL_PAGE{backend} produit ?page=backend
#URL_PAGE{backend,id_rubrique=1} est équivalent à
[(#URL_PAGE{backend}|parametre_url{id_rubrique,1})]
Return values
Champ —

Pile complétée par le code à générer

balise_URL_ECRIRE_dist()

Compile la balise `#URL_ECRIRE` qui retourne une URL d'une page de l'espace privé

balise_URL_ECRIRE_dist(Champ $p) : Champ
  • #URL_ECRIRE{nom} génère l'url pour la page nom de l'espace privé
  • #URL_ECRIRE{nom,param=valeur} génère l'url pour la page nom avec des paramètres
  • #URL_ECRIRE génère l'url pour la page d'accueil de l'espace privé
  • #URL_ECRIRE* retourne l'URL sans convertir les & en &
Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link
https://www.spip.net/5566
see
generer_url_ecrire()
example 
#URL_ECRIRE{rubriques} -> ecrire/?exec=rubriques
Return values
Champ —

Pile complétée par le code à générer

balise_URL_ACTION_AUTEUR_dist()

Compile la balise `#URL_ACTION_AUTEUR` qui retourne une URL d'action sécurisée pour l'auteur en cours

balise_URL_ACTION_AUTEUR_dist(Champ $p) : Champ

La balise accepte 3 paramètres. Les 2 premiers sont obligatoires :

  • le nom de l'action
  • l'argument transmis à l'action (une chaîne de caractère)
  • une éventuelle URL de redirection qui sert une fois l'action réalisée
Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
see
generer_action_auteur()
example

#URL_ACTION_AUTEUR{converser,arg,redirect} pourra produire ecrire/?action=converser&arg=arg&hash=xxx&redirect=redirect

Return values
Champ —

Pile complétée par le code à générer


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results