Comment développer une extension Contao ? (1ère partie)

{
    "name": "webexmachina/contao-planning",
    "description": "Planning for Contao Open Source CMS",
    "keywords": ["planning", "schedule", "calendar", "webexmachina", "module", "contao"],
    "type": "contao-module",
    "license": "LGPL-3.0+",
    "authors": [
        {
            "name": "Web ex Machina",
            "homepage": "https://www.webexmachina.fr",
            "role":"Developer"
        }
    ],
    "support":{
        "website":"https://www.webexmachina.fr/",
        "issues":"https://github.com/webexmachina/contao-planning/issues",
        "source":"https://github.com/webexmachina/contao-planning"
    },
    "require": {
        "php": ">=5.5",
        "contao/core-bundle": "~3.2 || ~4.1",
        "contao-community-alliance/composer-plugin": "~2.4 || ~3.0",
        "terminal42/dcawizard": "^2.4",
        "terminal42/notification_center": "^1.4"
    },
    "autoload":{
        "psr-0": {
            "WEM\\": [
                "library/"
            ]
        },
        "classmap": [""]
    },
    "extra": {
        "contao": {
            "sources": {
                "": "system/modules/wem-contao-planning"
            },
            "runonce": [
                "system/modules/wem-contao-planning/config/runonce.php"
            ]
        }
    }
}

"autoload": {
        "psr-4": {
            "Contao\\CoreBundle\\": "src/"
        },
        "classmap": [
            "src/Resources/contao/"
        ],
        "files": [
            "src/Resources/functions/utf8_bootup.php"
        ],
        "exclude-from-classmap": [
            "src/Resources/contao/config/",
            "src/Resources/contao/dca/",
            "src/Resources/contao/helper/",
            "src/Resources/contao/languages/",
            "src/Resources/contao/templates/",
            "src/Resources/contao/themes/"
        ]
    },

/**
 * Back end modules
 */
array_insert($GLOBALS['BE_MOD'], 1, array
(
	'wem_plannings' => array
	(
		'wem_planning' => array
		(
			'tables'    => array('tl_wem_planning', 'tl_wem_planning_slot', 'tl_wem_planning_booking_type', 'tl_wem_planning_booking'),
			'icon'		=> 'system/modules/wem-contao-planning/assets/icon_planning.png'
		),
		'wem_booking' => array
		(
			'tables'    		=> array('tl_wem_planning_booking'),
			'confirmBooking' 	=> array('WEM\Planning\Backend\Booking', 'confirmBooking'),
			'denyBooking' 		=> array('WEM\Planning\Backend\Booking', 'denyBooking'),
			'icon'				=> 'system/modules/wem-contao-planning/assets/icon_planning.png'
		),
	)
));

<?php

/**
 * Module Planning for Contao Open Source CMS
 *
 * Copyright (c) 2018 Web ex Machina
 *
 * @author Web ex Machina <https://www.webexmachina.fr>
 */

/**
 * Table tl_wem_planning
 */
$GLOBALS['TL_DCA']['tl_wem_planning'] = array
(

	// Config
	'config' => array
	(
		// Type de DCA souhaité, cela peut être une table de la BDD ou un fichier
		'dataContainer'               => 'Table',
		
		// Ensemble de sous-tables qui seront dépendante de celle-ci
		// Ces prochaines auront la table tl_wem_planning dans la clé 'ptable'
		'ctable'                      => array('tl_wem_planning_slot', 'tl_wem_planning_booking_type', 'tl_wem_planning_booking'),
		
		// Active le versionning pour les éléments de cette table
		'enableVersioning'            => true,
		
		// Instructions SQL, pour définir des clefs
		'sql' => array
		(
			'keys' => array
			(
				'id' => 'primary',
				'alias' => 'index',
			)
		)
	),

	// List
	'list' => array
	(
		// Ordre dans lequel apparaitront les éléments, triés par un mode, une colonne de la base, un "flag" (ordre alphabétique...)
		// panelLayout permet d'activer ou non les fonctions de filtre, recherche et de pagination
		'sorting' => array
		(
			'mode'                    => 1,
			'fields'                  => array('title'),
			'flag'                    => 1,
			'panelLayout'             => 'filter;search,limit'
		),
		
		// Formatage des listes, fields et format fonctionnent ensemble et fonctionne comme un sprintf
		// Ici, le %s de format prendra la valeur de la colonne title de chaque élément
		// label_callback permet de casser le formatage par défaut en appelant une fonction spécifique, qui acceptera la ligne courante en paramètre (voir plus bas)
		'label' => array
		(
			'fields'                  => array('title'),
			'format'                  => '%s',
			'label_callback'			  => array('tl_wem_planning', 'listItems'),
		),
		
		// Les actions globales concernent toutes les lignes. La plus souvent présente est l'instruction "all", qui permet l'édition multiple
		'global_operations' => array
		(
			'all' => array
			(
				'label'               => &$GLOBALS['TL_LANG']['MSC']['all'],
				'href'                => 'act=select',
				'class'               => 'header_edit_all',
				'attributes'          => 'onclick="Backend.getScrollOffset()" accesskey="e"'
			)
		),
		
		// Les operations correspondent aux boutons à droite de chaque ligne
		// Pour chaque bouton, vous précisez un label, un href, une icone, des attributs, ou un callback
		// Le href permet d'appeler des actions spécifiques via les "key", des actions connues via "act" ou d'accéder à une sous table via "table"
		'operations' => array
		(
			'editheader' => array
			(
				'label'               => &$GLOBALS['TL_LANG']['tl_wem_planning']['editheader'],
				'href'                => 'act=edit',
				'icon'                => 'edit.svg',
			),
			'copy' => array
			(
				'label'               => &$GLOBALS['TL_LANG']['tl_wem_planning']['copy'],
				'href'                => 'act=copy',
				'icon'                => 'copy.svg',
			),
			'delete' => array
			(
				'label'               => &$GLOBALS['TL_LANG']['tl_wem_planning']['delete'],
				'href'                => 'act=delete',
				'icon'                => 'delete.svg',
				'attributes'          => 'onclick="if(!confirm(\'' . $GLOBALS['TL_LANG']['MSC']['deleteConfirm'] . '\'))return false;Backend.getScrollOffset()"',
			),
			'show' => array
			(
				'label'               => &$GLOBALS['TL_LANG']['tl_wem_planning']['show'],
				'href'                => 'act=show',
				'icon'                => 'show.svg'
			),
			'bookings' => array
			(
				'label'               => &$GLOBALS['TL_LANG']['tl_wem_planning']['bookings'],
				'href'                => 'table=tl_wem_planning_booking',
				'icon'                => 'system/modules/wem-contao-planning/assets/icon_planning_16.png'
			)
		)
	),

	// Palettes
	// Les palettes représentent l'ensemble des champs qui composeront le "formulaire" de création ou d'édition
	// {title_legend} représente un titre de section
	// , représente une sépération d'un champ à un autre
	// ; représente une sépération d'une section à une autre
	'palettes' => array
	(
		// selector correspond à tous les champs qui vont déclencher des subpalettes, un peu plus bas
		'__selector__'                => array('canUpdateBooking', 'canCancelBooking', 'sendDailySummary', 'protected'),
		// default correspond à la palette générée par défaut. Il est possible d'avoir différentes palettes, dépendante d'un type de champ existant (voir tl_content.php)
		'default'                     => '
			{title_legend},title,alias;
			{default_legend},defaultOpenTime,defaultCloseTime;
			{update_legend},canUpdateBooking;
			{cancel_legend},canCancelBooking;
			{bookingtypes_legend},bookingtypes;
			{slots_legend},slots;
			{summary_legend},sendDailySummary;
			{protected_legend},protected
		'
	),

	// Subpalettes
	// Les sous palettes sont des ensembles de champs déclenchés selon certaines valeurs
	// Pour une checkbox, il suffit de renseigner le champ de la checkbox. Les champs apparaitrons à la suite de cette dernière
	// Pour un select, il convient d'écrire : 'nomduchamp_valeurattendue' => 'champ1,champ2'...
	'subpalettes' => array
	(
		'canUpdateBooking'			  => 'canUpdateBookingUntil,canUpdateBookingLimit',
		'canCancelBooking'			  => 'canCancelBookingUntil',
		'sendDailySummary'			  => 'dailySummaryNotification',
		'protected'                   => 'groups',
	),

	// Fields
	// C'est dans ce tableau que seront configurés chaque champ de votre table.
	'fields' => array
	(
		// Clé primaire de notre table
		// L'ID ne comporte qu'une instruction SQL car c'est un champ automatique
		'id' => array
		(
			'sql'                     => "int(10) unsigned NOT NULL auto_increment"
		),
		// Date de révision de l'item
		// Champ nativement géré par Contao, donc il est également caché
		'tstamp' => array
		(
			'sql'                     => "int(10) unsigned NOT NULL default '0'"
		),
		// Date de création de l'item
		// Caché de l'utilisateur également, c'est un champ que nous rajoutons dans toutes nos tables, des fois que cela puisse servir.
		// A noter que le champ prend le timestamp courant quand on créé l'item
		'created_at' => array
		(
			'default'				  => time(),
			'sql'                     => "int(10) unsigned NOT NULL default '0'"
		),

		// Colonne title
		'title' => array
		(
			// Référence à la traduction que nous verrons plus bas dans l'article
			'label'                   => &$GLOBALS['TL_LANG']['tl_wem_planning']['title'],
			// Désactive le champ pour les non-superadmins. Il peut être mis à disposition via le système de droits
			'exclude'                 => true,
			// Rend le champ recherchable via le panel du haut
			'search'                  => true,
			// Type d'input souhaité
			'inputType'               => 'text',
			// Configuration additionnelles
			// eval est assez fourni, référez vous à cette section : https://docs.contao.org/books/api/dca/reference.html#evaluation
			'eval'                    => array('mandatory'=>true, 'maxlength'=>255, 'tl_class'=>'w50'),
			// Configuration SQL
			'sql'                     => "varchar(255) NOT NULL default ''"
		),
		
		// Colone alias
		'alias' => array
		(
			'label'                   => &$GLOBALS['TL_LANG']['tl_wem_planning']['alias'],
			'exclude'                 => true,
			'inputType'               => 'text',
			'eval'                    => array('rgxp'=>'alias', 'doNotCopy'=>true, 'unique'=>true, 'maxlength'=>128, 'tl_class'=>'w50'),
			// Execute la fonction generateAlias de la classe tl_wem_planning  à la sauvegarde du formulaire.
			// Vous pouvez ajouter autant de fonction que souhaité au tableau.
			'save_callback' => array
			(
				array('tl_wem_planning', 'generateAlias')
			),
			'sql'                     => "varchar(128) COLLATE utf8_bin NOT NULL default ''"
		),

		'defaultOpenTime' => array
		(
			'label'                   => &$GLOBALS['TL_LANG']['tl_wem_planning']['defaultOpenTime'],
			'default'                 => time(),
			'exclude'                 => true,
			'inputType'               => 'text',
			'eval'                    => array('rgxp'=>'time', 'doNotCopy'=>true, 'tl_class'=>'w50'),
			'sql'                     => "int(10) unsigned NOT NULL default '0'"
		),
		'defaultCloseTime' => array
		(
			'label'                   => &$GLOBALS['TL_LANG']['tl_wem_planning']['defaultCloseTime'],
			'default'                 => time(),
			'exclude'                 => true,
			'inputType'               => 'text',
			'eval'                    => array('rgxp'=>'time', 'doNotCopy'=>true, 'tl_class'=>'w50'),
			'sql'                     => "int(10) unsigned NOT NULL default '0'"
		),

		'canUpdateBooking' => array
		(
			'label'                   => &$GLOBALS['TL_LANG']['tl_wem_planning']['canUpdateBooking'],
			'exclude'                 => true,
			// Permet le filtre des items via ce champ
			'filter'                  => true,
			// Et ordonnera les résultats via ce flag
			// Plus de références sur les flags : https://docs.contao.org/books/api/dca/reference.html#sorting
			'flag'                    => 1,
			'inputType'               => 'checkbox',
			'eval'                    => array('doNotCopy'=>true, 'submitOnChange'=>true),
			'sql'                     => "char(1) NOT NULL default ''"
		),
		'canUpdateBookingUntil' => array
		(
			'label'                   => &$GLOBALS['TL_LANG']['tl_wem_planning']['canUpdateBookingUntil'],
			'exclude'                 => true,
			'inputType'               => 'text',
			'eval'                    => array('doNotCopy'=>true, 'tl_class'=>'w50'),
			'sql'                     => "int(10) unsigned NOT NULL default '0'"
		),
		'canUpdateBookingLimit' => array
		(
			'label'                   => &$GLOBALS['TL_LANG']['tl_wem_planning']['canUpdateBookingLimit'],
			'exclude'                 => true,
			'inputType'               => 'text',
			'eval'                    => array('doNotCopy'=>true, 'tl_class'=>'w50'),
			'sql'                     => "int(10) unsigned NOT NULL default '0'"
		),

		'canCancelBooking' => array
		(
			'label'                   => &$GLOBALS['TL_LANG']['tl_wem_planning']['canCancelBooking'],
			'exclude'                 => true,
			'filter'                  => true,
			'flag'                    => 1,
			'inputType'               => 'checkbox',
			'eval'                    => array('doNotCopy'=>true, 'submitOnChange'=>true),
			'sql'                     => "char(1) NOT NULL default ''"
		),
		'canCancelBookingUntil' => array
		(
			'label'                   => &$GLOBALS['TL_LANG']['tl_wem_planning']['canCancelBookingUntil'],
			'exclude'                 => true,
			'inputType'               => 'text',
			'eval'                    => array('doNotCopy'=>true, 'tl_class'=>'w50'),
			'sql'                     => "int(10) unsigned NOT NULL default '0'"
		),

		// Champ particulier, car il fait appel au composant dcaWizard
		// Ce composant affiche le contenu d'une sous-table, ici : tl_wem_planning_booking_type
		// On notera qu'il n'y a pas de clef sql, puisqu'on n'a rien à sauvegarder ici
		'bookingtypes' => array
		(
			'label'                 => &$GLOBALS['TL_LANG']['tl_wem_planning']['bookingtypes'],
		    'inputType'             => 'dcaWizard',
		    'foreignTable'          => 'tl_wem_planning_booking_type',
		    'foreignField'          => 'pid',
		    'params'                  => array
		    (
		        'do'                  => 'wem_planning',
		    ),
		    'eval'                  => array
		    (
		        'fields' => array('title', 'duration'),
		        'editButtonLabel' => $GLOBALS['TL_LANG']['tl_wem_planning']['edit_bookingtype'],
		        'applyButtonLabel' => $GLOBALS['TL_LANG']['tl_wem_planning']['apply_bookingtype'],
		        'orderField' => 'sorting',
		        'showOperations' => true,
		        'operations' => array('edit', 'delete'),
		        'tl_class'=>'clr',
		    ),
		),

		'slots' => array
		(
			'label'                 => &$GLOBALS['TL_LANG']['tl_wem_planning']['slots'],
		    'inputType'             => 'dcaWizard',
		    'foreignTable'          => 'tl_wem_planning_slot',
		    'foreignField'          => 'pid',
		    'params'                  => array
		    (
		        'do'                  => 'wem_planning',
		    ),
		    'eval'                  => array
		    (
		        'fields' => array('canBook', 'type'),
		        'editButtonLabel' => $GLOBALS['TL_LANG']['tl_wem_planning']['edit_slot'],
		        'applyButtonLabel' => $GLOBALS['TL_LANG']['tl_wem_planning']['apply_slot'],
		        'orderField' => 'sorting',
		        'showOperations' => true,
		        'operations' => array('edit', 'delete'),
		        'tl_class'=>'clr',
		    ),
		),

		'sendDailySummary' => array
		(
			'label'                   => &$GLOBALS['TL_LANG']['tl_wem_planning']['sendDailySummary'],
			'exclude'                 => true,
			'filter'                  => true,
			'inputType'               => 'checkbox',
			'eval'                    => array('submitOnChange'=>true),
			'sql'                     => "char(1) NOT NULL default ''"
		),
		
		// Ce champ n'est affiché que si "sendDailySummary" est coché.
		'dailySummaryNotification' => array
		(
			'label'                     => &$GLOBALS['TL_LANG']['tl_wem_planning']['dailySummaryNotification'],
			'exclude'                   => true,
			'inputType'                 => 'select',
			// On charge les options via la fonction getNotificationChoices de la classe tl_wem_planning
			'options_callback'          => array('tl_wem_planning', 'getNotificationChoices'),
			'eval'                      => array('includeBlankOption'=>true, 'chosen'=>true, 'tl_class'=>'clr'),
			'sql'                       => "int(10) unsigned NOT NULL default '0'"
		),

		'protected' => array
		(
			'label'                   => &$GLOBALS['TL_LANG']['tl_wem_planning']['protected'],
			'exclude'                 => true,
			'filter'                  => true,
			'inputType'               => 'checkbox',
			'eval'                    => array('submitOnChange'=>true),
			'sql'                     => "char(1) NOT NULL default ''"
		),
		'groups' => array
		(
			'label'                   => &$GLOBALS['TL_LANG']['tl_wem_planning']['groups'],
			'exclude'                 => true,
			'inputType'               => 'checkbox',
			// Les options d'un input peuvent également se faire via une référence à une autre table
			// Les options retournées auront comme value l'ID de tl_member_group et comme label le name de tl_member_group
			'foreignKey'              => 'tl_member_group.name',
			'eval'                    => array('mandatory'=>true, 'multiple'=>true),
			'sql'                     => "blob NULL",
			// Il convient de définir la relation si une référence à une autre table est faite
			'relation'                => array('type'=>'hasMany', 'load'=>'lazy')
		),
	)
);


/**
 * Provide miscellaneous methods that are used by the data configuration array.
 *
 * @author Web ex Machina <https://www.webexmachina.fr>
 */
class tl_wem_planning extends Backend
{

	/**
	 * Import the back end user object
	 */
	public function __construct()
	{
		parent::__construct();
		$this->import('BackendUser', 'User');
	}

	/**
	 * Auto-generate the news alias if it has not been set yet
	 *
	 * @param mixed         $varValue
	 * @param DataContainer $dc
	 *
	 * @return string
	 *
	 * @throws Exception
	 */
	public function generateAlias($varValue, DataContainer $dc)
	{
		$autoAlias = false;

		// Generate alias if there is none
		if ($varValue == '')
		{
			$autoAlias = true;
			$varValue = StringUtil::generateAlias($dc->activeRecord->title);
		}

		$objAlias = $this->Database->prepare("SELECT id FROM tl_wem_planning WHERE alias=? AND id!=?")
								   ->execute($varValue, $dc->id);

		// Check whether the news alias exists
		if ($objAlias->numRows)
		{
			if (!$autoAlias)
			{
				throw new Exception(sprintf($GLOBALS['TL_LANG']['ERR']['aliasExists'], $varValue));
			}

			$varValue .= '-' . $dc->id;
		}

		return $varValue;
	}

	/**
	 * List a planning
	 *
	 * @param array $arrRow
	 *
	 * @return string
	 */
	public function listItems($arrRow)
	{
		$strHtml = '<div class="tl_content_left tl_wem_planning">';

		// Count drafted & confirmed booking
		$objPendingBooking = $this->Database->prepare('SELECT id FROM tl_wem_planning_booking WHERE pid=? AND status="pending"')->execute($arrRow['id']);
		$objConfirmedBooking = $this->Database->prepare('SELECT id FROM tl_wem_planning_booking WHERE pid=? AND status="confirmed"')->execute($arrRow['id']);
		
		$strHtml .= '<strong>'.$arrRow['title'].'</strong> ('.$objPendingBooking->count().' réservations à traiter et '.$objConfirmedBooking->count().' confirmées)';


		$strHtml .= '</div>';

		return $strHtml;
	}

	/**
     * Get notification choices
     *
     * @return array
     */
    public function getNotificationChoices()
    {
        $arrChoices = array();
        $objNotifications = \Database::getInstance()->execute("SELECT id,title FROM tl_nc_notification WHERE type='daily_bookings' ORDER BY title");

        while ($objNotifications->next()) {
            $arrChoices[$objNotifications->id] = $objNotifications->title;
        }

        return $arrChoices;
    }
}

<!-- L'instruction suivante sera accessible via le code PHP : &$GLOBALS['TL_LANG']['tl_wem_planning']['title'] -->
<trans-unit id="tl_wem_planning.title.0">
	<source>Title</source>
	<target>Intitulé</target>
</trans-unit>
<trans-unit id="tl_wem_planning.title.1">
	<source>Please enter a planning title.</source>
	<target>Saisir un titre de planning.</target>
</trans-unit>

<IfModule !mod_authz_core.c>
  Order allow,deny
  Allow from all
</IfModule>
<IfModule mod_authz_core.c>
  Require all granted
</IfModule>