GroupManagement Class Reference

Inheritance diagram for GroupManagement:

Public Member Functions
	__construct (StoreManagerInterface $storeManager, ScopeConfigInterface $scopeConfig, GroupFactory $groupFactory, GroupRepositoryInterface $groupRepository, GroupInterfaceFactory $groupDataFactory, SearchCriteriaBuilder $searchCriteriaBuilder, FilterBuilder $filterBuilder)
	getDefaultGroup ($storeId=null)
	getNotLoggedInGroup ()
	getLoggedInGroups ()
	getAllCustomersGroup ()
Public Member Functions inherited from GroupManagementInterface
	isReadonly ($id)

Data Fields
const	XML_PATH_DEFAULT_ID = 'customer/create_account/default_group'
const	NOT_LOGGED_IN_ID = 0
const	CUST_GROUP_ALL = 32000
const	GROUP_CODE_MAX_LENGTH = 32

Protected Attributes
	$storeManager
	$scopeConfig
	$groupFactory
	$groupRepository
	$groupDataFactory
	$searchCriteriaBuilder
	$filterBuilder

Detailed Description

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 23 of file GroupManagement.php.

Constructor & Destructor Documentation

__construct()

__construct	(	StoreManagerInterface	$storeManager,
		ScopeConfigInterface	$scopeConfig,
		GroupFactory	$groupFactory,
		GroupRepositoryInterface	$groupRepository,
		GroupInterfaceFactory	$groupDataFactory,
		SearchCriteriaBuilder	$searchCriteriaBuilder,
		FilterBuilder	$filterBuilder
	)

Parameters

StoreManagerInterface	$storeManager
ScopeConfigInterface	$scopeConfig
GroupFactory	$groupFactory
GroupRepositoryInterface	$groupRepository
GroupInterfaceFactory	$groupDataFactory
SearchCriteriaBuilder	$searchCriteriaBuilder
FilterBuilder	$filterBuilder

Definition at line 77 of file GroupManagement.php.

      {
        $this->storeManager = $storeManager;
        $this->scopeConfig = $scopeConfig;
        $this->groupFactory = $groupFactory;
        $this->groupRepository = $groupRepository;
        $this->groupDataFactory = $groupDataFactory;
        $this->searchCriteriaBuilder = $searchCriteriaBuilder;
        $this->filterBuilder = $filterBuilder;
    }

Member Function Documentation

getAllCustomersGroup()

getAllCustomersGroup

(

)

{Get customer group representing all customers.

Returns

\Magento\Customer\Api\Data\GroupInterface

Exceptions

}

Implements GroupManagementInterface.

Definition at line 168 of file GroupManagement.php.

    {
        $groupDataObject = $this->groupDataFactory->create();
        $groupDataObject->setId(self::CUST_GROUP_ALL);
        return $groupDataObject;
    }

getDefaultGroup()

getDefaultGroup

(

$storeId = null

)

{Get default customer group.

Parameters

int

$storeId

Returns

\Magento\Customer\Api\Data\GroupInterface

Exceptions

}

Implements GroupManagementInterface.

Definition at line 112 of file GroupManagement.php.

    {
        if ($storeId === null) {
            $storeId = $this->storeManager->getStore()->getCode();
        }
        try {
            $groupId = $this->scopeConfig->getValue(
                self::XML_PATH_DEFAULT_ID,
                \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
                $storeId
            );
        } catch (\Magento\Framework\Exception\State\InitException $e) {
            throw NoSuchEntityException::singleField('storeId', $storeId);
        } catch (NoSuchEntityException $e) {
            throw NoSuchEntityException::singleField('storeId', $storeId);
        }
        try {
            return $this->groupRepository->getById($groupId);
        } catch (NoSuchEntityException $e) {
            throw NoSuchEntityException::doubleField('groupId', $groupId, 'storeId', $storeId);
        }
    }

getLoggedInGroups()

getLoggedInGroups

(

)

{Get all customer groups except group representing customers not logged in.

Returns

\Magento\Customer\Api\Data\GroupInterface[]

Exceptions

}

Implements GroupManagementInterface.

Definition at line 146 of file GroupManagement.php.

    {
        $notLoggedInFilter[] = $this->filterBuilder
            ->setField(GroupInterface::ID)
            ->setConditionType('neq')
            ->setValue(self::NOT_LOGGED_IN_ID)
            ->create();
        $groupAll[] = $this->filterBuilder
            ->setField(GroupInterface::ID)
            ->setConditionType('neq')
            ->setValue(self::CUST_GROUP_ALL)
            ->create();
        $searchCriteria = $this->searchCriteriaBuilder
            ->addFilters($notLoggedInFilter)
            ->addFilters($groupAll)
            ->create();
        return $this->groupRepository->getList($searchCriteria)->getItems();
    }

getNotLoggedInGroup()

getNotLoggedInGroup

(

)

{Get customer group representing customers not logged in.

Returns

\Magento\Customer\Api\Data\GroupInterface

Exceptions

}

Implements GroupManagementInterface.

Definition at line 138 of file GroupManagement.php.

    {
        return $this->groupRepository->getById(self::NOT_LOGGED_IN_ID);
    }

Field Documentation

$filterBuilder

$filterBuilder

protected

Definition at line 66 of file GroupManagement.php.

$groupDataFactory

$groupDataFactory

protected

Definition at line 56 of file GroupManagement.php.

$groupFactory

$groupFactory

protected

Definition at line 46 of file GroupManagement.php.

$groupRepository

$groupRepository

protected

Definition at line 51 of file GroupManagement.php.

$scopeConfig

$scopeConfig

protected

Definition at line 41 of file GroupManagement.php.

$searchCriteriaBuilder

$searchCriteriaBuilder

protected

Definition at line 61 of file GroupManagement.php.

$storeManager

$storeManager

protected

Definition at line 36 of file GroupManagement.php.

CUST_GROUP_ALL

const CUST_GROUP_ALL = 32000

Definition at line 29 of file GroupManagement.php.

GROUP_CODE_MAX_LENGTH

const GROUP_CODE_MAX_LENGTH = 32

Definition at line 31 of file GroupManagement.php.

NOT_LOGGED_IN_ID

const NOT_LOGGED_IN_ID = 0

Definition at line 27 of file GroupManagement.php.

XML_PATH_DEFAULT_ID

const XML_PATH_DEFAULT_ID = 'customer/create_account/default_group'

Definition at line 25 of file GroupManagement.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-customer/Model/GroupManagement.php