Class: Services_DynDNS_Request_common

Source Location: /Services_DynDNS-0.3.1/DynDNS/Request/common.php

Class Overview

An abstract class which provides common functionality for all current types of DynDNS REST API requests

Author(s):

Bryan Dunlap <bdunlap at bryandunlap.com>

Version:

Release: @package_version@

Variables

Methods

Child classes:

Services_DynDNS_Request_dyndns: Encapsulates a 'dyndns' request to the DynDND REST API

Services_DynDNS_Request_custom: Encapsulates a 'custom' request to the DynDND REST API

Services_DynDNS_Request_statdns: Encapsulates a 'statdns' request to the DynDND REST API

Inherited Variables

Inherited Methods

Class Details

[line 35]
An abstract class which provides common functionality for all current types of DynDNS REST API requests

Author: Bryan Dunlap <bdunlap@bryandunlap.com>
Version: Release: @package_version@
License: PHP License 3.0

[ Top ]

Class Variables

$host =

[line 46]

The hostname of the DynDNS web service

Access: protected

Type:

string

[ Top ]

$parameters = array()

[line 70]

Parameters for the request

Access: protected

Type:

array

[ Top ]

$service =

[line 54]

The path to the DynDNS web service

Access: protected

Type:

string

[ Top ]

$system =

[line 62]

The DynDNS system to use for requests

Access: protected

Type:

string

[ Top ]

Method Detail

addHostname [line 114]

string addHostname(
string
$hostname)

Appends a hostname to the end of the 'hostname' parameter string

Access: public

Parameters:

string $hostname — a string containing the hostname

[ Top ]

build [line 82]

object &build(
)

Build and return an HTTP_Request object reflecting the specifics of this particular DynDNS_Request

Access: public

[ Top ]

getParameter [line 131]

string getParameter(
string
$name)

Returns the value for a specific parameter

Access: public

Parameters:

string $name — a string containing the name of the parameter

[ Top ]

initialize [line 175]

void initialize(
)

Sets the default DynDNS host, service and user agent

Access: protected

[ Top ]

setParameter [line 155]

void setParameter(
string
$name, array
$value)

Sets the value for a specific parameter

Access: public

Parameters:

string	`$name`	—	a string containing the name of the parameter
array	`$value`	—	a string containing value of the parameter

[ Top ]