BookmarkManagement Class Reference

Inheritance diagram for BookmarkManagement:

Public Member Functions
	__construct (\Magento\Ui\Api\BookmarkRepositoryInterface $bookmarkRepository, \Magento\Framework\Api\FilterBuilder $filterBuilder, \Magento\Framework\Api\SearchCriteriaBuilder $searchCriteriaBuilder, \Magento\Authorization\Model\UserContextInterface $userContext)
	loadByNamespace ($namespace)
	getByIdentifierNamespace ($identifier, $namespace)

Protected Attributes
	$bookmarkRepository
	$searchCriteriaBuilder
	$filterBuilder
	$userContext

Detailed Description

Definition at line 9 of file BookmarkManagement.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Ui\Api\BookmarkRepositoryInterface	$bookmarkRepository,
		\Magento\Framework\Api\FilterBuilder	$filterBuilder,
		\Magento\Framework\Api\SearchCriteriaBuilder	$searchCriteriaBuilder,
		\Magento\Authorization\Model\UserContextInterface	$userContext
	)

Parameters

\Magento\Ui\Api\BookmarkRepositoryInterface	$bookmarkRepository
\Magento\Framework\Api\FilterBuilder	$filterBuilder
\Magento\Framework\Api\SearchCriteriaBuilder	$searchCriteriaBuilder
\Magento\Authorization\Model\UserContextInterface	$userContext

Definition at line 37 of file BookmarkManagement.php.

      {
        $this->bookmarkRepository = $bookmarkRepository;
        $this->searchCriteriaBuilder = $searchCriteriaBuilder;
        $this->filterBuilder = $filterBuilder;
        $this->userContext = $userContext;
    }

Member Function Documentation

getByIdentifierNamespace()

getByIdentifierNamespace	(		$identifier,
			$namespace
	)

{Retrieve bookmark by identifier and namespace

Parameters

string	$identifier
string	$namespace

Returns

\Magento\Ui\Api\Data\BookmarkInterface

}

Implements BookmarkManagementInterface.

Definition at line 77 of file BookmarkManagement.php.

    {
        $userIdFilter = $this->filterBuilder
            ->setField('user_id')
            ->setConditionType('eq')
            ->setValue($this->userContext->getUserId())
            ->create();
        $identifierFilter = $this->filterBuilder
            ->setField('identifier')
            ->setConditionType('eq')
            ->setValue($identifier)
            ->create();
        $namespaceFilter = $this->filterBuilder
            ->setField('namespace')
            ->setConditionType('eq')
            ->setValue($namespace)
            ->create();

        $this->searchCriteriaBuilder->addFilters([$userIdFilter]);
        $this->searchCriteriaBuilder->addFilters([$identifierFilter]);
        $this->searchCriteriaBuilder->addFilters([$namespaceFilter]);

        $searchCriteria = $this->searchCriteriaBuilder->create();
        $searchResults = $this->bookmarkRepository->getList($searchCriteria);
        if ($searchResults->getTotalCount() > 0) {
            foreach ($searchResults->getItems() as $searchResult) {
                $bookmark = $this->bookmarkRepository->getById($searchResult->getId());
                return $bookmark;
            }
        }

        return null;
    }

loadByNamespace()

loadByNamespace

(

$namespace

)

{Retrieve list of bookmarks by namespace

Parameters

string

$namespace

Returns

\Magento\Ui\Api\Data\BookmarkInterface[]

}

Implements BookmarkManagementInterface.

Definition at line 52 of file BookmarkManagement.php.

    {
        $userIdFilter = $this->filterBuilder
            ->setField('user_id')
            ->setConditionType('eq')
            ->setValue($this->userContext->getUserId())
            ->create();
        $namespaceFilter = $this->filterBuilder
            ->setField('namespace')
            ->setConditionType('eq')
            ->setValue($namespace)
            ->create();

        $this->searchCriteriaBuilder->addFilters([$userIdFilter]);
        $this->searchCriteriaBuilder->addFilters([$namespaceFilter]);

        $searchCriteria = $this->searchCriteriaBuilder->create();
        $searchResults = $this->bookmarkRepository->getList($searchCriteria);

        return $searchResults;
    }

Field Documentation

$bookmarkRepository

$bookmarkRepository

protected

Definition at line 14 of file BookmarkManagement.php.

$filterBuilder

$filterBuilder

protected

Definition at line 24 of file BookmarkManagement.php.

$searchCriteriaBuilder

$searchCriteriaBuilder

protected

Definition at line 19 of file BookmarkManagement.php.

$userContext

$userContext

protected

Definition at line 29 of file BookmarkManagement.php.

---

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

• vendor/magento/module-ui/Model/BookmarkManagement.php