lib/upgrade.inc
Properties
Description
This file includes functions to upgrade the pdf/profiles configuration files.
Functions
testPermissions(
)
:
array
Description
check the write/read permission for the upgradeReturn value
| Type |
Description |
| array |
- permission messages |
testPermissionRecursive(
String
$dir,
)
:
array
Description
Recursively checks the permissions in a directory.Arguments
| Name |
Type |
Description |
Default |
| $dir |
String |
directory |
|
Return value
| Type |
Description |
| array |
list of files/directories with wrong permission |
containsFiles(
String
$dir,
)
:
n/a
Description
Checks if the given directory contains files.This is used to check if config files need to be migrated.Arguments
| Name |
Type |
Description |
Default |
| $dir |
String |
directory path |
|
Return value
upgradeConfigToServerProfileFolders(
array
$profiles,
)
:
n/a
Description
Saves an hash array (attribute => value) to an account profileArguments
| Name |
Type |
Description |
Default |
| $profiles |
array |
server profiles |
|
Return value
copyConfigTemplates(
array
$profiles,
)
:
n/a
Description
Saves an hash array (attribute => value) to an account profileArguments
| Name |
Type |
Description |
Default |
| $profiles |
array |
server profiles |
|
Return value
recursiveCopy(
string
$src,
string
$dst,
array
$profiles,
string
$fileFilter
= null,
boolean
$overwrite
= true,
)
:
n/a
Description
Copy a file or recursively copy a directoryArguments
| Name |
Type |
Description |
Default |
| $src |
string |
- source path to file or directory
|
|
| $dst |
string |
- destination path to file or directory
|
|
| $profiles |
array |
- server profiles (used to avoid copying of newly created folders)
|
|
| $fileFilter |
string |
copy only files that start with the given filter |
null |
| $overwrite |
boolean |
overwrite existing files |
true |
Return value
recursiveDelete(
string
$src,
array
$profiles,
)
:
n/a
Description
Delete a file or recursively delete a directoryArguments
| Name |
Type |
Description |
Default |
| $src |
string |
- path to file or directory
|
|
| $profiles |
array |
- server profiles (used to avoid copying of newly created folders)
|
|
Return value