Helpers

Objects and functions used to ease your development

Objects

Address

Class used to work with address data , converts whole array into object

use BP\Helper\Address;

$address = new Address(array $addressData);
$address->fieldValue;   // Get any data from basic address block from form

// Additional fields
$address->num;          // Get number_full / number , if set
$address->zip;          // Automatically padded to 5 places with zeros from left
$address->street_full;  // Get street with numbeer
$address->city_full;    // City with number e. g. Bratislava 5
$address->city;         // City without number e. g. Bratislava
$address->city_short;   // Only city, e. g. Bratislava 5 - Podunajské Biskupice => Bratislava
$address->full;         // Fully formated address e. g. Pekná 1211/11, 85101 Bratislava
$address[Field::COUNTRY];   // Country code (CODELIST_COUNTRY)
$address->csob_region;  // ČSOB region code
$address->union_code;   // Union city code for home product
$address->zuj;          // ZUJ code for Allianz

getCsobRegion($zip, $city)

Helper to get čsob region from zip & city

$region = \BP\Helper\Address::getCsobRegion('85101', 'Bratislava');

getUnionCode($zip, $city)

Helper to get union city code from zip & city

$zuj = \BP\Helper\Address::getUnionCode('85101', 'Bratislava');

getZuj($zip, $city)

Helper to get ZUJ from zip & city

$zuj = \BP\Helper\Address::getZuj('85101', 'Bratislava');

Field

Helper class use as:

• field names storage
• field blocks names storage
• fields types storage

use Field;
...
// Get value from frontend in product
$this->get(Field::VEHICLE_TYPE);
...

Person

Person is DataObject with helper attributes

use BP\Helper\Person;

$personData = $this->get(Field::BLOCK_HOLDER);
$person = new Person(array $personData);
$person->fieldValue;   // Get any data from basic person block from form

// Additional fields
$person->address            // Address object from permanent_address field
$person[Field::BLOCK_SECONDARY_ADDRESS]   // Address object for secondary address for self employed
$person->isCompany          // true/false if is company
$person->isFo               // true/false if is FO
$person->isSe               // true/false if is self employed
$person->ico                // ico/ico_se depending if legal form is company/self employed
$person->id_number          // id_number/id_number_se depending if legal form is FO/self employed
$person->id_doc             // passport/id card number depending if legal form is FO/self employed
$person->title              // title/title_se depending if legal form is FO/self employed
$person->firstname          // firstname/firstname_se depending if legal form is FO/self employed
$person->surname            // surname/surname_se depending if legal form is FO/self employed
$person->birth              // birth/birth_se depending if legal form is FO/self employed
$person->bussiness_name     // bussiness_name/bussiness_name_se depending if legal form is company/self employed
$person->use_ico            // if isFo than false else true
$person->is_retired         // is person retired
$person->rcico              // if isFo than id_number else ico
$person->full_name          // if not company title + firstname + surname
$person->position_text      // Human readable format of position (Konateľ / Poverený pracovník) if position was set
$person->country_text       // Human readable format of country
$person->person             // if company, data for person
$person->person->full_name  // if company, data for persons name title + firstname + surname
$person->person->address    // if company, Address object from permanent_address field

DataObject

Class used to work with array, converts whole array into object

use BP\Helper\DataObject;

$data = new DataObject(array $data);
$fieldValue = $data->fieldName;     // or
$fieldValue = $data['fieldName'];

Functions

broker()

Use $this->broker() in Product

/**
 * Return User model for authorized broker
 *
 * @return User
 */

carbonify($date = null): Carbon

/**
 * Fix any date and convert into Carbon
 *
 * @param Carbon|string $date
 * @return Carbon
 */

lang(): string

/**
 * Detect environment language
 *
 * @return 'sk'|'en'
 */

local(): bool

/**
 * Detect if enviroment is in local
 *
 * @return bool
 */

notify(string $text, string $subject = '')

/**
 * Helper for sending notifications/debug email messages
 *
 * @param string $text
 * @param string $subject (optional)
 * @return void
 */

production(): bool

/**
 * Detect if enviroment is in production
 *
 * @return bool
 */

sfa(): DataObject

Use $this->sfa() in Product

/**
 * Get sfa informations
 *
 * @return DataObject
 */

test(): bool

/**
 * Detect if enviroment is in test
 *
 * @return bool
 */