Palette Factory

API

Constants

_EZPALETTE_COLLECTION_METADONNEES = ['titre', 'version', 'source', 'licence', 'description', 'recommandations']: Métadonnées d'une collection que l'utilisateur renseigne lui-même.
_EZPALETTE_TYPE_CYCLIQUE = 'cyclic'
_EZPALETTE_TYPE_DIVERGENTE = 'diverging'
_EZPALETTE_TYPE_PERCEPTION_SEQUENTIELLE = 'perceptual_sequential'
_EZPALETTE_TYPE_QUALITATIVE = 'qualitative'
_EZPALETTE_TYPE_SEQUENTIELLE = 'sequential'
_EZPALETTE_TYPES = [\_EZPALETTE_TYPE_SEQUENTIELLE, \_EZPALETTE_TYPE_DIVERGENTE, \_EZPALETTE_TYPE_QUALITATIVE, \_EZPALETTE_TYPE_CYCLIQUE, \_EZPALETTE_TYPE_PERCEPTION_SEQUENTIELLE]

Functions

palette_collection_charger() : array<string|int, mixed>: Charge ou recharge en base de données les collections des palettes de couleurs standard à partir des fichiers JSON correspondants.
palette_collection_decharger() : array<string|int, mixed>: Vide en base de données les collections des palettes de couleurs standard (non éditables) en préservant les palettes personnelles.
palette_collection_repertorier() : array<string|int, mixed>: Liste toutes les descriptions des collections disponibles ou seulement celles filtrées selon un ou plusieurs attributs.
palette_collection_est_protegee() : bool: Indique si une collection est protégée, c'est-à-dire si son contenu est administré par le plugin et non par l'utilisateur.
palette_collection_normaliser_identifiant() : string: Vérifie qu'un identifiant de collection est utilisable et le normalise.
palette_collection_recalculer() : array<string|int, mixed>: Recalcule les agrégats d'une collection à partir des palettes réellement présentes en base.
palette_collection_creer() : array<string|int, mixed>: Crée une collection personnelle.
palette_collection_modifier() : array<string|int, mixed>: Modifie les métadonnées d'une collection personnelle.
palette_collection_supprimer() : array<string|int, mixed>: Supprime une collection personnelle.

_EZPALETTE_COLLECTION_METADONNEES

Métadonnées d'une collection que l'utilisateur renseigne lui-même.


    public
        mixed
    _EZPALETTE_COLLECTION_METADONNEES
    = ['titre', 'version', 'source', 'licence', 'description', 'recommandations']

Tout ce qui n'y figure pas est soit un attribut de contrôle géré par le plugin - l'identifiant, le drapeau editable, la date de mise à jour - soit un agrégat recalculé depuis les palettes présentes. Une interface de saisie n'a donc à proposer que ces six champs.

_EZPALETTE_TYPE_CYCLIQUE


    public
        mixed
    _EZPALETTE_TYPE_CYCLIQUE
    = 'cyclic'

_EZPALETTE_TYPE_DIVERGENTE


    public
        mixed
    _EZPALETTE_TYPE_DIVERGENTE
    = 'diverging'

_EZPALETTE_TYPE_PERCEPTION_SEQUENTIELLE


    public
        mixed
    _EZPALETTE_TYPE_PERCEPTION_SEQUENTIELLE
    = 'perceptual_sequential'

_EZPALETTE_TYPE_QUALITATIVE


    public
        mixed
    _EZPALETTE_TYPE_QUALITATIVE
    = 'qualitative'

_EZPALETTE_TYPE_SEQUENTIELLE


    public
        mixed
    _EZPALETTE_TYPE_SEQUENTIELLE
    = 'sequential'

_EZPALETTE_TYPES


    public
        mixed
    _EZPALETTE_TYPES
    = [\_EZPALETTE_TYPE_SEQUENTIELLE, \_EZPALETTE_TYPE_DIVERGENTE, \_EZPALETTE_TYPE_QUALITATIVE, \_EZPALETTE_TYPE_CYCLIQUE, \_EZPALETTE_TYPE_PERCEPTION_SEQUENTIELLE]

palette_collection_charger()

Charge ou recharge en base de données les collections des palettes de couleurs standard à partir des fichiers JSON correspondants.


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

Il est possible de charger une collection donnée ou de charger toutes les collections disponibles.

Parameters

$collection_id : null|string = null: Identifiant de la collection ou null pour charger toutes les collections. L'identifiant de la collection coincide avec le nom du fichier JSON contenant les informations de configuration de la collection.

Return values

array<string|int, mixed> —

Tableau résultat de l'action : soit une erreur, soit une information sur le déroulement correct. Les index sont :

int level : la gravité telle que définie pour les logs de spip
string code : le code de l'information ou de l'erreur qui représente aussi l'item de langue
array parameters : tableau associatif des paramètres de l'erreur à fournir à l'item de langue

palette_collection_decharger()

Vide en base de données les collections des palettes de couleurs standard (non éditables) en préservant les palettes personnelles.


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

Il est possible de vider une collection donnée ou toutes les collections standard enregistrées.

Parameters

$collection_id : null|string = null: Identifiant de la collection ou null pour décharger toutes les collections.

Return values

array<string|int, mixed> —

Tableau résultat de l'action : soit une erreur, soit une information sur le déroulement correct. Les index sont :

int level : la gravité telle que définie pour les logs de spip
string code : le code de l'information ou de l'erreur qui représente aussi l'item de langue
array parameters : tableau associatif des paramètres de l'erreur à fournir à l'item de langue

palette_collection_repertorier()

Liste toutes les descriptions des collections disponibles ou seulement celles filtrées selon un ou plusieurs attributs.


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

La fonction lit la meta ezpalette_collections.

Parameters

$filtres : null|array<string|int, mixed> = []: Tableau associatif [champ] = valeur de critères de filtres sur les descriptions de feed. Les opérateurs possibles sont l'égalité et la non égalité qui s'exprime en préfixant la valeur par !.

Return values

array<string|int, mixed> —

Renvoie la liste des descriptions des collections enregistrées

palette_collection_est_protegee()

Indique si une collection est protégée, c'est-à-dire si son contenu est administré par le plugin et non par l'utilisateur.


    
                    palette_collection_est_protegee(string $collection_id) : bool

Les collections standard sont décrites par un fichier JSON du dossier palettes/ et intégralement rechargées depuis celui-ci : toute palette personnelle qu'on y déposerait disparaîtrait au premier rechargement. Une collection inconnue n'est en revanche pas protégée, ce qui permet d'en créer une simplement en employant un nom nouveau.

Parameters

$collection_id : string: Identifiant de la collection

Return values

bool —

Vrai si la collection est administrée par le plugin

palette_collection_normaliser_identifiant()

Vérifie qu'un identifiant de collection est utilisable et le normalise.


    
                    palette_collection_normaliser_identifiant(string $collection_id) : string

L'identifiant sert de clé de configuration et de valeur en base : il est réduit aux minuscules, aux chiffres, au tiret et au souligné.

Parameters

$collection_id : string: Identifiant proposé

Return values

string —

Identifiant normalisé, ou chaîne vide s'il ne comporte aucun caractère exploitable

palette_collection_recalculer()

Recalcule les agrégats d'une collection à partir des palettes réellement présentes en base.


    
                    palette_collection_recalculer(string $collection_id) : array<string|int, mixed>

Types proposés, nombre de schémas et de palettes, tailles disponibles : ces informations décrivent le contenu de la collection et ne sont donc jamais saisies, mais déduites. Les collections standard les obtiennent lors de leur chargement depuis leur fichier JSON ; pour une collection personnelle, il revient à l'appelant de demander ce recalcul après avoir créé, modifié ou supprimé des palettes.

Parameters

$collection_id : string: Identifiant de la collection

Return values

array<string|int, mixed> —

Tableau résultat de l'action, aux index level, code et parameters

palette_collection_creer()

Crée une collection personnelle.


    
                    palette_collection_creer(string $collection_id[, array<string|int, mixed> $metadonnees = [] ]) : array<string|int, mixed>

Une collection personnelle se distingue d'une collection standard par son drapeau editable : elle n'est pas adossée à un fichier JSON, n'est donc jamais rechargée, et ses palettes survivent aux rechargements des autres collections.

Parameters

$collection_id : string: Identifiant souhaité, normalisé automatiquement
$metadonnees : array<string|int, mixed> = []: Métadonnées de la collection, parmi titre, version, source, licence, description et recommandations. À défaut de titre, l'identifiant en tient lieu

Return values

array<string|int, mixed> —

Tableau résultat de l'action, aux index level, code et parameters. En cas de succès, l'index parameters porte l'identifiant retenu, qui peut différer de celui demandé

palette_collection_modifier()

Modifie les métadonnées d'une collection personnelle.


    
                    palette_collection_modifier(string $collection_id, array<string|int, mixed> $modifications) : array<string|int, mixed>

Les collections standard sont administrées par leur fichier JSON : les modifier en base n'aurait pas de sens, puisque le prochain chargement écraserait la modification.

Parameters

$collection_id : string: Identifiant de la collection
$modifications : array<string|int, mixed>: Métadonnées à modifier, parmi celles déclarées par _EZPALETTE_COLLECTION_METADONNEES

Return values

array<string|int, mixed> —

Tableau résultat de l'action, aux index level, code et parameters

palette_collection_supprimer()

Supprime une collection personnelle.


    
                    palette_collection_supprimer(string $collection_id[, bool $avec_palettes = false ]) : array<string|int, mixed>

La suppression est refusée si la collection contient encore des palettes, à moins de le demander explicitement : effacer d'un geste un ensemble de palettes composées à la main mérite une confirmation.

Parameters

$collection_id : string: Identifiant de la collection
$avec_palettes : bool = false: Supprimer aussi les palettes de la collection

Return values

array<string|int, mixed> —

Tableau résultat de l'action, aux index level, code et parameters

API

Table of Contents

Constants

Functions

Constants

_EZPALETTE_COLLECTION_METADONNEES

_EZPALETTE_TYPE_CYCLIQUE

_EZPALETTE_TYPE_DIVERGENTE

_EZPALETTE_TYPE_PERCEPTION_SEQUENTIELLE

_EZPALETTE_TYPE_QUALITATIVE

_EZPALETTE_TYPE_SEQUENTIELLE

_EZPALETTE_TYPES

Functions

palette_collection_charger()

Parameters

Tags

Return values

palette_collection_decharger()

Parameters

Tags

Return values

palette_collection_repertorier()

Parameters

Return values

palette_collection_est_protegee()

Parameters

Return values

palette_collection_normaliser_identifiant()

Parameters

Return values

palette_collection_recalculer()

Parameters

Return values

palette_collection_creer()

Parameters

Return values

palette_collection_modifier()

Parameters

Return values

palette_collection_supprimer()

Parameters

Return values