Documentation

PackageExport
in package

Provides API to package vtiger CRM module and associated files.

Table of Contents

$_export_modulexml_file  : mixed
$_export_modulexml_filename  : mixed
$_export_tmpdir  : mixed
$moduleInstance  : mixed
$openNode  : mixed
$zipFileName  : mixed
__cleanupExport()  : mixed
Clean up the temporary files created.
__construct()  : mixed
Constructor.
__copyLanguageFiles()  : mixed
Function copies language files to zip.
__finishExport()  : mixed
Post export work.
__getManifestFilePath()  : mixed
Set the module.xml file path for this export and return its temporary path.
__initExport()  : mixed
Initialize Export.
__write()  : mixed
closeNode()  : mixed
export()  : mixed
Export Module as a zip file.
exportActions()  : mixed
Export actions.
exportBlocks()  : mixed
Export module blocks with its related fields.
exportCronTasks()  : mixed
Export cron tasks for the module.
exportCustomLinks()  : mixed
Export custom links of the module.
exportCustomViews()  : mixed
Export Custom views of the module.
exportDependencies()  : mixed
Export vtiger dependencies.
exportFields()  : mixed
Export fields related to a module block.
exportInventory()  : mixed
Export module inventory fields.
exportModule()  : mixed
Export Module Handler.
exportRelatedLists()  : mixed
Export related lists associated with module.
exportSharingAccess()  : mixed
Export Sharing Access of the module.
exportTables()  : mixed
Export module base and related tables.
getZipFileName()  : string
Get last name of zip file.
openNode()  : mixed
Output Handlers
outputNode()  : mixed

Properties

$_export_modulexml_file

public mixed $_export_modulexml_file

$_export_modulexml_filename

public mixed $_export_modulexml_filename

$_export_tmpdir

public mixed $_export_tmpdir = 'cache/vtlib'

Methods

__cleanupExport()

Clean up the temporary files created.

public __cleanupExport() : mixed
Return values
mixed —

__construct()

Constructor.

public __construct() : mixed
Return values
mixed —

__copyLanguageFiles()

Function copies language files to zip.

public __copyLanguageFiles(Zip $zip, string $module) : mixed
Parameters
$zip : Zip
$module : string
Return values
mixed —

__finishExport()

Post export work.

public __finishExport() : mixed
Return values
mixed —

__getManifestFilePath()

Set the module.xml file path for this export and return its temporary path.

public __getManifestFilePath() : mixed
Return values
mixed —

__initExport()

Initialize Export.

public __initExport(mixed $module) : mixed
Parameters
$module : mixed
Return values
mixed —

__write()

public __write(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed —

closeNode()

public closeNode(mixed $node[, mixed $delimiter = PHP_EOL ][, mixed $space = true ]) : mixed
Parameters
$node : mixed
$delimiter : mixed = PHP_EOL
$space : mixed = true
Return values
mixed —

export()

Export Module as a zip file.

public export(Module $moduleInstance[, string $todir = '' ][, string $zipFileName = '' ][, bool $directDownload = false ]) : mixed
Parameters
$moduleInstance : Module

Instance of module

$todir : string = ''

Output directory path

$zipFileName : string = ''

Zipfilename to use

$directDownload : bool = false

True for sending the output as download

Return values
mixed —

exportBlocks()

Export module blocks with its related fields.

public exportBlocks(ModuleBasic $moduleInstance) : mixed
Parameters
$moduleInstance : ModuleBasic
Return values
mixed —

exportCronTasks()

Export cron tasks for the module.

public exportCronTasks(ModuleBasic $moduleInstance) : mixed
Parameters
$moduleInstance : ModuleBasic
Return values
mixed —

exportCustomLinks()

Export custom links of the module.

public exportCustomLinks(ModuleBasic $moduleInstance) : mixed
Parameters
$moduleInstance : ModuleBasic
Return values
mixed —

exportCustomViews()

Export Custom views of the module.

public exportCustomViews(ModuleBasic $moduleInstance) : mixed
Parameters
$moduleInstance : ModuleBasic
Return values
mixed —

exportDependencies()

Export vtiger dependencies.

public exportDependencies(ModuleBasic $moduleInstance) : mixed
Parameters
$moduleInstance : ModuleBasic
Return values
mixed —

exportFields()

Export fields related to a module block.

public exportFields(ModuleBasic $moduleInstance, int $blockid) : mixed
Parameters
$moduleInstance : ModuleBasic
$blockid : int
Return values
mixed —

exportInventory()

Export module inventory fields.

public exportInventory() : mixed
Return values
mixed —

exportModule()

Export Module Handler.

public exportModule() : mixed
Return values
mixed —

exportRelatedLists()

Export related lists associated with module.

public exportRelatedLists(ModuleBasic $moduleInstance) : mixed
Parameters
$moduleInstance : ModuleBasic
Return values
mixed —

exportSharingAccess()

Export Sharing Access of the module.

public exportSharingAccess(ModuleBasic $moduleInstance) : mixed
Parameters
$moduleInstance : ModuleBasic
Return values
mixed —

exportTables()

Export module base and related tables.

public exportTables() : mixed
Return values
mixed —

getZipFileName()

Get last name of zip file.

public getZipFileName() : string
Return values
string —

openNode()

Output Handlers

public openNode(mixed $node[, mixed $delimiter = PHP_EOL ]) : mixed
Parameters
$node : mixed
$delimiter : mixed = PHP_EOL
Return values
mixed —

outputNode()

public outputNode(mixed $value[, mixed $node = '' ]) : mixed
Parameters
$value : mixed
$node : mixed = ''
Return values
mixed — 

        

        
    




    

    

                

    

        

            
Search results