phpDocumentor

CustomerSuburb
in package
implements CustomerSuburbInterface Uses StringUtilityTrait

Class CustomerSuburb

Represents a customer suburb

Tags
category

System

subpackage

ValueObjects

Interfaces, Classes and Traits

CustomerSuburbInterface
Value Object.

Table of Contents

$suburb  : string
Customer's suburb.
__construct()  : mixed
Constructor of the class CustomerSuburb
__toString()  : string
Returns the equivalent string value.
strlenWrapper()  : mixed

Properties

Methods

__construct()

Constructor of the class CustomerSuburb

public __construct(string $p_suburb) : mixed

Validates the length and the data type of the customer suburb.

Parameters
$p_suburb : string

Customer's suburb.

Tags
throws
InvalidArgumentException

If $p_suburb is not a string.

throws
LengthException

If $p_suburb contains more characters than 32.

Return values
mixed

__toString()

Returns the equivalent string value.

public __toString() : string
Return values
string

Equivalent string value.

strlenWrapper()

protected strlenWrapper(mixed $string[, mixed $encoding = 'utf-8' ]) : mixed
Parameters
$string : mixed
$encoding : mixed = 'utf-8'
Return values
mixed

Search results