vendor/commerceguys/addressing/src/Repository/AddressFormatRepository.php line 84

Open in your IDE?
  1. <?php
  3. namespace CommerceGuys\Addressing\Repository;
  5. use CommerceGuys\Addressing\Model\AddressFormat;
  7. class AddressFormatRepository implements AddressFormatRepositoryInterface
  8. {
  9.     use DefinitionTranslatorTrait;
  11.     /**
  12.      * The path where address format definitions are stored.
  13.      *
  14.      * @var string
  15.      */
  16.     protected $definitionPath;
  18.     /**
  19.      * Address format definitions.
  20.      *
  21.      * @var array
  22.      */
  23.     protected $definitions = [];
  25.     /**
  26.      * Creates an AddressFormatRepository instance.
  27.      *
  28.      * @param string $definitionPath Path to the address format definitions.
  29.      *                               Defaults to 'resources/address_format'.
  30.      */
  31.     public function __construct($definitionPath = null)
  32.     {
  33.         $this->definitionPath = $definitionPath ?: __DIR__ . '/../../resources/address_format/';
  34.     }
  36.     /**
  37.      * {@inheritdoc}
  38.      */
  39.     public function get($countryCode, $locale = null)
  40.     {
  41.         $definition = $this->loadDefinition($countryCode);
  42.         if (!$definition) {
  43.             // No definition found for the given country code, fallback to ZZ.
  44.             $definition = $this->loadDefinition('ZZ');
  45.         }
  46.         $definition = $this->translateDefinition($definition, $locale);
  48.         return $this->createAddressFormatFromDefinition($definition);
  49.     }
  51.     /**
  52.      * {@inheritdoc}
  53.      */
  54.     public function getAll($locale = null)
  55.     {
  56.         // Gather available address formats.
  57.         // This is slow, but survivable because the only use case for
  58.         // fetching all address formats is mass import into another storage.
  59.         $addressFormats = [];
  60.         if ($handle = opendir($this->definitionPath)) {
  61.             while (false !== ($entry = readdir($handle))) {
  62.                 if (substr($entry, 0, 1) != '.') {
  63.                     $countryCode = strtok($entry, '.');
  64.                     $addressFormats[$countryCode] = $this->get($countryCode, $locale);
  65.                 }
  66.             }
  67.             closedir($handle);
  68.         }
  70.         return $addressFormats;
  71.     }
  73.     /**
  74.      * Loads the address format definition for the provided country code.
  75.      *
  76.      * @param string $countryCode The country code.
  77.      *
  78.      * @return array The address format definition.
  79.      */
  80.     protected function loadDefinition($countryCode)
  81.     {
  82.         if (!isset($this->definitions[$countryCode])) {
  83.             $filename = $this->definitionPath . $countryCode . '.json';
  84.             $rawDefinition = @file_get_contents($filename);
  85.             if ($rawDefinition) {
  86.                 $rawDefinition = json_decode($rawDefinition, true);
  87.                 $rawDefinition['country_code'] = $countryCode;
  88.                 $this->definitions[$countryCode] = $rawDefinition;
  89.             } else {
  90.                 // Bypass further loading attempts.
  91.                 $this->definitions[$countryCode] = [];
  92.             }
  93.         }
  95.         return $this->definitions[$countryCode];
  96.     }
  98.     /**
  99.      * Creates an address format object from the provided definition.
  100.      *
  101.      * @param array $definition The address format definition.
  102.      *
  103.      * @return AddressFormat
  104.      */
  105.     protected function createAddressFormatFromDefinition(array $definition)
  106.     {
  107.         $addressFormat = new AddressFormat();
  108.         // Bind the closure to the AddressFormat object, giving it access to
  109.         // its protected properties. Faster than both setters and reflection.
  110.         $setValues = \Closure::bind(function ($definition) {
  111.             $this->countryCode = $definition['country_code'];
  112.             $this->format = $definition['format'];
  113.             $this->requiredFields = $definition['required_fields'];
  114.             $this->uppercaseFields = $definition['uppercase_fields'];
  115.             $this->locale = $definition['locale'];
  116.             if (isset($definition['administrative_area_type'])) {
  117.                 $this->administrativeAreaType = $definition['administrative_area_type'];
  118.             }
  119.             if (isset($definition['locality_type'])) {
  120.                 $this->localityType = $definition['locality_type'];
  121.             }
  122.             if (isset($definition['dependent_locality_type'])) {
  123.                 $this->dependentLocalityType = $definition['dependent_locality_type'];
  124.             }
  125.             if (isset($definition['postal_code_type'])) {
  126.                 $this->postalCodeType = $definition['postal_code_type'];
  127.             }
  128.             if (isset($definition['postal_code_pattern'])) {
  129.                 $this->postalCodePattern = $definition['postal_code_pattern'];
  130.             }
  131.             if (isset($definition['postal_code_prefix'])) {
  132.                 $this->postalCodePrefix = $definition['postal_code_prefix'];
  133.             }
  134.         }, $addressFormat, '\CommerceGuys\Addressing\Model\AddressFormat');
  135.         $setValues($definition);
  137.         return $addressFormat;
  138.     }
  139. }