\Conf

Outil de Configuration

Summary

Methods

Properties

Constants

get()
set()
setMany()
exists()
exist()
isEmpty()
kill()
add()
setPageTitle()
getPageTitle()
defaultPageTitle()
setPageTitleAlone()
getPageTitleAlone()
setMetaDesc()
setMetaDescBase()
setMetaDescStart()
getMetaDesc()
getMetaDescBase()
getMetaDescStart()
defaultMetaDesc()
addToMetaDesc()
setMetaKeys()
getMetaKeys()
defaultMetaKeys()
addToMetaKeys()
setMetaImage()
defaultMetaImage()
executeMetaDefault()
getMetaImage()
setCanonicalUrl()
getCanonicalUrl()
setNextUrl()
getNextUrl()
setPrevUrl()
getPrevUrl()
SEOGen()
keywordGenerate()
setContent()
addToContent()
getContent()
setAriane()
addToAriane()
getAriane()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

No private properties found

N/A

File: sys/tools/conf.php
Package: Acidfarm\Model
Class hierarchy: \Conf

Methods

get()

get(string  $key) : mixed

Retourne une variable de configuration

Parameters

string

$key

acheminement vers la variable - exemple : 'macat:mavariable' pour $acid['conf']['macat']['mavariable']

Returns

mixed

set()

set(string  $key, mixed  $value)

Définit une variable de configuration

Parameters

string	$key	acheminement vers la variable - exemple : 'macat:mavariable' pour $acid['conf']['macat']['mavariable']
mixed	$value	valeur

setMany()

setMany(string  $key,   $values)

Définit plusieurs variables de configuration

Parameters

string	$key	acheminement vers la variable - exemple : 'macat:mavariable' pour $acid['conf']['macat']['mavariable']
	$values

exists()

exists(string  $key) : boolean

Teste l'existence d'une variable de configuration

Parameters

string

$key

acheminement vers la variable - exemple : 'macat:mavariable' pour $acid['conf']['macat']['mavariable']

Returns

boolean

exist()

exist(  $key) : boolean

(non-PHPdoc)

Parameters

$key

Returns

boolean

isEmpty()

isEmpty(string  $key) : boolean

Teste l'existence et l'état vrai d'une variable de configuration

Parameters

string

$key

acheminement vers la variable - exemple : 'macat:mavariable' pour $acid['conf']['macat']['mavariable']

Returns

boolean

kill()

kill(string  $key)

Efface une variable de configuration

Parameters

string

$key

acheminement vers la variable - exemple : 'macat:mavariable' pour $acid['conf']['macat']['mavariable']

add()

add(string  $key, mixed  $value)

Ajoute $value à une variable de configuration

Parameters

string	$key	acheminement vers la variable - exemple : 'macat:mavariable' pour $acid['conf']['macat']['mavariable']
mixed	$value	valeur à ajouter

setPageTitle()

setPageTitle(string  $value, string  $add_mode = false)

Définit le meta title

Parameters

string	$value	valeur
string	$add_mode	si vrai, ajoute $value à la valeur actuelle

getPageTitle()

getPageTitle()

Retourne le meta title

defaultPageTitle()

defaultPageTitle(string  $key)

Retourne le meta title par défault associé à $key

Parameters

string

$key

identifiant de page

setPageTitleAlone()

setPageTitleAlone(boolean  $alone = true)

Définit si le titre sera accompagné ou non des titres de droite et gauche

Parameters

boolean

$alone

getPageTitleAlone()

getPageTitleAlone() : boolean

Retourne si le titre sera accompagné ou non des titres de droite et gauche

Returns

boolean

setMetaDesc()

setMetaDesc(string  $value, string  $add_mode = false)

Définit le meta desc

Parameters

string	$value	valeur
string	$add_mode	si vrai, ajoute $value à la valeur actuelle

setMetaDescBase()

setMetaDescBase(string  $value, string  $add_mode = false)

Définit le meta desc de base

Parameters

string	$value	valeur
string	$add_mode	si vrai, ajoute $value à la valeur actuelle

setMetaDescStart()

setMetaDescStart(string  $value, string  $add_mode = false)

Définit le meta desc en préfixe

Parameters

string	$value	valeur
string	$add_mode	si vrai, ajoute $value à la valeur actuelle

getMetaDesc()

getMetaDesc() : string

Retourne le meta desc

Returns

string

getMetaDescBase()

getMetaDescBase() : string

Retourne le meta desc de base

Returns

string

getMetaDescStart()

getMetaDescStart() : string

Retourne le meta desc en prefixe

Returns

string

defaultMetaDesc()

defaultMetaDesc(string  $key) : string

Retourne le meta desc par défaut associé à $key

Parameters

string

$key

identifiant de page

Returns

string

addToMetaDesc()

addToMetaDesc(string  $value)

Ajoute au meta desc

Parameters

string

$value

valeur

setMetaKeys()

setMetaKeys(array  $value, string  $add_mode = false)

Définit les meta keywords

Parameters

array	$value	tableau contenant les mots-clés
string	$add_mode	si vrai, ajoute $value à la valeur actuelle

getMetaKeys()

getMetaKeys() : array

Retourne les meta keywords

Returns

array

defaultMetaKeys()

defaultMetaKeys(string  $key) : array

Retourne les meta keywords associés à $key

Parameters

string

$key

identifiant de page

Returns

array

addToMetaKeys()

addToMetaKeys(mixed  $value)

Ajoute $value aux meta keywords

Parameters

mixed

$value

valeur

setMetaImage()

setMetaImage(string  $value, string  $add_mode = false)

Définit le meta image ,permettant aux applications tierces de connaitre l'image associée à la page (réseaux sociaux)

Parameters

string	$value	valeur
string	$add_mode	si vrai, ajoute $value à la valeur actuelle

defaultMetaImage()

defaultMetaImage(string  $key) : mixed

Retourne la meta image associés à $key

Parameters

string

$key

Returns

mixed

executeMetaDefault()

executeMetaDefault(string  $seo_key = null)

Définit les Metas par défaut en fonction de la clé en entrée

Parameters

string

$seo_key

getMetaImage()

getMetaImage()

Retourne le meta image

setCanonicalUrl()

setCanonicalUrl(string  $value)

Définit l'url canonique de la page

Parameters

string

$value

valeur

getCanonicalUrl()

getCanonicalUrl()

Retourne l'url canonique de la page

setNextUrl()

setNextUrl(string  $value)

Définit l'url de la page suivante

Parameters

string

$value

valeur

getNextUrl()

getNextUrl()

Retourne l'url de la page suivante

setPrevUrl()

setPrevUrl(string  $value)

Définit l'url de la page précédente

Parameters

string

$value

valeur

getPrevUrl()

getPrevUrl()

Retourne l'url de la page précédente

SEOGen()

SEOGen(array  $title = array(), array  $desc = array(), string  $meta_img_url = null, boolean  $use_default_keywords = true, array  $added_meta_keywords = null, string  $generate_keywords_from_text = null)

Génère l'ensemble des éléments SEO de la page

Parameters

array	$title	: tableau contenant les titres de la page dans les langues disponibles sous forme 'fr' => 'titre'
array	$desc	: tableau contenant les descriptions déclinées dans les langues disponibles sous forme 'fr' => 'desc'
string	$meta_img_url	: url de la meta image qui sera partagée sur les réseau sociaux
boolean	$use_default_keywords	: ajout des meta keywords configurés par défaut dans 'sys/config' ou non
array	$added_meta_keywords	: ajout manuel de meta_keywords supplémentaires
string	$generate_keywords_from_text	: génération de meta_keywords en analysant le texte donné en paramètre en ajoutant les mots les plus utilisés. Les mots défini dans le fichier

keywordGenerate()

keywordGenerate(string  $string,   $nb_min_occurence = 2,   $word_min_size = 2)

Génère des mots clés pertinents à partir de la chaine de caractère passée en paramètres

Parameters

string	$string	: chaine de caractères à analyser
	$nb_min_occurence
	$word_min_size

setContent()

setContent(string  $value, string  $add_mode = false)

Définit le contenu du site

Parameters

string	$value	valeur
string	$add_mode	si vrai, ajoute $value à la valeur actuelle

addToContent()

addToContent(string  $value)

Ajoute au contenu du site

Parameters

string

$value

valeur

getContent()

getContent() : string

Retourne le contenu du site

Returns

string

setAriane()

setAriane(string  $ariane) : string

Definit le tableau representatif du fil d'Ariane

Parameters

string

$ariane

tableau representatif du fil d'ariane - exemple : array('label'=>url,'labelfils'=>urlfils)

Returns

string

addToAriane()

addToAriane(string  $name, string  $url)

Ajoute au fil d'Ariane

Parameters

string	$name	Nom lié à $url
string	$url	Url

getAriane()

getAriane() : array

Retourne le tableau representatif du fil d'Ariane

Returns

array