Dotpay SDK
Back to top  

Agreement

Represent a structure of single agreement data.

package

Default

Methods

Initialize the agreement structure.

__construct(array $data)

Arguments

$data

array

Data of the agreement

Return a value which is saved under the given key.

get(string $name) : mixed

Arguments

$name

string

Key of a value

Response

mixed

Return all data belonged to the agreement.

getData() : array

Response

array

Check if the agreement is cheecked by default.

getDefault() : boolean

Response

boolean

Return a descriotion text of the agreement.

getDescription() : string

Response

string

Return a descriotion text decorated by HTML of the agreement.

getDescriptionHtml() : string

Response

string

Return string representation of the agreement.

getJson() : string

Response

string

Return a label of the agreement.

getLabel() : string

Response

string

Return a name of the agreement.

getName() : string

Response

string

Check if the agreement must be checked on a checkout page.

getRequired() : boolean

Response

boolean

Return a type of the agreement.

getType() : string

Response

string

Properties

Data of the agreement

data : array
var

Data of the agreement

Type(s)

array