+global\Utils::generateDoc()

Complexity

Conditions	19
Paths	143

Size

Total Lines	138
Code Lines	78

Duplication

Lines	0
Ratio	0 %

Importance

Changes

0

<?php
	function generateDoc($module)
	{
		global $conf, $dirins;

		$error = 0;

		$modulelowercase=strtolower($module);

		// Dir for module
		$dir = $dirins.'/'.$modulelowercase;
		// Zip file to build
		$FILENAMEDOC='';

		// Load module
		dol_include_once($modulelowercase.'/core/modules/mod'.$module.'.class.php');
		$class='mod'.$module;

		if (class_exists($class))
		{
			try {
				$moduleobj = new $class($db);

The variable $db does not exist. Did you forget to declare it?

			}
			catch(Exception $e)
			{
				$error++;
				dol_print_error($e->getMessage());
			}
		}
		else
		{
			$error++;
			$langs->load("errors");

The variable $langs does not exist. Did you forget to declare it?

			dol_print_error($langs->trans("ErrorFailedToLoadModuleDescriptorForXXX", $module));
			exit;
		}

		$arrayversion=explode('.',$moduleobj->version,3);
		if (count($arrayversion))
		{
			$FILENAMEASCII=strtolower($module).'.asciidoc';
			$FILENAMEDOC=strtolower($module).'.html';			// TODO Use/text PDF

			$dirofmodule = dol_buildpath(strtolower($module), 0).'/doc';
			$dirofmoduletmp = dol_buildpath(strtolower($module), 0).'/doc/temp';
			$outputfiledoc = $dirofmodule.'/'.$FILENAMEDOC;
			if ($dirofmodule)
			{
				if (! dol_is_dir($dirofmodule)) dol_mkdir($dirofmodule);
				if (! dol_is_dir($dirofmoduletmp)) dol_mkdir($dirofmoduletmp);
				if (! is_writable($dirofmoduletmp))
				{
					$this->error = 'Dir '.$dirofmoduletmp.' does not exists or is not writable';
					return -1;
				}

				$destfile=$dirofmoduletmp.'/'.$FILENAMEASCII;

				$fhandle = fopen($destfile, 'w+');
				if ($fhandle)
				{
					$specs=dol_dir_list(dol_buildpath(strtolower($module).'/doc', 0), 'files', 1, '(\.md|\.asciidoc)$', array('\/temp\/'));

					$i = 0;
					foreach ($specs as $spec)
					{
						if (preg_match('/notindoc/', $spec['relativename'])) continue;	// Discard file
						if (preg_match('/disabled/', $spec['relativename'])) continue;	// Discard file

						$pathtofile = strtolower($module).'/doc/'.$spec['relativename'];
						$format='asciidoc';
						if (preg_match('/\.md$/i', $spec['name'])) $format='markdown';

						$filecursor = @file_get_contents($spec['fullname']);
						if ($filecursor)
						{
							fwrite($fhandle, ($i ? "\n<<<\n\n" : "").$filecursor."\n");
						}
						else
						{
							$this->error = 'Failed to concat content of file '.$spec['fullname'];
							return -1;
						}

						$i++;
					}

					fwrite($fhandle, "\n\n\n== DATA SPECIFICATIONS...\n\n");

					// TODO
					fwrite($fhandle, "TODO...");

					fclose($fhandle);
				}

				$conf->global->MODULEBUILDER_ASCIIDOCTOR='asciidoctor';
				if (empty($conf->global->MODULEBUILDER_ASCIIDOCTOR))
				{
					dol_print_error('', 'Module setup not complete');
					exit;
				}

				$command=$conf->global->MODULEBUILDER_ASCIIDOCTOR.' '.$destfile.' -n -o '.$dirofmodule.'/'.$FILENAMEDOC;
				$outfile=$dirofmoduletmp.'/out.tmp';

				require_once DOL_DOCUMENT_ROOT.'/core/class/utils.class.php';
				$utils = new Utils($db);
				$resarray = $utils->executeCLI($command, $outfile);
				if ($resarray['result'] != '0')
				{
					$this->error = $resarray['error'].' '.$resarray['output'];
				}
				$result = ($resarray['result'] == 0) ? 1 : 0;
			}
			else
			{
				$result = 0;
			}

			if ($result > 0)
			{
				return 1;
			}
			else
			{
				$error++;
				$langs->load("errors");
				$this->error = $langs->trans("ErrorFailToGenerateFile", $outputfiledoc);
			}
		}
		else
		{
			$error++;
			$langs->load("errors");
			$this->error = $langs->trans("ErrorCheckVersionIsDefined");
		}

		return -1;
	}
}