API JavaScript pour spHelper

Espace-noms spHelper

spHelper fournit les fonctions et variables relatives à une instance particulière de Script Application. Pour faire référence à spHelper, vous devez le faire précéder de la balise d'espace de nom unique du portlet, par exemple, [Plugin:Portlet key="namespace" compute="once"]. Pour faciliter l'utilisation de cet objet, vous pouvez créer votre propre variable en lui affectant un nom unique, par exemple, var myspHelper = [Plugin:Portlet key="namespace" compute="once"]spHelper;.

Récapitulatif de la zone spHelper

spHelper.renderingLocale

Extraction de l'environnement local de rendu.

spHelper.userCn

Extraction du nom commun de l'utilisateur à partir de LDAP.

spHelper.userId

Extraction de l'ID utilisateur à partir de LDAP.

spHelper.userLanguage

Extraction du langage préféré de l'utilisateur à partir de LDAP.

spHelper.userName

Extraction du nom de l'utilisateur à partir de LDAP en fonction du thème user.displaynameattribute.

spHelper.userSn

Extraction du nom de famille de l'utilisateur à partir de LDAP.

Récapitulatif de la méthode

spHelper.getScriptPortletPreference()

Extrait les valeurs pour la préférence de portlet utilisée pour les instances de Script Application.

// Sample using the Promise object calling the then function for the promise object
 // adding functions as parameters to the then function to handle success and error 
 function sampleRetrievePreference() {
  myspHelper.getScriptPortletPreference().then(function(prefData) {
      // for this script application the preferences are an array of strings
  			var prefs = prefData;  
             // if the first preference value is false then hide the field
             if (prefs[0] == "false"){
               $('#pref1').css('display','none');
             }
             // if the second preference value is equal to 09982 then hide the field
             if (prefs[1] == "09982"){
               $('#nameHeader2').css('display','none');
             }
       },
        function(error){
          // you might want to exclude the error 
          // "ERR001:Preference data is not available in this context"
          // you will get this when in the the code is called when in preview
          // or the theme doesn't include wp_client_ext capability.
          if (error.message.toString().indexOf("ERR0001:") != 0)
			alert(error.name + "\n" + error.message);
    	  });
 };

Renvoie

{Promise}Promesse qui effectue une conversion en {preferenceData: Object} en cas de réussite et une conversion en {error: Error} en cas d'erreur. preferenceData est un objet JavaScript qui contient vos valeurs de préférence et peut être sérialisé en une valeur de chaîne qui représente l'objet. Par exemple, vous pouvez définir un objet JSON contenant une liste de dates de vacances pendant lesquelles le portlet se comporte différemment.

{"holidays":[ {"Month":"January","Date":"1"}, 
{"Month":"June","Date":"22"}, {"Month":"July","Date":"5"} ]}

Vous pouvez également définir un tableau de chaînes ordonné dans lequel les valeurs contrôlent une visibilité des zones.

["true", "true", "true", "true", "true", "true", "true", "true"]

L'élément error est un objet erreur contenant les informations sur l'erreur. Par exemple, l'erreur ERR0001: Les données de préférence ne sont pas disponibles dans ce contexte est générée lorsque le code est exécuté dans la vue d'aperçu ou que la dépendance par rapport à wp_client_ext est manquante.

spHelper.setScriptPortletPreference(preferenceData)

Définit les valeurs pour la préférence de portlet utilisée pour les instances de Script Application.

// Sample using the Promise object calling the then function for the promise object
 // adding functions as parameters to the then function to handle success and error 
 function sampleSetPreference() {
 // for this script application the preferences are an array of strings
  preferences =
  ["" + $('#pref1').prop('checked'),
   "" + $('#pref2').val()];
  myspHelper.setScriptPortletPreference(preferences).then(function(prefData){
       // on success close the preference dialog
      $('#prefDialog').dialog('close');
      }, err: function(errorText){
          // you might want to exclude the error 
          // "ERR001:Preference data is not available in this context"
          // you will get this when in the the code is called when in preview
          // or the theme doesn't include wp_client_ext capability.
		if (error.message.toString().indexOf("ERR0001:") != 0)
			alert(error.name + "\n" + error.message);
     });
 };

Paramètres

{Object}preferenceDatacan peut avoir pour valeur NULL ou n'importe quel objet JavaScript qui contient vos valeurs de préférence et peut être sérialisé en une valeur de chaîne qui représente l'objet. La définition de cette valeur sur NULL supprime toutes les valeurs de préférence. Vous pouvez aussi spécifier un tableau de n'importe quelle taille contenant les valeurs de préférence que vous souhaitez associer à cette instance du portlet. Vous pouvez utiliser ces valeurs de préférence pour personnaliser le portlet. Par exemple, vous pouvez définir un objet JSON contenant une liste de dates de vacances pendant lesquelles le portlet se comporte différemment.

{"holidays":[ {"Month":"January","Date":"1"}, 
{"Month":"June","Date":"22"}, {"Month":"July","Date":"5"} ]}

Vous pouvez également définir un tableau de chaînes ordonné dont les valeurs contrôlent une visibilité des zones lorsque les données sont enregistrées ; les données précédentes sont remplacées par les nouvelles données.

["true", "true", "true", "true", "true", "true", "true", "true"]

Renvoie

{Promise}Promesse qui effectue une conversion en {preferenceData: Object} en cas de réussite et une conversion en {error: Error} en cas d'erreur. L'objet preferenceData est identique aux données qui ont été transmises dans cette fonction. L'élément errorText est une chaîne qui contient les informations sur l'erreur. Par exemple, l'erreur "ERR0001: Les données de préférence ne sont pas disponibles dans ce contexte" est générée lorsque le code est exécuté dans la vue d'aperçu ou que la dépendance par rapport à 'wp_client_ext' est manquante.