NxTIC/manager/module/module.php

<?php

	namespace manager\module;
	use \manager\ManagerError;
	use \manager\ResourceDispatcher;

	class module{

		/* PERMET DE TESTER L'API
		*
		*/
		public static function method(){

			return array(
				'ModuleError'       => ManagerError::Success,
				'ReceivedArguments' => func_get_args()
			);

		}


		/* PERMET DE TESTER UNE L'ORDRE DES PARAMÈTRES
		*
		*/
		public static function phpunitParams($params){
			extract($params);

			return array(
				'ModuleError' => ManagerError::Success,
				'p1'          => $p1,
				'p2'          => $p2
			);
		}

		/* RENVOIE UNE DESCRIPTION EN MARKDOWN DES MODULES DE L'API
		*
		* @return markdown<String> 						Description des modules
		*
		*/
		public static function markdown(){
			/* [1] Récupération de la configuration
			=========================================================*/
			// On récupère le fichier et on le parse
			$modules = json_decode( ResourceDispatcher::getResource('f/json/modules/conf'), true );

			// Gestion de l'erreur de parsage
			if( $modules == null )
				return array( 'ModuleError' => ManagerError::ParsingFailed );

			/* [2] Mise en forme de la liste des modules
			=========================================================*/
			$markdown = "## Module List<br>";

			foreach($modules as $moduleName=>$moduleData)
				$markdown .= "- $moduleName<br>";

			/* [3] Mise en forme des méthodes des modules
			=========================================================*/
			$markdown .= '----<br>## Method List & Description<br>';

			$count = 1;
			foreach($modules as $moduleName=>$moduleData){
				$markdown .= "### $count - '$moduleName' methods<br>";

				foreach($moduleData as $methodName=>$methodData)
					$markdown .= "`$methodName` - ".$methodData['description']."<br>";

				$markdown .= '----<br>';

				$count++;
			}



			/* [n] Gestion du retour
			=========================================================*/
			return array(
				'ModuleError' => ManagerError::Success,
				'markdown'    => $markdown
			);
		}



	}



?>