| Methods |
public
|
__construct()
|
#
|
protected
|
checkConfig(): void
|
#
|
public
|
getStores()
|
#
|
public
|
find($type, $criteria, $value)
|
#
|
public
|
exists($type, $id)
|
#
|
public
|
read($type, $id)
|
#
|
public
|
write($type, $id, $value)
|
#
|
public
|
delete($type, $id)
|
#
|
protected
|
findUser(string $criteria, string $value): string|null
Parameters
| $criteria |
the criteria name
|
| $value |
the criteria value
|
Returns
the item or null if no item is found
|
#
|
protected
|
hasUser(string $uid): bool
Returns whether the user name exists in the user store.
Returns whether the user name exists in the user store.
Parameters
| $uid |
the name of the user to check
|
Returns
whether the user name exists
|
#
|
protected
|
readUser(string $uid): User|null
Loads user data for a specified user name.
Loads user data for a specified user name.
The user name must exist. You should check whether the user name exists with
the store_user_exists()
function
Parameters
| $uid |
the name of the user to load
|
Returns
data for the specified user
|
#
|
protected
|
hasClient(string $cid): bool
Returns whether the client name exists in the client store.
Returns whether the client name exists in the client store.
Parameters
| $cid |
the name of the client to check
|
Returns
whether the client name exists
|
#
|
protected
|
readClient(string $cid): Client|null
Loads client data for a specified client name.
Loads client data for a specified client name.
The client name must exist. You should check whether the client name exists with
the hasClient() function
Parameters
| $cid |
the name of the client to load
|
Returns
data for the specified user
|
#
|
protected
|
writeClient(string $cid, Client $client): void
Saves client data for a specific client name.
Saves client data for a specific client name.
This data is stored in the client store file.
Parameters
| $cid |
the name of the client
|
| $client |
the data to save
|
|
#
|
protected
|
hasKeyValue(string $type, string $name): bool
Returns whether a key-value item exists.
Returns whether a key-value item exists.
Parameters
| $type |
the item type
|
| $name |
the name of the key-value item to return
|
Returns
the value of the key-value item
|
#
|
protected
|
readKeyValue(string $type, string $name): mixed
Parameters
| $type |
the item type
|
| $name |
the name of the key-value item to return
|
Returns
the value of the key-value item
|
#
|
protected
|
writeKeyValue(string $type, string $name, mixed $value): void
Parameters
| $type |
the item type
|
| $name |
the name of the key-value item to save
|
| $value |
the value of the key-value item
|
|
#
|
protected
|
deleteKeyValue(string $type, string $name): void
Deletes a key-value item.
Deletes a key-value item.
Parameters
| $type |
the item type
|
| $name |
the name of the setting to delete
|
|
#
|
protected
|
isValidName(string $name): boolean
Determines whether a name is a valid name for use with this store.
Determines whether a name is a valid name for use with this store.
For file system storage, a name is not valid if it contains either a
directory separator (i.e. / or ).
Parameters
Returns
whether the name is valid for use with this store
|
#
|