StrictNamingContractValidator Class Reference

Strict implementation — reports any residual myobject/mymodule token as a warning. More...

Inheritance diagram for StrictNamingContractValidator:

Collaboration diagram for StrictNamingContractValidator:

Public Member Functions
	validateContent (string $content, string $filePath)
	validateClassName (string $className, NamingContract $nc)
	validateTriggerFilename (string $filename, NamingContract $nc)
	validateUrl (string $url, NamingContract $nc)
	validateRightsKey (string $rightsKey, NamingContract $nc)

Private Member Functions
	lineContainsNonRenamableMarker (string $line)

Detailed Description

Strict implementation — reports any residual myobject/mymodule token as a warning.

Lines containing MODULEBUILDER structural markers (/* BEGIN MODULEBUILDER ... ‌/) are excluded from validation because those markers are intentional template anchors that must remain as-is (e.g. / BEGIN MODULEBUILDER API MYOBJECT *‌/ is used by addObjectsToApiFile).

Definition at line 87 of file NamingContractValidator.class.php.

Member Function Documentation

lineContainsNonRenamableMarker()

StrictNamingContractValidator::lineContainsNonRenamableMarker ( string $line )

private

Parameters

string

$line

Line content to check

Returns

bool True if there is a NON_RENAMABLE_MARKER in the line

Definition at line 129 of file NamingContractValidator.class.php.

Referenced by validateContent().

validateClassName()

StrictNamingContractValidator::validateClassName	(	string	$className,
		NamingContract	$nc )

Parameters

string	$className	Class name to validate
NamingContract	$nc	Naming contract to compare against

Returns

bool True if class name is valid

Implements NamingContractValidator.

Definition at line 144 of file NamingContractValidator.class.php.

validateContent()

StrictNamingContractValidator::validateContent	(	string	$content,
		string	$filePath )

Parameters

string	$content	Full file content to validate
string	$filePath	File path used in error messages

Returns

string[]

Implements NamingContractValidator.

Definition at line 105 of file NamingContractValidator.class.php.

References lineContainsNonRenamableMarker().

validateRightsKey()

StrictNamingContractValidator::validateRightsKey	(	string	$rightsKey,
		NamingContract	$nc )

Parameters

string	$rightsKey	Rights key to validate
NamingContract	$nc	Naming contract to compare against

Returns

bool True if $rightskey is valid for this module

Implements NamingContractValidator.

Definition at line 181 of file NamingContractValidator.class.php.

validateTriggerFilename()

StrictNamingContractValidator::validateTriggerFilename	(	string	$filename,
		NamingContract	$nc )

Parameters

string	$filename	Trigger filename to validate
NamingContract	$nc	Naming contract to compare against

Returns

bool True if filename for Trigger is valid

Implements NamingContractValidator.

Definition at line 154 of file NamingContractValidator.class.php.

validateUrl()

StrictNamingContractValidator::validateUrl	(	string	$url,
		NamingContract	$nc )

Parameters

string	$url	URL path to validate
NamingContract	$nc	Naming contract to compare against

Returns

bool True if urlpath for module item is valid

Implements NamingContractValidator.

Definition at line 169 of file NamingContractValidator.class.php.

---

The documentation for this class was generated from the following file:

• dolibarr_dev/htdocs/modulebuilder/class/NamingContractValidator.class.php