Drupal, Module, PHP – Concevoir et réaliser un module sous Drupal

<?php
/* $Id$ */

 
; $Id: blog.info,v 1.5 2007/06/08 05:50:53 dries Exp $
name = On this date
description = A block module that lists links to content such as blog entries or forum discussions that were created one week ago.
package = Non-Core - optional
version = VERSION
core = 5.x
 
; Test of module creation made by hecube.net

dependencies = module1 module2 module3
package = "Your arbitrary grouping string"
version = "$Name$"

 
	<?php
	/* $Id$ */
 
 
	/**
	* Display help and module information
	* @param section which section of the site we're displaying help
	* @return help text for section
	*/
	function onthisdate_help($section='') {
				$output = '';
				switch ($section) {
					case "admin/help#onthisdate":
					$output = '<p>'. t("Displays links to nodes created on this date"). '</p>';
					break;
					}
				return $output;
			} // function onthisdate_help
 
 
 
	/**
	* Valid permissions for this module
	* @return array An array of valid permissions for the onthisdate module
	*/
		function onthisdate_perm() {
			return array('access onthisdate content');
		} // function onthisdate_perm()
 
 
	/**
	* Generate HTML for the onthisdate block
	* @param op the operation from the URL
	* @param delta offset
	* @returns block HTML
	*/
		function onthisdate_block($op='list', $delta=0) {
		// listing of blocks, such as on the admin/block page
			if ($op == "list") {
				$block[0]["info"] = t("On This Date");
				return $block;
				} else if ($op == 'view') {
			// our block content
			// content variable that will be returned for display
			$block_content = '';
			// Get today's date
			$today = getdate();
			// calculate midnight one week ago
			$start_time = mktime(0, 0, 0,$today['mon'],
			($today['mday'] - 7), $today['year']);
			// we want items that occur only on the day in question, so
			//calculate 1 day
			$end_time = $start_time + 86400;
			// 60 * 60 * 24 = 86400 seconds in a day
		$query = "SELECT nid, title, created FROM "."{node} WHERE created >= '".$start_time."' AND created <= '".$end_time."'";
		// get the links
		$queryResult = db_query($query);
			while ($links = db_fetch_object($queryResult)) {
				$block_content .= l($links->title,'node/'.$links->nid).'<br/>';
				}
		// check to see if there was any content before setting up the block
			if ($block_content == '') {
				// no content from a week ago, return nothing.
				return;
			}
		// set up the block
			$block['subject'] = 'On This Date';
			$block['content'] = $block_content;
			return $block;
			}
		}

	/**
	 * @file
	 * Enables to show the principles to build a module for Drupal 5.14.
	 */
 
	function onthisdate_admin() {
			$form['onthisdate_maxdisp'] = array(
				'#type' => 'textfield',
				'#title' => t('Maximum number of links'),
				'#default_value' => variable_get('onthisdate_maxdisp', 3),
				'#size' => 2,
				'#maxlength' => 2,
				'#description' => t("The maximum number of links to display in the block.")
				);
			return system_settings_form($form);
		}
 
 
		function onthisdate_menu() {
			$items = array();
			$items[] = array(
				'path' => 'admin/settings/onthisdate',
				'title' => t('On this date module settings'),
				'description' => t('Description of your on this date settings control'),
				'callback' => 'drupal_get_form',
				'callback arguments' => 'onthisdate_admin',
				'access' => user_access('access administration pages'),
				'type' => MENU_NORMAL_ITEM,
				);
 
			//this is added for this current tutorial.
			$items[] = array(
				'path' => 'onthisdate',
				'title' => t('on this date'),
				'callback' => 'onthisdate_all',
				'access' => user_access('access onthisdate content'),
				'type' => MENU_CALLBACK
				// 'type' => MENU_NORMAL_ITEM
 
 
				);
			return $items;
		}

// 'type' => MENU_CALLBACK
'type' => MENU_NORMAL_ITEM

	/Applications/MAMP/Library/bin/mysql -u root -p

# Création simultanée de la base drupal5_14 
# et de l'utilisateur drupal5_14 
 
CREATE USER 'drupal5_14'@'localhost' IDENTIFIED BY 'drupal5_14'; GRANT USAGE ON *.* TO 'drupal5_14'@'localhost' IDENTIFIED BY 'drupal5_14'WITH MAX_QUERIES_PER_HOUR 0 MAX_CONNECTIONS_PER_HOUR 0 MAX_UPDATES_PER_HOUR 0 MAX_USER_CONNECTIONS 0; CREATE DATABASE IF NOT EXISTS drupal5_14;GRANT ALL PRIVILEGES ON drupal5_14.* TO 'drupal5_14'@'localhost';

	<?php
	/* $Id: onthisdate.module,v 1.0 28/12/2010 08:30:45 $ */
 
	/**
	 * @file
	 * Enables to show the principles to build a module for Drupal 5.14.
	 */
 
	function onthisdate_admin() {
			$form['onthisdate_maxdisp'] = array(
				'#type' => 'textfield',
				'#title' => t('Maximum number of links'),
				'#default_value' => variable_get('onthisdate_maxdisp', 3),
				'#size' => 2,
				'#maxlength' => 2,
				'#description' => t("The maximum number of links to display in the block.")
				);
			return system_settings_form($form);
		}
 
 
		function onthisdate_menu() {
			$items = array();
			$items[] = array(
				'path' => 'admin/settings/onthisdate',
				'title' => t('On this date module settings'),
				'description' => t('Description of your on this date settings control'),
				'callback' => 'drupal_get_form',
				'callback arguments' => 'onthisdate_admin',
				'access' => user_access('access administration pages'),
				'type' => MENU_NORMAL_ITEM,
				);
 
			//this is added for this current tutorial.
			$items[] = array(
				'path' => 'onthisdate',
				'title' => t('on this date'),
				'callback' => 'onthisdate_all',
				'access' => user_access('access onthisdate content'),
				'type' => MENU_CALLBACK
				// 'type' => MENU_NORMAL_ITEM
 
 
				);
			return $items;
		}
 
	/**
	* Display help and module information
	* @param section which section of the site we're displaying help
	* @return help text for section
	*/
	function onthisdate_help($section='') {
				$output = '';
				switch ($section) {
					case "admin/help#onthisdate":
 
					$output = '<p>'. t('This module displays links to <i>nodes</i> created on this date. <b>The following text has been written by Hecube.net to demonstrate that it is easy to add text, links, explanations in the help section of the module.</b>') .'</p>';
 
 
 
 
				$output .= '<p>'. t('You can find more articles about Drupal on our blog <a href="@hecube" target="_blank">@ social.hecube.net</a>. These <em>articles</em> deal with numerous subjects about Drupal: Drupal 6.x themes web design, Drupal service activation and content type, e-commerce with Drupal 6.x.', array('@hecube' => 'http://social.hecube.net/')) .'</p>';
 
 
				      $output .= '<p>'. t('For this module, it can be called in a block that could be named <em>On this date</em>. This block may be enabled at the <a href="@blocks">blocks administration page</a>.', array('@blocks' => url('admin/build/block'))) .'</p>';
 
 
				      $output .= '<p>'. t('To use this module, be sure to <a href="@modules">enable</a> the module, in the modules page and define a <a href="@blocks">position</a>.', array('@modules' => url('admin/build/modules'), '@blocks' => url('admin/build/block'))) .'</p>';
				      $output .= '<p>'. t('For more information, see the online handbook on <a href="@drupal">Drupal.org</a>.', array('@drupal' => 'http://drupal.org/handbook/')) .'</p>';
 
 
					break;
					}
				return $output;
			} // function onthisdate_help
 
 
 
	/**
	* Valid permissions for this module
	* @return array An array of valid permissions for the onthisdate module
	*/
		function onthisdate_perm() {
			return array('access onthisdate content');
		} // function onthisdate_perm()
 
 
	/**
	* Generate HTML for the onthisdate block
	* @param op the operation from the URL
	* @param delta offset
	* @returns block HTML
	*/
		function onthisdate_block($op='list', $delta=0) {
		// listing of blocks, such as on the admin/block page
			if ($op == "list") {
				$block[0]["info"] = t("On This Date");
				return $block;
				} else if ($op == 'view') {
			// our block content
			// content variable that will be returned for display
			$block_content = '';
			// Get today's date
			$today = getdate();
			// calculate midnight one week ago
			$start_time = mktime(0, 0, 0,$today['mon'],
			($today['mday'] - 7), $today['year']);
			// we want items that occur only on the day in question, so
			//calculate 1 day
			$end_time = $start_time + 86400;
			// 60 * 60 * 24 = 86400 seconds in a day
 
			/* The query changed to enable configuration from admin */
			$limitnum = variable_get('onthisdate_maxdisp', 3);
			/* $query = "SELECT nid, title, created FROM "."{node} WHERE created >= '".$start_time."' AND created <= '".$end_time. "' LIMIT ".$limitnum; */
 
	$query = "SELECT nid, title, created FROM "."{node} WHERE created >= %d "."AND created <= %d";
 
			$queryResult = db_query_range($query, $start_time, $end_time, 0,
			$limitnum);
 
 
 
		// get the links
		$queryResult = db_query($query);
			while ($links = db_fetch_object($queryResult)) {
				$block_content .= l($links->title,'node/'.$links->nid).'<br/>';
				}
		// check to see if there was any content before setting up the block
			if ($block_content == '') {
				// no content from a week ago, return nothing.
				return;
			}
		// set up the block
			$block['subject'] = 'On This Date';
			$block['content'] = $block_content;
 
			return $block;
			}
		}
 
 
		function onthisdate_all() {
		// content variable that will be returned for display
		$page_content = '';
		// Get today's date
		$today = getdate();
		// calculate midnight one week ago
		$start_time = mktime(0, 0, 0, $today['mon'], ($today['mday'] - 7),
		$today['year']);
		// we want items that occur only on the day in question,
		// so calculate 1 day
		$end_time = $start_time + 86400;
		// 60 * 60 * 24 = 86400 seconds in a day
 
		/* $query = "SELECT nid, title, created FROM "."{node} WHERE created >= '".$start_time."' AND created <= '". $end_time . "'"; */
		/* $query = "SELECT nid, title, created FROM "."{node}"; */
		$limitnum = variable_get('onthisdate_maxdisp', 3);
		/* $query = "SELECT nid, title, created FROM "."{node} LIMIT 0, ".$limitnum.""; */
		$query = "SELECT nid, title, created FROM "."{node} LIMIT ".$limitnum."";
 
		// get the links (no range limit here)
		$queryResult = db_query($query);
				while ($links = db_fetch_object($queryResult)) {
					$page_content .= l($links->title, 'node/'.$links->nid).'<br />';
				}
				// add a more link to our page that displays all the links
				$page_content .="<div class="more-link">".l(t("more"),"onthisdate", array("title" => t("More events on this day.")))."</div>";
 
				// check to see if there was any content before
				// setting up the block
				if ($page_content == '') {
				// no content from a week ago, let the user know
				$page_content = "No events occurred on this site on this date in
				history.";
				}
 
			return $page_content;
		} // end function onthisdate_all