arch-8.x-1.x-dev/modules/order/modules/addressbook/src/Services/UserAddressesServiceInterface.php

<?php

namespace Drupal\arch_addressbook\Services;

use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
use Drupal\Core\Session\AccountInterface;

/**
 * User addresses service interface.
 *
 * @package Drupal\arch_addressbook\Services
 */
interface UserAddressesServiceInterface extends ContainerInjectionInterface {

  /**
   * Get user addresses.
   *
   * @param \Drupal\Core\Session\AccountInterface|null $account
   *   User object to get a specific user's addresses, or current user used.
   * @param bool $filter_empty_address
   *   Do not return items without stored address values.
   *
   * @return \Drupal\arch_addressbook\AddressbookitemInterface[]
   *   AddressbookItem list.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function getByUser(
    ?AccountInterface $account = NULL,
    bool $filter_empty_address = FALSE,
  );

  /**
   * Load AddresbookItem entities by property values.
   *
   * @param array $values
   *   An associative array where the keys are the property names and the
   *   values are the values those properties must have.
   * @param \Drupal\Core\Session\AccountInterface|null $account
   *   Owner account.
   * @param bool $filter_empty_address
   *   Do not return items without stored address values.
   *
   * @return \Drupal\arch_addressbook\AddressbookitemInterface[]
   *   List of found items.
   */
  public function getByProperties(
    array $values,
    ?AccountInterface $account = NULL,
    bool $filter_empty_address = FALSE,
  );

}