Db
in package
implements
Client
uses
HasMethodBlacklistTrait
Table of Contents
Interfaces
Properties
- $defaultZoneId : string
- $methodBlacklist : array<string|int, string>
- $recordRepo : RecordRepo
- $zoneRepo : ZoneRepo
Methods
- __construct() : mixed
- Create a Horde\Dns\Client for databases
- createRecord() : mixed
- Create a single DNS record in an existing zone
- createRecords() : mixed
- Delete multiple DNS records in an existing zone
- deleteRecord() : mixed
- Delete a single DNS record in an existing zone
- deleteRecords() : mixed
- Delete multiple DNS records in an existing zone
- getDefaultZoneId() : string
- Return the default Zone ID
- getSingleRecord() : Record|null
- Get a single record if it exists
- getZone() : Zone
- Get a Zone by Id
- getZoneRecords() : array<string|int, Record>
- Get an array of Records
- setDefaultZoneId() : mixed
- Set the default Zone ID
- updateRecord() : mixed
- Update or create if missing a single DNS record
- updateRecords() : mixed
- Update multiple DNS records in an existing zone
- methodIsBlacklisted() : bool
- setMethodBlacklist() : mixed
Properties
$defaultZoneId
private
string
$defaultZoneId
$methodBlacklist
private
array<string|int, string>
$methodBlacklist
= []
$recordRepo
private
RecordRepo
$recordRepo
$zoneRepo
private
ZoneRepo
$zoneRepo
Methods
__construct()
Create a Horde\Dns\Client for databases
public
__construct(RecordRepo $zoneRepo, RecordRepo $recordRepo[, array<string|int, mixed> $parameters = [] ]) : mixed
Parameters
- $zoneRepo : RecordRepo
-
The RecordRepo ORM implementation
- $recordRepo : RecordRepo
- $parameters : array<string|int, mixed> = []
-
See below
Parameters format: 'blacklist' => string[] A list of methods this driver will silently skip 'defaultZoneId' => The zone some commands operate on if no zone is given
createRecord()
Create a single DNS record in an existing zone
public
createRecord(string $zoneId, string $name, string $type, string|array<string|int, string> $value[, int $ttl = 600 ][, string $comment = '' ]) : mixed
Parameters
- $zoneId : string
-
The Zone Id
- $name : string
-
The DNS name of the record. No end dot.
- $type : string
-
The DNS record type
- $value : string|array<string|int, string>
-
The Value(s) of the DNS record
- $ttl : int = 600
-
The TTL of the record, defaults to 600
- $comment : string = ''
-
Set a comment for the operation
Tags
createRecords()
Delete multiple DNS records in an existing zone
public
createRecords(string $zoneId, array<string|int, mixed> $records[, string $comment = '' ]) : mixed
Parameters
- $zoneId : string
- $records : array<string|int, mixed>
-
an array of records to delete
- $comment : string = ''
deleteRecord()
Delete a single DNS record in an existing zone
public
deleteRecord(string $zoneId, string $name, string $type[, string $comment = '' ]) : mixed
Parameters
- $zoneId : string
-
The Zone Id
- $name : string
-
The DNS name of the record. No end dot.
- $type : string
-
The DNS record type
- $comment : string = ''
-
Set a comment for the operation
Tags
deleteRecords()
Delete multiple DNS records in an existing zone
public
deleteRecords(string $zoneId, array<string|int, mixed> $records[, string $comment = '' ]) : mixed
Parameters
- $zoneId : string
- $records : array<string|int, mixed>
-
an array of records to delete
- $comment : string = ''
getDefaultZoneId()
Return the default Zone ID
public
getDefaultZoneId() : string
This is used in some methods when no zone ID argument was present
Tags
Return values
string —The ID
getSingleRecord()
Get a single record if it exists
public
getSingleRecord(string $name[, string $zoneId = '' ][, array<string|int, mixed> $filters = null ]) : Record|null
Note: The returned comment will always be empty
Parameters
- $name : string
-
The DNS name of the record to retrieve. No end dot.
- $zoneId : string = ''
-
The Zone Id (optional, falls back to default zone)
- $filters : array<string|int, mixed> = null
-
A hash of additional filters to apply TBD, not implemented yet
Tags
Return values
Record|null —A record representation or null if not found
getZone()
Get a Zone by Id
public
getZone([string $zoneId = '' ]) : Zone
This is used in some methods when no zone ID argument was present
Parameters
- $zoneId : string = ''
-
The ID
Tags
Return values
Zone —A zone representation
getZoneRecords()
Get an array of Records
public
getZoneRecords([string $zoneId = '' ][, array<string|int, mixed> $filters = null ][, int $maxResults = 0 ]) : array<string|int, Record>
Parameters
- $zoneId : string = ''
-
The ID (optional, falls back to default zone)
- $filters : array<string|int, mixed> = null
-
A hash of additional filters to apply TBD, not implemented yet
- $maxResults : int = 0
-
Maximum amount of records to get. values <= 0 mean no limit
Tags
Return values
array<string|int, Record> —A list of record representations
setDefaultZoneId()
Set the default Zone ID
public
setDefaultZoneId(string $zoneId) : mixed
This is used in some methods when no zone ID argument was present
Parameters
- $zoneId : string
-
The ID
Tags
updateRecord()
Update or create if missing a single DNS record
public
updateRecord(string $zoneId, string $name, string $type, string|array<string|int, string> $value[, int $ttl = 600 ][, string $comment = '' ]) : mixed
Parameters
- $zoneId : string
-
The Zone Id
- $name : string
-
The DNS name of the record. No end dot.
- $type : string
-
The DNS record type
- $value : string|array<string|int, string>
-
The Value(s) of the DNS record
- $ttl : int = 600
-
The TTL of the record, defaults to 600
- $comment : string = ''
-
Set a comment for the operation
Tags
updateRecords()
Update multiple DNS records in an existing zone
public
updateRecords(string $zoneId, array<string|int, mixed> $records[, string $comment = '' ]) : mixed
Parameters
- $zoneId : string
- $records : array<string|int, mixed>
-
an array of records to delete
- $comment : string = ''
methodIsBlacklisted()
private
methodIsBlacklisted(string $methodName) : bool
Parameters
- $methodName : string
Return values
boolsetMethodBlacklist()
private
setMethodBlacklist(array<string|int, mixed>|null $methods) : mixed
Parameters
- $methods : array<string|int, mixed>|null