/**
* {@inheritDoc}
*/
public function __construct($options = NULL)
{
parent::__construct($options);
// Validate all fields by default.
if (empty($this->fields)) {
$this->fields = array_values(AddressField::getAll());
}
}
/**
* Gets the list of used fields, grouped by line.
*
* Used for generating address forms.
*
* @return array An array of address fields grouped by line, in the same
* order as they appear in the format string. For example:
* [
* [givenName, familyName],
* [organization],
* [addressLine1],
* [addressLine2],
* [locality, administrativeArea, postalCode]
* ]
*/
public static function getGroupedFields($format)
{
$groupedFields = [];
$expression = '/\\%(' . implode('|', AddressField::getAll()) . ')/';
$formatLines = explode("\n", $format);
foreach ($formatLines as $index => $formatLine) {
preg_match_all($expression, $formatLine, $foundTokens);
foreach ($foundTokens[0] as $token) {
$groupedFields[$index][] = substr($token, 1);
}
}
// The indexes won't be sequential if there were any rows
// without tokens, so reset them.
$groupedFields = array_values($groupedFields);
return $groupedFields;
}
/**
* Gets the list of used fields.
*
* @return array An array of address fields.
*/
public function getUsedFields()
{
if (empty($this->usedFields)) {
$this->usedFields = [];
foreach (AddressField::getAll() as $field) {
if (strpos($this->format, '%' . $field) !== false) {
$this->usedFields[] = $field;
}
}
}
return $this->usedFields;
}
