SO FOOT Front

API Documentation

Namespaces

Twig

Interfaces, Classes and Traits

Article: Classe de fonctions utilitaires concernant un article
Home: Home - Fonctions utilisées dans la gestion de la page d'accueil
Transient: Transient - Un transient est un stockage de données à durée indéterminée qui permet de mettre en cache les données pour éviter de faire trop d'appels sur l'API
Migration: Classe de fonctions relatives à la migration des contenus de l'ancien site
Breve: Classe de fonctions utilitaires concernant une brève
Categories: Fonction relatives aux Categories (taxonomies)
Contenu: Classe de fonctions utilitaires concernant les contenus.
Dom: Manipuler du code Html/Xml
Message: Gestion des message envoyés par le site aux utilisateurs
Payload: Classe permettant de véhiculer des données lors de la navigation entre des pages via la session
Reactions
Session
Site
Svg
User

ONE_DAY = ONE_HOUR * 24
ONE_HOUR = ONE_MINUTE * 60
ONE_MINUTE = 60
ONE_MONTH = ONE_DAY * 31
ONE_WEEK = ONE_DAY * 7
PATH_TRANSIENT = CHEMIN_SITE . 'cache/transients/': chemin de stockage des transients
SVG_ATTR = array('style', 'preserveaspectratio', 'viewbox', 'xmlns', 'aria-labelledby')
TRANSIENT_TEMPORAIRE_DUREE = 2: Durée de vie des transients temporaires, en minutes
getAPI() : mixed: getAPI - requête GET vers l'api
postAPI() : mixed: postAPI - requête POST vers l'api
callAPI() : mixed: callAPI - Faire un appel API
apiToken() : mixed: Retourne le token d'identification nécéssaire pour les routes API accessibles uniquement aux utilisateurs identifiés. Le token est conservé 7 jours
debugImageSizes() : mixed
debug_footer() : void: Ajouter des données qui seront affichées dans le debug du footer
afficher_debug_footer() : void: Afficher dans le footer les debugs ajoutés avec la fonction debug_footer
isLocal() : bool: isLocal
isStaging() : bool: isStaging
doTrace() : mixed
mvd() : mixed
mse() : void: ms - Affiche le dump des variables passées en paramètres, en texte brut (entouré de commentaires HTML) et termine l'éxécution du script
ms() : void: ms - Affiche u message de debug en texte brut (entouré de commentaires HTML)
me() : void: me - Affiche le dump des variables passées en paramètres, avec mise en forme et termine l'éxécution du script
m() : void: m - Affiche le dump des variables passées en paramètres, avec mise en forme
dump_variable() : mixed
_dump() : mixed
httpErreur() : void: Retourne une erruer PHP avec le code $code
slug() : string: Transforme un texte (ou tableau de textes) en un slug
twigRender() : void: Rendu des templates Twig
twigPageTemplateExists() : bool: Indique si une page php associée à un template existe ou non
twigTemplateExists() : bool: Indique si un template existe ou non
getAssetVersionned() : mixed: Récupère les fichiers avec le hash
singulier() : mixed
object_to_array() : void: transforme un objet en tableau, de manière récursive
rediriger() : void: rediriger vers une nouvelle url Si la nouvelle URL est vide, on reviens automatiquement à la page précédente
fonctionUniqueId() : string: fonctionUniqueId - retourne les un identifiant unique pour la fonction appellante
fonctionParent() : array<string|int, mixed>: fonctionParent - retourne les informations relatives àa la fonction parent qui a apellé la fonction courante : Classe, nom, paramètres
si() : mixed: retourne une valeur de data si l'index `$keys` existe
valeur() : mixed: retourne une valeur de data si l'index `$keys` existe et n'est pas vide
tableau() : array<string|int, mixed>: tableau - Fait en sorte que la donnée d'entrée soit transformée en tableau si elle ne l'est pas déjà
checkInt() : int: checkInt Raccourcis vers check() en mode int
check() : mixed: Récupère un paramètre envoyé en GET ou POST Si l'option `int`est renseignée la valeur est forcée en numérique Options : all pour chercher dans _POST et dans _GET
escape_html() : string: Nettoyage HTML d'une chaîne de caractères
couper() : string: couper une phrase de manière intelligente
phpToFile() : void: Génère du code PHP à partir ,d'une donnée, destinée à être enregistré dans un fichier php
base64url_encode() : mixed
base64url_decode() : mixed
guidv4() : mixed
apiClient() : WpClient: apiClient Retourne une instance du client d'API WpClient Permet de faire des requêtes vers l'API Wordpress

ONE_DAY


    public
    mixed
    ONE_DAY
    = ONE_HOUR * 24

ONE_HOUR


    public
    mixed
    ONE_HOUR
    = ONE_MINUTE * 60

ONE_MINUTE


    public
    mixed
    ONE_MINUTE
    = 60

ONE_MONTH


    public
    mixed
    ONE_MONTH
    = ONE_DAY * 31

ONE_WEEK


    public
    mixed
    ONE_WEEK
    = ONE_DAY * 7

PATH_TRANSIENT

chemin de stockage des transients


    public
    mixed
    PATH_TRANSIENT
    = CHEMIN_SITE . 'cache/transients/'

SVG_ATTR


    public
    mixed
    SVG_ATTR
    = array('style', 'preserveaspectratio', 'viewbox', 'xmlns', 'aria-labelledby')

TRANSIENT_TEMPORAIRE_DUREE

Durée de vie des transients temporaires, en minutes


    public
    mixed
    TRANSIENT_TEMPORAIRE_DUREE
    = 2

getAPI()

getAPI - requête GET vers l'api


    
                getAPI(mixed $url[, mixed $options = [] ]) : mixed

Parameters

$url : mixed
$options : mixed = []

Return values

mixed —

postAPI()

postAPI - requête POST vers l'api


    
                postAPI(mixed $url[, mixed $options = [] ]) : mixed

Parameters

$url : mixed
$options : mixed = []

Return values

mixed —

callAPI()

callAPI - Faire un appel API


    
                callAPI(mixed $method, mixed $route[, mixed $data = false ][, mixed $headers = [] ][, mixed $options = [] ]) : mixed

Parameters

$method : mixed
$route : mixed
$data : mixed = false
$headers : mixed = []
$options : mixed = []

Return values

mixed —

apiToken()

Retourne le token d'identification nécéssaire pour les routes API accessibles uniquement aux utilisateurs identifiés. Le token est conservé 7 jours


    
                apiToken() : mixed

Return values

mixed —

debugImageSizes()


    
                debugImageSizes(mixed $image) : mixed

Parameters

$image : mixed

Return values

mixed —

debug_footer()

Ajouter des données qui seront affichées dans le debug du footer


    
                debug_footer() : void

Return values

void —

afficher_debug_footer()

Afficher dans le footer les debugs ajoutés avec la fonction debug_footer


    
                afficher_debug_footer() : void

Return values

void —

isLocal()

isLocal


    
                isLocal() : bool

Return values

bool —

Indique si le site courant est le site en local

isStaging()

isStaging


    
                isStaging() : bool

Return values

bool —

Indique si le site courant est le site de staging

doTrace()


    
                doTrace(mixed $t) : mixed

Parameters

$t : mixed

Return values

mixed —

mvd()


    
                mvd() : mixed

Return values

mixed —

mse()

ms - Affiche le dump des variables passées en paramètres, en texte brut (entouré de commentaires HTML) et termine l'éxécution du script


    
                mse() : void

Return values

void —

ms()

ms - Affiche u message de debug en texte brut (entouré de commentaires HTML)


    
                ms() : void

Return values

void —

me()

me - Affiche le dump des variables passées en paramètres, avec mise en forme et termine l'éxécution du script


    
                me() : void

Return values

void —

m()

m - Affiche le dump des variables passées en paramètres, avec mise en forme


    
                m() : void

Return values

void —

dump_variable()


    
                dump_variable(mixed $v) : mixed

Parameters

$v : mixed

Return values

mixed —

_dump()


    
                _dump(mixed $v, mixed $action) : mixed

Parameters

$v : mixed
$action : mixed

Return values

mixed —

httpErreur()

Retourne une erruer PHP avec le code $code


    
                httpErreur(mixed $code) : void

Parameters

$code : mixed: le code HTTP de l'erreur

Return values

void —

slug()

Transforme un texte (ou tableau de textes) en un slug


    
                slug(mixed $txt) : string

Parameters

$txt : mixed: La données à slugifier

Return values

string —

twigRender()

Rendu des templates Twig


    
                twigRender(mixed $template[, mixed $options = [] ]) : void

Parameters

$template : mixed: Le nom du fichier de template
$options : mixed = []: Les options

Return values

void —

twigPageTemplateExists()

Indique si une page php associée à un template existe ou non


    
                twigPageTemplateExists(mixed $template) : bool

Parameters

$template : mixed

Return values

bool —

twigTemplateExists()

Indique si un template existe ou non


    
                twigTemplateExists(mixed $template) : bool

Parameters

$template : mixed

Return values

bool —

getAssetVersionned()

Récupère les fichiers avec le hash


    
                getAssetVersionned(mixed $asset) : mixed

Parameters

$asset : mixed

Return values

mixed —

singulier()


    
                singulier(mixed $mot) : mixed

Parameters

$mot : mixed

Return values

mixed —

object_to_array()

transforme un objet en tableau, de manière récursive


    
                object_to_array(mixed $Class) : void

Parameters

$Class : mixed

Return values

void —

rediriger()

rediriger vers une nouvelle url Si la nouvelle URL est vide, on reviens automatiquement à la page précédente


    
                rediriger([mixed $url = null ][, mixed $options = [] ]) : void

Parameters

$url : mixed = null
$options : mixed = []

Return values

void —

fonctionUniqueId()

fonctionUniqueId - retourne les un identifiant unique pour la fonction appellante


    
                fonctionUniqueId() : string

Return values

string —

identifiant

fonctionParent()

fonctionParent - retourne les informations relatives àa la fonction parent qui a apellé la fonction courante : Classe, nom, paramètres


    
                fonctionParent() : array<string|int, mixed>

Return values

array<string|int, mixed> —

Structure retournée contenant la fonction et les paramètres

si()

retourne une valeur de data si l'index `$keys` existe


    
                si(mixed $data, mixed $keys[, mixed $default = null ]) : mixed

Parameters

$data : mixed: La donnée à analyser
$keys : mixed: Liste des champs à rechercher dans $data. Le premier trouvé sera retourné
$default : mixed = null: Valeur par défaut si rien n'a été trouvé dans $data

Return values

mixed —

La valeur qui a été trouvée

valeur()

retourne une valeur de data si l'index `$keys` existe et n'est pas vide


    
                valeur(mixed $data, mixed $keys[, mixed $default = null ]) : mixed

Parameters

$data : mixed: La donnée à analyser
$keys : mixed: Liste des champs à rechercher dans $data. Le premier trouvé sera retourné
$default : mixed = null: Valeur par défaut si rien n'a été trouvé dans $data

Return values

mixed —

La valeur qui a été trouvée

tableau()

tableau - Fait en sorte que la donnée d'entrée soit transformée en tableau si elle ne l'est pas déjà


    
                tableau(mixed $data) : array<string|int, mixed>

Parameters

$data : mixed: La donnée envoyée

Return values

array<string|int, mixed> —

checkInt()

checkInt Raccourcis vers check() en mode int


    
                checkInt(mixed $id) : int

Parameters

$id : mixed

Return values

int —

check()

Récupère un paramètre envoyé en GET ou POST Si l'option `int`est renseignée la valeur est forcée en numérique Options : all pour chercher dans _POST et dans _GET


    
                check(mixed $id[, mixed $options = [] ]) : mixed

Parameters

$id : mixed: Clé à rechercher dans GET ou POST
$options : mixed = []: Options de traitement TODO slug

Return values

mixed —

escape_html()

Nettoyage HTML d'une chaîne de caractères


    
                escape_html(mixed $data[, mixed $rapide = false ]) : string

Parameters

$data : mixed: la donnée à nettoyer
$rapide : mixed = false: Mode rapide (change seulement les < en <)

Return values

string —

couper()

couper une phrase de manière intelligente


    
                couper( $texte[,  $taille = 50 ][,  $suite = ' ...' ]) : string

Parameters

$texte :: Le texte à découper
$taille : = 50: Longueur de texte à conserver
$suite : = ' ...': Caractères ajoutés à la fin du texte tronqué

Return values

string —

phpToFile()

Génère du code PHP à partir ,d'une donnée, destinée à être enregistré dans un fichier php


    
                phpToFile(mixed $d[, mixed $nom = 'return' ]) : void

Parameters

$d : mixed
$nom : mixed = 'return'

Return values

void —

base64url_encode()


    
                base64url_encode(mixed $data) : mixed

Parameters

$data : mixed

Return values

mixed —

base64url_decode()


    
                base64url_decode(mixed $data[, mixed $pad = '==' ]) : mixed

Parameters

$data : mixed
$pad : mixed = '=='

Return values

mixed —

guidv4()


    
                guidv4([mixed $data = false ]) : mixed

Parameters

$data : mixed = false

Return values

mixed —

apiClient()

apiClient Retourne une instance du client d'API WpClient Permet de faire des requêtes vers l'API Wordpress


    
                apiClient() : WpClient

Return values

WpClient —

API Documentation

Namespaces

Interfaces, Classes and Traits

Table of Contents

Constants

ONE_DAY

ONE_HOUR

ONE_MINUTE

ONE_MONTH

ONE_WEEK

PATH_TRANSIENT

SVG_ATTR

TRANSIENT_TEMPORAIRE_DUREE

Functions

getAPI()

Parameters

Return values

postAPI()

Parameters

Return values

callAPI()

Parameters

Return values

apiToken()

Return values

debugImageSizes()

Parameters

Return values

debug_footer()

Return values

afficher_debug_footer()

Return values

isLocal()

Return values

isStaging()

Return values

doTrace()

Parameters

Return values

mvd()

Return values

mse()

Return values

ms()

Return values

me()

Return values

m()

Return values

dump_variable()

Parameters

Return values

_dump()

Parameters

Return values

httpErreur()

Parameters

Return values

slug()

Parameters

Return values

twigRender()

Parameters

Return values

twigPageTemplateExists()

Parameters

Return values

twigTemplateExists()

Parameters

Return values

getAssetVersionned()

Parameters

Return values

singulier()

Parameters

Return values

object_to_array()

Parameters

Return values

rediriger()