WhitePagesPersistence
in package
Manages the reading and writing of white pages profiles.
Table of Contents
- $strategy : WhitePagesPersistenceStrategy
- __construct() : mixed
- Constructor
- canWrite() : bool
- Returns if the profile with given name can be written.
- delete() : void
- Deletes a white pages profile.
- getProfiles() : array<string|int, string>
- Returns a list of available white pages profiles.
- isValidProfileName() : bool
- Checks if the profile name is valid.
- load() : WhitePagesProfile
- Loads the given white pages profile.
- rename() : void
- Renames a white pages profile.
- save() : void
- Stores the given profile.
Properties
$strategy
private
WhitePagesPersistenceStrategy
$strategy
Methods
__construct()
Constructor
public
__construct() : mixed
Tags
Return values
mixed —canWrite()
Returns if the profile with given name can be written.
public
canWrite(string $name) : bool
Parameters
- $name : string
-
profile name
Return values
bool —can be written
delete()
Deletes a white pages profile.
public
delete(string $name) : void
Parameters
- $name : string
-
profile name
Tags
Return values
void —getProfiles()
Returns a list of available white pages profiles.
public
getProfiles() : array<string|int, string>
Return values
array<string|int, string> —profile names
isValidProfileName()
Checks if the profile name is valid.
public
static isValidProfileName(string $name) : bool
Parameters
- $name : string
-
profile name
Return values
bool —is valid
load()
Loads the given white pages profile.
public
load(string $name) : WhitePagesProfile
Parameters
- $name : string
-
profile name
Tags
Return values
WhitePagesProfile —profile
rename()
Renames a white pages profile.
public
rename(string $oldName, string $newName) : void
Parameters
- $oldName : string
-
existing profile name
- $newName : string
-
new profile name
Tags
Return values
void —save()
Stores the given profile.
public
save(string $name, WhitePagesProfile $profile) : void
Parameters
- $name : string
-
profile name
- $profile : WhitePagesProfile
-
profile