ClientConfig est un supplément pour MODX Revolution 2.2 et supérieur, permettant aux administrateurs de mettre en place des options de configuration faciles pour les clients. Définissez des groupes (onglets) et des paramètres avec différents types de saisie et laissez vos clients faire le reste, tout en utilisant les paramètres dans les modèles ou dans le code.

Configuration des options de configuration

ClientConfig vous permet de définir ce que vous voulez que votre client gère. Par conséquent, ClientConfig est livré sous la forme d'un canevas vide, qui attend que vous définissiez les paramètres appropriés.

Ouvrir ClientConfig dans le menu Composants, et cliquer sur Admin en haut à droite pour démarrer. Commençons par créer un groupe dans l'onglet Groupes. Les groupes sont utilisés pour classer les paramètres dans les onglets de la vue des clients, et si vous n'assignez pas un paramètre à un groupe, il ne sera pas visible pour le client.. Créons un nouveau groupe en cliquant sur le bouton Nouveau groupe. Donnez-lui un nom et une description.

Nous pouvons maintenant ajouter quelques paramètres dans l'onglet Paramètres. Il suffit de cliquer sur le bouton "Ajouter un paramètre" et de remplir le formulaire ; nous allons passer en revue certaines des options ci-dessous.

.

Paramètres

Les réglages contiennent un certain nombre d'options fixes:

• key : la clé que vous utiliserez pour référencer le paramètre lors de la récupération des valeurs du paramètre : ou $modx->getOption('key') dans code.
• label : le nom visible du champ.
• xtype (type de champ) : un type de champ valide ; voir les spécificités ci-dessous.
• description : description du champ afin de fournir un contexte supplémentaire pour le champ. Visible au survol du champ.
• is_required : si le champ doit avoir une valeur, cochez la case.
• value : la valeur actuellement stockée pour ce champ.
• default : une valeur par défaut (en quelque sorte dépréciée)
• group : le groupe dans lequel ce champ doit être affiché
• options : configuration spécifique à un champ ; disponible uniquement pour un sous-ensemble des types de champs. Voir les spécificités ci-dessous.

Après avoir créé et enregistré les paramètres, ils seront disponibles sous la forme ou avec $modx->getOption('key') dans code.

Si des paramètres système ou des paramètres contextuels ont le même les paramètres de ClientConfig remplaceront ceux-là.

Field Types

Vous pouvez choisir un certain nombre de types de champs pour vos configurations. Le type de champ entre parenthèses est destiné aux ninjas extrémistes d'ExtJS qui veulent savoir ce qui est utilisé en coulisses pour élaborer le formulaire.

• Texte (xtype : champ de texte)
• Textarea (xtype : textarea)
• Numéro (xtype : champ numérique)
• Checkbox (xtype : xcheckbox)
• Date (xtype : champ de la date)
• Time (xtype : timefield)
• Selectbox (xtype : modx-combo) ; propriétés : Texte==valeur||Text2==valeur