phpDocumentor

FileIO implements SingletonStrategyInterface

Class ConfigurationFileReader

Interfaces, Classes and Traits

SingletonStrategyInterface
Interface SingletonStrategyInterface

Table of Contents

createDirectory()  : bool
delete()  : mixed
exists()  : bool
listDirectory()  : array<string|int, mixed>
listDirectoryFiles()  : array<string|int, mixed>
patch()  : void
read()  : array<string|int, mixed>|mixed
recursive_copy()  : bool
Copy the contents of a directory recursively into another
recursive_rmdir()  : mixed
removes a directory and all it's contents
recursiveChmod()  : void
recursiveRegexSearch()  : array<string|int, mixed>
write()  : bool|false|int

Methods

createDirectory()

public createDirectory(string $path[, int $permission = 0755 ][, bool $recursive = true ]) : bool
Parameters
$path : string
$permission : int = 0755
$recursive : bool = true
Return values
bool

delete()

public delete(string $destinationFile) : mixed
Parameters
$destinationFile : string
Return values
mixed

exists()

public exists( $filePath) : bool
Parameters
$filePath :
Return values
bool

listDirectory()

public listDirectory( $path) : array<string|int, mixed>
Parameters
$path :
Return values
array<string|int, mixed>

listDirectoryFiles()

public listDirectoryFiles( $path) : array<string|int, mixed>
Parameters
$path :
Return values
array<string|int, mixed>

patch()

public patch(string $filename, stdClass $data) : void
Parameters
$filename : string
$data : stdClass
Tags
throws
Exception
Return values
void

read()

public read( $filePath) : array<string|int, mixed>|mixed
Parameters
$filePath :
Tags
throws
Exception
Return values
array<string|int, mixed>|mixed

recursive_copy()

Copy the contents of a directory recursively into another

public recursive_copy(string $source, string $destination) : bool
Parameters
$source : string

path

$destination : string

path

Tags
codeCoverageIgnore
Return values
bool

recursive_rmdir()

removes a directory and all it's contents

public recursive_rmdir( $src) : mixed
Parameters
$src :
Tags
codeCoverageIgnore
Return values
mixed

recursiveChmod()

public recursiveChmod(string $path[, int $mode = 0777 ]) : void
Parameters
$path : string
$mode : int = 0777
Return values
void

recursiveRegexSearch()

public recursiveRegexSearch( $folder,  $pattern) : array<string|int, mixed>
Parameters
$folder :
$pattern :
Return values
array<string|int, mixed>

write()

public write( $object,  $filePath) : bool|false|int
Parameters
$object :
$filePath :
Return values
bool|false|int

Search results