Documentation

Vtiger_Loader
in package

Table of Contents

$componentClassCache  : mixed
$includeCache  : mixed
$includePathCache  : mixed
$loaderDirs  : mixed
autoLoad()  : bool
Function to auto load the required class files matching the directory pattern modules/xyz/types/Abc.php for class xyz_Abc_Type.
getComponentClassName()  : string
Function to get the class name of a given Component, of given Type, for a given Module.
getRealPathFile()  : string
Returns canonicalized absolute pathname for css/js files.
includeOnce()  : bool
Function to include a given php file through qualified file name.
includePath()  : mixed
resolveNameToPath()  : string
Static function to resolve the qualified php filename to absolute path.
resolveRelativePath()  : string
Static function to resolve the qualified php filename to relative path.

Properties

$componentClassCache

protected static mixed $componentClassCache = []

$includeCache

protected static mixed $includeCache = []

$includePathCache

protected static mixed $includePathCache = []

$loaderDirs

protected static mixed $loaderDirs = ['custom.modules.', 'modules.']

Methods

autoLoad()

Function to auto load the required class files matching the directory pattern modules/xyz/types/Abc.php for class xyz_Abc_Type.

public static autoLoad(string $className) : bool
Parameters
$className : string
Return values
bool

getComponentClassName()

Function to get the class name of a given Component, of given Type, for a given Module.

public static getComponentClassName(string $componentType, string $componentName[, string $moduleName = 'Vtiger' ][, mixed $throwException = true ]) : string
Parameters
$componentType : string
$componentName : string
$moduleName : string = 'Vtiger'
$throwException : mixed = true
Tags
throws
AppException
Return values
string

Required Class Name

getRealPathFile()

Returns canonicalized absolute pathname for css/js files.

public static getRealPathFile(string $filePath, string $fileExtension, array<string|int, mixed> $layoutPaths) : string
Parameters
$filePath : string
$fileExtension : string
$layoutPaths : array<string|int, mixed>
Return values
string

includeOnce()

Function to include a given php file through qualified file name.

public static includeOnce(string $qualifiedName) : bool
Parameters
$qualifiedName : string
Return values
bool

includePath()

public static includePath(mixed $qualifiedName) : mixed
Parameters
$qualifiedName : mixed
Return values
mixed

resolveNameToPath()

Static function to resolve the qualified php filename to absolute path.

public static resolveNameToPath(string $qualifiedName[, mixed $fileExtension = 'php' ]) : string
Parameters
$qualifiedName : string
$fileExtension : mixed = 'php'
Return values
string

Absolute File Name

resolveRelativePath()

Static function to resolve the qualified php filename to relative path.

public static resolveRelativePath(string $qualifiedName[, string $fileExtension = 'php' ]) : string
Parameters
$qualifiedName : string
$fileExtension : string = 'php'
Return values
string

Search results