Documentation

UnfieldedAddress extends RosetteParamsSetBase
in package
implements IAddress

Class that represents an Address.

Table of Contents

Interfaces

IAddress
Interface implemented by all Addresses

Properties

$address  : string
The address

Methods

__construct()  : mixed
Constructor.
fielded()  : bool
is this a fielded address?
get()  : mixed
Gets a property value based on the property name.
getMultiPartContent()  : string
Provides default multiPart call for child classes that don't implement it
serialize()  : string
Serialize into a json string.
set()  : mixed
Sets a property based on the name.
validate()  : mixed
required validate function
removeEmptyProperties()  : mixed
Recursively removes empty properties to facilitate json encoding.

Properties

Methods

__construct()

Constructor.

public __construct([mixed $address = null ]) : mixed
Parameters
$address : mixed = null

fielded()

is this a fielded address?

public fielded() : bool
Return values
bool

get()

Gets a property value based on the property name.

public get(string $propertyName) : mixed
Parameters
$propertyName : string

the name of the property

Tags
throws
RosetteException

if property name not found

Return values
mixed

property value

getMultiPartContent()

Provides default multiPart call for child classes that don't implement it

public getMultiPartContent() : string
Return values
string

serialize()

Serialize into a json string.

public serialize(mixed $options) : string
Parameters
$options : mixed

associative array of options

Return values
string

set()

Sets a property based on the name.

public set(string $propertyName, mixed $value) : mixed
Parameters
$propertyName : string

the name of the property

$value : mixed

the value to set

removeEmptyProperties()

Recursively removes empty properties to facilitate json encoding.

private removeEmptyProperties(mixed $obj) : mixed
Parameters
$obj : mixed

Object to clean


        
On this page

Search results