Générateur de code Drupal: Créer un lien AJAX ON / OFF en Drupal 7

Utilité : Création d'un petit lien permettant de lancer un appel ajax. Un module bien utile si l'on ne veut pas installer le module Flag juste pour bénérifier de son lien AJAX (un peu lourd pour si peu) et que l'on veut avoir son petit code PHP custom. C'est avec ce genre de fonction que le "marquer comme (non) lu" de l'agrégateur de flux (en mode connecté) a été créé.

Et pourquoi ne pas le customiser pour afficher / désafficher un contenu complet (une vue ?)

Tiré notamment du module examples, bien utile avec ses commentaires (qu'on a laissés bien sûr).

il est recommandé d'ajouter 'file' => 'mon_fichier.inc', au hook menu et de mettre la fonction mon_module_callback dans ce fichier d'include.

A vous également d'utiliser les arguments. Il vous reste à appeler le lien quelque part via print mon_module_render_link($status, $object_id) où $status est à TRUE ou FALSE (actif / inactif) et $object_id est facultatif, mais bien pratique si votre lien AJAX permet par exemple de publier / dépublier un noeud (cf. exemple en commentaire).

Le système fonctionne dans la pluspart des cas si le javascript n'est pas activé (cf. condition à la toute fin) : pas d'inquiétude !

TODO : ajouter une fonction de thème
TODO : ajout d'une fonction de permissions (ATTENTION : l'exemple n'en est pas encore doté).
TODO : ajouter d'autres actions ajax différentes.

TODO : ajouter une fonction de hook_links

/**
 * Implements hook_menu().
 */
function mon_module_menu() {
  $items = array();
  // A menu callback is required when using ajax outside of the Form API.
  $items['mon_module_callback/%/%/%/%'] = array(
    'page callback' => 'mon_module_callback',
    'page arguments' => array(1,2,3,4),
    'access callback' => 'user_access',
    'access arguments' => array('access content'),
    'type' => MENU_CALLBACK,
  );
  return $items;
}

/**
 * Render the link
 * On peut mettre plus d'éléments en paramètre de la fonction, et les passer en argument de l'autre fonction
 * @status bool
 * $object_id est l'ID, par exemple d'un noeud, d'un utilisateur, etc. Dans le cas d'un lien ON / OFF (afficher / désafficher une vue précise), il peut ne pas être utile. En revanche, pour afficher un noeud et passer l'ID en paramètre, il le devient.
 */
function mon_module_render_link($status = FALSE, $object_id = FALSE) { //TODO : une fonction de thème serait plus appropriée
	//Génération d'un identifiant unique au cas où il y aurait plusieurs liens sur la même page
	$id = uniqid();
	if($status == 1) {
		// $text = t('Vous avez cliqué'); //VARIANTE 1
		$link = l(t('Décliquez donc'), 'mon_module_callback/nojs/0/' . $id . '/' . $object_id, array('attributes' => array('class' => array('use-ajax'))));
	} else {
		// $text = t('Vous avez décliqué'); //VARIANTE 1
		$link = l(t('Cliquez ici'), 'mon_module_callback/nojs/1/' . $id . '/' . $object_id, array('attributes' => array('class' => array('use-ajax'))));
	}
  $output = '<div id="ajax-link-' . $id . '">' . $link . '</div><div id="ajax-link-description-'. $id . '"></div>';	
	//Remarque : on peut tout à fait mettre la div qui va être impactée avant ou ailleurs dans la page. La VARIANTE 1 met le texte (le statut par ex. du noeud) indiqué ci-dessus avant le lien. Au clic sur le lien, on va passer par ex. de "Publié" à "Non plublié" avec le lien permettant l'opération inverse ("Dépublier" / "Publier")
	// $output = '<div id="ajax-link-description-'. $id . '">' . $text . '</div><div id="ajax-link-' . $id . '">' . $link . '</div>'	//VARIANTE 1
	drupal_add_library('system', 'drupal.ajax');	
  return $output;
}

/**
 *
 * Because of the 'use-ajax' class applied here, the link submission is done
 * without a page refresh.
 *
 * When using the AJAX framework outside the context of a form or a renderable
 * array of type 'link', you have to include ajax.js explicitly.
 *
 * @return
 */
function mon_module_callback($type = 'ajax',$status,$id,$object_id) {

//En fonction du statut (ON / OFF par ex.), on réalise des opérations et on affiche le lien
	if (!$status) {

//Faites des trucs ici !
		//Ex. (pour dépublier un noeud) : 
		// $node = node_load($object_id);
		// $node->status = 0;
		// $node_save($node);
		
	
		$message = t('Vous avez décliqué');
		$link = l(t('Décliquez donc'), 'mon_module_callback/nojs/1/' . $id . '/' . $object_id, array('attributes' => array('class' => array('use-ajax'))));	//TODO : one function to generate the link
	} else {
	
		//Faites des trucs ici !
		//Ex. (pour publier un noeud) : 
		// $node = node_load($object_id);
		// $node->status = 1;
		// $node_save($node);
		
		$message = t('Vous avez cliqué');
		$link = l(t('Cliquez ici'), 'mon_module_callback/nojs/0/' . $id . '/' . $object_id, array('attributes' => array('class' => array('use-ajax'))));
	}
	
	//Ajout des divs
	$output = '<div id="ajax-link-description-' . $id . '">' . $message . '</div>';
	$link = '<div id="ajax-link-' . $id . '">' . $link . '</div>';	
	
	//Réalisation des actions ajax par Drupal
  if ($type == 'ajax') { 
		//Définitino des remplacements.
    $commands = array();
    $commands[] = ajax_command_replace('#ajax-link-description-' . $id, $output);
    $commands[] = ajax_command_replace('#ajax-link-' . $id, $link);
    $page = array('#type' => 'ajax', '#commands' => $commands);
    ajax_deliver($page);
  } else { //Print a message and redirect to the page if javascript disabled
    drupal_set_message($message);
    drupal_goto($_SERVER['HTTP_REFERER']);
  }
}

...du verbe Drupaler (1er groupe)

Niveau

Usage

Dossier

Lien direct

Trouver un générateur

Menu mobile

Créer un lien AJAX ON / OFF en Drupal 7

Ajouter un commentaire

Texte simple