4.0 KiB
Meritoo Common Library
Common and useful classes, methods, exceptions etc.
Value Objects
Located in Meritoo\Common\ValueObject namespace and in src/ValueObject/ directory.
Address
Namespace
Meritoo\Common\ValueObject\Address
Info
Represents address of company, institution, user etc. Contains properties:
$street- the street$buildingNumber- the number of building$flatNumber- the number of flat$zipCode- the zip code$city- the city, location
New instance
New instance can be created using constructor
new Address('New York', '00123', '4th Avenue', '10', '200');
Methods
Has getters for each property, e.g. getFlatNumber() or getZipCode(), and 1 extra method:
getFullStreet()
that returns name of street with related numbers (building & flat number).
Example:
$address = new Address('New York', '00123', '4th Avenue', '10', '200');
$fullStreet = $address->getFullStreet(); // "4th Avenue 10/200"
Conversion to string (the __toString() method)
Instance of Address may be represented as string that contains all non-empty properties separated by , .
Example:
$address = new Address('New York', '00123', '4th Avenue', '10', '200');
$asString = (string)$address; // "4th Avenue 10/200, 00123, New York"
BankAccount
Namespace
Meritoo\Common\ValueObject\BankAccount
Info
Represents bank account. Contains properties:
$bankName- name of bank- $accountNumber` - number of bank's account
New instance
New instance can be created using constructor
new BankAccount('Bank of America', '1234567890')
Methods
Has getters for each property getBankName() and getAccountNumber().
Conversion to string (the __toString() method)
Instance of BankAccount may be represented as string that contains all non-empty properties separated by , .
Example:
$bank = new BankAccount('Bank of America', '1234567890');
$asString = (string)$bank; // "Bank of America, 1234567890"
Company
Namespace
Meritoo\Common\ValueObject\Company
Info
Represents a company. Contains properties:
$name- name of company$address- address of company$bankAccount- bank account of company
New instance
New instance can be created using constructor:
new Company(
'Test 1',
new Address('New York', '00123', '4th Avenue', '10', '200'),
new BankAccount('Bank 1', '12345')
);
Methods
Has getters for each property getName(), getAddress() and getBankAccount().
Conversion to string (the __toString() method)
Instance of Company may be represented as string that contains all non-empty properties separated by , .
Example:
$company = new Company(
'Test 1',
new Address('New York', '00123', '4th Avenue', '10', '200'),
new BankAccount('Bank 1', '12345')
);
$asString = (string)$company; // "Test 1, 4th Avenue 10/200, 00123, New York, Bank 1, 12345"
Version
Namespace
Meritoo\Common\ValueObject\Version
Info
Represents version of software. Contains properties:
$majorPart- the "major" part of version$minorPart- the "minor" part of version$patchPart- the "patch" part of version
New instance
New instance can be created using:
-
Constructor:
new Version(1, 0, 2); -
Static methods:
fromArray()- creates new instance using given version as array
Version::fromArray([1, 0, 2]);fromString()- creates new instance using given version as string:
Version::fromString('1.0.2');