AbstractAutoUpdaterHelper
in package
Class AbstractAutoUpdaterHelper
Table of Contents
- $ftpManager : AutoUpdaterFtpManager
- $settings : AutoUpdaterSettings
- deleteFile() : bool
- Copies a file.
- changeFileBasePath() : string
- Replaces the base directory path of a given file path with a new base directory path.
- copyFile() : bool
- Copies a file.
- createDirectory() : bool
- Return true on success, otherwise false.
- deleteDirectory() : bool
- Deletes a directory. Return true on success and false otherwise.
- getDirectoryFiles() : array<string|int, mixed>
- Returns an array with all files inside a given directory and his subdirectories.
- setCorrectChmodAndOwner() : bool
- Sets the file permissions and ownership correctly.
Properties
$ftpManager
protected
AutoUpdaterFtpManager
$ftpManager
$settings
protected
AutoUpdaterSettings
$settings
Methods
deleteFile()
Copies a file.
public
deleteFile(string $file) : bool
Parameters
- $file : string
Return values
bool —changeFileBasePath()
Replaces the base directory path of a given file path with a new base directory path.
protected
changeFileBasePath(string $file, string $oldBasePath, string $newBasePath) : string
Parameters
- $file : string
- $oldBasePath : string
- $newBasePath : string
Return values
string —Returns new path of the file. If an error occurs the unmodified file path will be returned.
copyFile()
Copies a file.
protected
copyFile(string $source, string $destination) : bool
Parameters
- $source : string
- $destination : string
Return values
bool —createDirectory()
Return true on success, otherwise false.
protected
createDirectory(string $directory[, bool $writable = false ]) : bool
Parameters
- $directory : string
-
Path of the new directory.
- $writable : bool = false
Return values
bool —deleteDirectory()
Deletes a directory. Return true on success and false otherwise.
protected
deleteDirectory(string $directory) : bool
Parameters
- $directory : string
Return values
bool —getDirectoryFiles()
Returns an array with all files inside a given directory and his subdirectories.
protected
getDirectoryFiles(string $directory) : array<string|int, mixed>
Parameters
- $directory : string
Return values
array<string|int, mixed> —setCorrectChmodAndOwner()
Sets the file permissions and ownership correctly.
protected
setCorrectChmodAndOwner(string $file[, null|string $chmod = null ][, null|string $owner = null ]) : bool
Parameters
- $file : string
- $chmod : null|string = null
- $owner : null|string = null