index.php File Reference

Home page for module builder module. More...

Go to the source code of this file.

Functions
foreach( $dirsrootforscan as $tmpdirread)	moduleBuilderShutdownFunction ()
	Add management to catch fatal errors - shutdown handler.
	getLicenceHeader ($user, $langs, $now)
	Produce copyright replacement string for user.
	modulebuilderValidateGeneratedFile (string $destfile, NamingContract $nc)
	Post-generation validation – logs and displays a warning if residual myobject/mymodule tokens remain.

Variables
	$moduleobj = null

Detailed Description

Home page for module builder module.

You can add parameter dirins=/home/ldestailleur/git/dolibarr/htdocs/mymodule to force generation of module into the dirins directory.

Definition in file index.php.

Function Documentation

getLicenceHeader()

getLicenceHeader	(		$user,
			$langs,
			$now )

Produce copyright replacement string for user.

Parameters

User	$user	User to produce the copyright notice for.
Translate	$langs	Translation object to use.
int	$now	Date for which the copyright will be generated.

Returns

string String to be used as replacement after Copyright (C)

Definition at line 268 of file index.php.

References dol_print_date().

moduleBuilderShutdownFunction()

foreach($dirsrootforscan as $tmpdirread) moduleBuilderShutdownFunction

(

)

Add management to catch fatal errors - shutdown handler.

Returns

void

Definition at line 244 of file index.php.

References llxFooter().

modulebuilderValidateGeneratedFile()

modulebuilderValidateGeneratedFile	(	string	$destfile,
		NamingContract	$nc )

Post-generation validation – logs and displays a warning if residual myobject/mymodule tokens remain.

Parameters

string	$destfile	Path to the generated file
NamingContract	$nc	Contract used for generation

Returns

void No return value, warnings reported as event messages

Definition at line 289 of file index.php.

References dol_syslog(), and setEventMessages().

Variable Documentation

$moduleobj

$moduleobj = null

Definition at line 3514 of file index.php.

Referenced by Utils\generateDoc().