Please enable JavaScript to view this site.

Process Designer

Navigation: PHP API > Access default directories

Complete path to the data directory (getFullDataPath)

Scroll Prev Top Next More

This function allows you to determine the complete path to the data directory or to a file located below this directory.

Parameter

Type

Description

$path

string

Relative file path or file name (optional)

$processName

string

Process name (optional)

$processVersion

string

Process version (optional); is this omitted, only the process specific directory without the version subdirectory is returned.

This function returns the complete path to the data directory, the process or specific process version subdirectory or a file located within.

In case no parameter is passed, the complete path to the data directory is returned.

In case $path is passed, the complete path to the stated file located below the data directory is returned.

In case $path and $processName are passed, the complete path to the stated file located below the process specific data subdirectory is returned.

In case $path, $processName and $processVersion is passed, the complete path to the stated file located below the specific process version data subdirectory is returned.

Example:

// Determining the path to the data main directory

$dataPath = $this->getFullDataPath();

 

// Determining the path to the file "form.pdf" in the data main directory

$pdfFormPath = $this->getFullDataPath('form.pdf');

 

// Determining the path to the process specific data subdirectory

$dataProcessPath = $this->getFullDataPath('', 'TESTPROCESS');

 

// Determining the path to the process version specific data subdirectory

$dataProcessVersionPath = $this->getFullDataPath('', TESTPROCESS', 1);