Documentation

RosetteParamsSetBase
in package

AbstractYes

Class RosetteParamsSetBase.

Table of Contents

Methods

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
Validates parameters before serializing them.
__construct()  : mixed
Constructor.
removeEmptyProperties()  : mixed
Recursively removes empty properties to facilitate json encoding.

Methods

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