Inheritance diagram for GroupManagementInterface:
Public Member Functions | |
| isReadonly ($id) | |
| getDefaultGroup ($storeId=null) | |
| getNotLoggedInGroup () | |
| getLoggedInGroups () | |
| getAllCustomersGroup () | |
Detailed Description
Interface for managing customer groups. @api
- Since
- 100.0.2
Definition at line 14 of file GroupManagementInterface.php.
Member Function Documentation
◆ getAllCustomersGroup()
| getAllCustomersGroup | ( | ) |
Get customer group representing all customers.
- Returns
- \Magento\Customer\Api\Data\GroupInterface
- Exceptions
-
Implemented in GroupManagement.
◆ getDefaultGroup()
| getDefaultGroup | ( | $storeId = null | ) |
Get default customer group.
- Parameters
-
int $storeId
- Returns
- \Magento\Customer\Api\Data\GroupInterface
- Exceptions
-
Implemented in GroupManagement.
◆ getLoggedInGroups()
| getLoggedInGroups | ( | ) |
Get all customer groups except group representing customers not logged in.
- Returns
- \Magento\Customer\Api\Data\GroupInterface[]
- Exceptions
-
Implemented in GroupManagement.
◆ getNotLoggedInGroup()
| getNotLoggedInGroup | ( | ) |
Get customer group representing customers not logged in.
- Returns
- \Magento\Customer\Api\Data\GroupInterface
- Exceptions
-
Implemented in GroupManagement.
◆ isReadonly()
| isReadonly | ( | $id | ) |
Check if customer group can be deleted.
- Parameters
-
int $id
- Returns
- bool
- Exceptions
-
The documentation for this interface was generated from the following file:
- vendor/magento/module-customer/Api/GroupManagementInterface.php