123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081 |
- <?php
- /**
- *
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
- */
- namespace Magento\Customer\Api;
- /**
- * Customer CRUD interface.
- * @api
- * @since 100.0.2
- */
- interface CustomerRepositoryInterface
- {
- /**
- * Create or update a customer.
- *
- * @param \Magento\Customer\Api\Data\CustomerInterface $customer
- * @param string $passwordHash
- * @return \Magento\Customer\Api\Data\CustomerInterface
- * @throws \Magento\Framework\Exception\InputException If bad input is provided
- * @throws \Magento\Framework\Exception\State\InputMismatchException If the provided email is already used
- * @throws \Magento\Framework\Exception\LocalizedException
- */
- public function save(\Magento\Customer\Api\Data\CustomerInterface $customer, $passwordHash = null);
- /**
- * Retrieve customer.
- *
- * @param string $email
- * @param int|null $websiteId
- * @return \Magento\Customer\Api\Data\CustomerInterface
- * @throws \Magento\Framework\Exception\NoSuchEntityException If customer with the specified email does not exist.
- * @throws \Magento\Framework\Exception\LocalizedException
- */
- public function get($email, $websiteId = null);
- /**
- * Get customer by Customer ID.
- *
- * @param int $customerId
- * @return \Magento\Customer\Api\Data\CustomerInterface
- * @throws \Magento\Framework\Exception\NoSuchEntityException If customer with the specified ID does not exist.
- * @throws \Magento\Framework\Exception\LocalizedException
- */
- public function getById($customerId);
- /**
- * Retrieve customers which match a specified criteria.
- *
- * This call returns an array of objects, but detailed information about each object’s attributes might not be
- * included. See https://devdocs.magento.com/codelinks/attributes.html#CustomerRepositoryInterface to determine
- * which call to use to get detailed information about all attributes for an object.
- *
- * @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria
- * @return \Magento\Customer\Api\Data\CustomerSearchResultsInterface
- * @throws \Magento\Framework\Exception\LocalizedException
- */
- public function getList(\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria);
- /**
- * Delete customer.
- *
- * @param \Magento\Customer\Api\Data\CustomerInterface $customer
- * @return bool true on success
- * @throws \Magento\Framework\Exception\LocalizedException
- */
- public function delete(\Magento\Customer\Api\Data\CustomerInterface $customer);
- /**
- * Delete customer by Customer ID.
- *
- * @param int $customerId
- * @return bool true on success
- * @throws \Magento\Framework\Exception\NoSuchEntityException
- * @throws \Magento\Framework\Exception\LocalizedException
- */
- public function deleteById($customerId);
- }
|