Coppermine Photo Gallery v1.5.x: Documentation et manuel

Table des matières

Variables & constantes

Système des variables globales

Les variables globales sont remplies une fois, mais peuvent être changées en cours d'exécution. Vous pouvez utiliser des variables globales à partir de votre plugins, mais n'oubliez pas de le faire globalement lors de l'utilisation à l'intérieur des fonctions ou des classes.

Nom de la variable Défini dans Type Description
$superCage include/init.inc.php Construction utilisée pour contenir les variables de serveur (variables prédéfinies) sécurisées avec Inspekt
$CONFIG include/init.inc.php tableau (array) associatif Toutes les valeurs de la configuration de Coppermine.
$CPG_PHP_SELF include/init.inc.php Chaine (String) Remplacement de des super-globales peu sécurisées $_SERVER['PHP_SELF'], $PHP_SELF et similaires qui peuvent exister ou pas sur certains serveurs et qui sont effacés dans Coppermine en utilisant Inspekt.
$REFERER / $CPG_REFERER include/init.inc.php Chaine (String) Petite amélioration de la sécurité des chaines de super-globales.
$LINEBREAK include/init.inc.php Chaine (String) Chaines contenant un saut de ligne qui focntionne aussi bien sous *nix que sous Windows.
$BRIDGE include/init.inc.php / fichier bridge tableau (array) associatif Variable d’intégration - contient tous les paramètres de la passerelle.
$USER tableau (array) associatif
$USER_DATA tableau (array) associatif
$THEME_DIR include/init.inc.php Chaine (String) Le nom du dossier du thème dans la configuration.
$ICON_DIR include/init.inc.php Chaine (String) L’adresse du répertoire où sont placées les icônes: si le thème est livré avec des icônes, la variable pointe vers le sous-dossier des icônes du thème. Sinon, le dossier d’icône par défaut sera utilisé.
$FAVPICS include/init.inc.php Tableau (array)<\a> indexé Les favoris des visiteurs actuels.
$RESTRICTEDWHERE include/functions.inc.php
$FORBIDDEN_SET_DATA include/functions.inc.php Indexed Tableau (array) <\a>indexé Liste des albums dont le visiteur actuel n'est pas autorisé à accéder.
$CURRENT_ALBUM_KEYWORD include/functions.inc.php
$CURRENT_CAT_DEPTH include/functions.inc.php
$FORBIDDEN_SET include/functions.inc.php
$CURRENT_CAT_NAME include/functions.inc.php
$CPG_PLUGINS Tableau (array)<\a> Multi-dimensionnel Premier niveau contient un tableau indexé, où chaque indice correspond à l'ID unique d'un plugin installé à l'intérieur du tableau de plugins.
Le deuxième niveau contient un tableau associatif qui contient toutes les actions des plugins des filtres ainsi que leurs noms, chemin d'accès et de priorité.
$JS tableau (array) associatif Tableau multi-dimensionnel incluant
  • Un tableau des variables relatives aux fichiers JavaScript externes, ex. chaines de traduction. Certaines variables sont complètées, comme, site_url, icon_dir, la traduction pour le mot "close" (lang_close) et l'icone correspondante (icon_close_path)
  • Un tableau indexé des includes (fichiers inclus): dans cette liste, tous les fichiers JavaScript inclus sont présents. Généralement, cette liste contient au moins js/jquery-1.3.2.js, js/scripts.js, js/jquery.greybox.js (si la fonction d'aide est activée dans la configuration) et js/jquery.elastic.js. Les éléments y sint ajoutés dans l'ordre ou ils sont indexés, sauf pour le fichier jquery lui même - il est toujours inclu en premier pour être sur que tous les appels fonctionnent comme prévu.
 suivre (La liste est incomplète). A tous les développeurs, merci de contribuer à remplir la liste.

Haut de page


Constantes de Coppermine

Les constantes sont remplies une seul fois. Elles ne peuvent pas être modifiées durant l'exécution. Vous pouvez utiliser les constantes de Coppermine à partir de vos plugins.

Nom de constant Défini dans Description
COPPERMINE_VERSION include/init.inc.php La version de Coppermine
COPPERMINE_VERSION_STATUS include/init.inc.php Le statut de votre version de Coppermine (alpha, beta ou stable)
IN_COPPERMINE les fichiers du noyau Coppermine qui sont destinés à être exécutés directement dans le navigateur LA constante vérifie que les fichiers inclus ne sont pas lancés directement: les fichiers qui sont cencés être lancés contiennent la définition de constante puis, ensuite, la commande include. Le fichier inclu ne contient pas la définition de constante, mais une matrice conditionnelle. Pour être sur que vos fichiers de plugins ne sont pas lancés directement, ajoutés ce qui suit au début des fichiers:
if (!defined('IN_COPPERMINE')) {
    die('Not in Coppermine...');
}
DEFAULT_LANGUAGE include/init.inc.php Langue par défaut (défini par l'administrateur) dans la configuration (peut être différent de $CONFIG['lang']) pendant le focntionnement, puisqu'elle peut être remplacée par cette dernière.
UDB_INTEGRATION include/init.inc.php Nom du fichier bridge.
GALLERY_ADMIN_MODE include/init.inc.php Si complété, l'utilisateur est un administrateur et le menu administrateur n'est pas caché. Il est recommandé d'utiliser cette constante pour véridier si l'administrateur est identifié. Utilisez un code comme celui-ci:
if (!GALLERY_ADMIN_MODE) {
    cpg_die(ERROR, $lang_errors['access_denied'], __FILE__, __LINE__);
}
USER_IS_ADMIN bridge/votre_fichier_bridge.inc.php (par défaut: bridge/udb_base.inc.php) Si défini, l'utilisateur est un administrateur.
USER_ADMIN_MODE include/init.inc.php Le "mode admin" n'est plus beaucoup utilisé - c'est un reste de cpg1.3.x et devrait être enlevé des futures versions. La définition est
define('USER_ADMIN_MODE', USER_ID && USER_CAN_CREATE_ALBUMS && !GALLERY_ADMIN_MODE);
elle est donc complétée si un utilisateur est identifié et a les droits d'avoir un album personnel. La constante ne doit pas être complétée si un administrateur est identifié, unless he hides the admin controls.
USER_ID bridge/votre_fichier_bridge.inc.php (Par défaut: bridge/udb_base.inc.php) L'ID de l'utilisateur identifié - utile pour envoyer l'utilisteur vers son profil.
USER_CAN_CREATE_ALBUMS bridge/votre_fichier_bridge.inc.php (par défaut: bridge/udb_base.inc.php) Le nom de cette constante peut induite en erreur: actuellement, elle n'indique pas si l'utilistauer a la persission de créer des albums dans les catégories publiques. En fait elle indique seulement si l'utilisateur à les droits nécéssaires pour avoir une galerie personnelle.
USER_GROUP_SET bridge/votre_fichier_bridge.inc.php (par défaut: bridge/udb_base.inc.php) Contient les groupes dont est membre l'utilisateur (sous forme de liste séparée par une virgule).
THEME_HAS_MENU_ICONS themes/votretheme/theme.php Pour plus de détails, reportez-vous à ThemesModifier theme.phpliste des éléments dans theme.phpTHEME_HAS_MENU_ICONS
THEME_HAS_RATING_GRAPHICS themes/votretheme/theme.php Pour plus de détails, reportez-vous à ThemesModifier theme.phpliste des éléments dans theme.phpTHEME_HAS_RATING_GRAPHICS
THEME_HAS_COMMENT_GRAPHICS themes/yourtheme/theme.php Pour plus de détails, reportez-vous à ThemesModifier theme.phpliste des éléments dans theme.phpTHEME_HAS_COMMENT_GRAPHICS
THEME_HAS_NAVBAR_GRAPHICS themes/votretheme/theme.php Pour plus de détails, reportez-vous à ThemesModifier theme.phpliste des éléments dans theme.phpTHEME_HAS_NAVBAR_GRAPHICS
THEME_HAS_FILM_STRIP_GRAPHIC themes/votretheme/theme.php Si défini, la dalle supérieure et inférieure pour le thème graphique utilisera le fichier themes/votretheme/images/tile.gif
Pour plus de détails, reportez-vous à ThemesModifier theme.phpliste des éléments dans theme.phpTHEME_HAS_FILM_STRIP_GRAPHIC
THEME_HAS_FILM_STRIP_GRAPHICS themes/votretheme/theme.php Si défini, la partie supérieure pour le négatif de film utilisera le fichier themes/votretheme/images/tile1.gif et la partie inférieure utilisera le fichier themes/votretheme/images/tile2.gif
pour plus de détails, reportez-vous à ThemesModifier theme.phpListe des éléments dans theme.phpTHEME_HAS_FILM_STRIP_GRAPHICS
THEME_HAS_NO_SYS_MENU_BUTTONS themes/votretheme/theme.php Pour plus de détails, reportez-vous à ThemesModifier theme.phpListe des éléments dans theme.phpTHEME_HAS_NO_SYS_MENU_BUTTONS
THEME_HAS_NO_SUB_MENU_BUTTONS themes/votretheme/theme.php Pour plus de détails, reportez-vous à ThemesModifier theme.phpListe des éléments dans theme.phpTHEME_HAS_NO_SUB_MENU_BUTTONS
THEME_HAS_PROGRESS_GRAPHICS themes/votretheme/theme.php Pour plus de détails, reportez-vous à ThemesModifier theme.phpListe des éléments dans theme.phpTHEME_HAS_PROGRESS_GRAPHICS
USER_GAL_CAT include/init.inc.php ID de la catégorie qui contient les galeries des utilisateurs. Est toujours est mis à 1.
FIRST_USER_CAT include/init.inc.php Valeur pour l'ID de la première catégorie de galerie utilisateur - c'est l'endroit ou la numérotation commence. Par défaut défini à 10000, ce qui donne à l'administrateur la possibilité de crée un grand nombre de catégories publiques (ID possible de 2 à 9999).
TEMPLATE_FILE include/init.inc.php Est par défault template.html. Ne pas changer, sauf si vous savez vraiment ce que vous faites.
INFORMATION include/init.inc.php Constante utilisée par la fonction cpg_die pour coder en dur la légende du message d'echec
ERROR include/init.inc.php Constante utilisée par la fonction cpg_die pour coder en dur la légende du message d'echec
CRITICAL_ERROR include/init.inc.php Constante utilisée par la fonction cpg_die pour coder en dur la légende du message d'echec
 suivre (La liste est incomplète). A tous les développeurs merci de contribuer à remplir la liste.

Haut de page