How is a «get list» Web API request handled?

dmitrii_fediuk · June 3, 2017, 9:48am

Context: How is the /api/rest/latest/users Web API request handled?

Step 1. Oro\Bundle\SoapBundle\Controller\Api\Rest\RestGetController::handleGetListRequest()

oroinc/platform/blob/2.2.0/src/Oro/Bundle/SoapBundle/Controller/Api/Rest/RestGetController.php#L37-L83


/**
 * {@inheritdoc}
 */
public function handleGetListRequest($page = 1, $limit = self::ITEMS_PER_PAGE, $filters = [], $joins = [])
{
    $manager    = $this->getManager();
    $qb         = $manager->getListQueryBuilder($limit, $page, $filters, null, $joins);
    $totalCount = null;


    if (null !== $qb) {
        if ($manager->isSerializerConfigured()) {
            $result = $manager->serialize($qb);
        } elseif ($qb instanceof QueryBuilder) {
            $result = $this->getPreparedItems($this->get('oro_security.acl_helper')->apply($qb)->getResult());
        } elseif ($qb instanceof SqlQueryBuilder) {
            $result = $this->getPreparedItems($qb->getQuery()->getResult());
        } elseif ($qb instanceof SearchQuery) {
            $searchResult = $this->container->get('oro_search.index')->query($qb);


            $dispatcher = $this->get('event_dispatcher');
            foreach ($searchResult->getElements() as $item) {
                $dispatcher->dispatch(PrepareResultItemEvent::EVENT_NAME, new PrepareResultItemEvent($item));
            }


            $result       = $this->getPreparedItems($searchResult->toArray());
            $totalCount   = function () use ($searchResult) {
                return $searchResult->getRecordsCount();
            };
        } else {
            throw new \RuntimeException(
                sprintf(
                    'Unsupported query type: %s.',
                    is_object($qb) ? get_class($qb) : gettype($qb)
                )
            );
        }
    } else {
        $result = [];
    }


    $responseContext = ['result' => $result, 'query' => $qb];
    if (null !== $totalCount) {
        $responseContext['totalCount'] = $totalCount;
    }


    return $this->buildResponse($result, self::ACTION_LIST, $responseContext);
}

Step 2. Oro\Bundle\SoapBundle\Entity\Manager\ApiEntityManager::getListQueryBuilder()

github.com

oroinc/platform/blob/2.2.0/src/Oro/Bundle/SoapBundle/Entity/Manager/ApiEntityManager.php#L236-L257


/**
 * Returns query builder that could be used for fetching data based on given filtering criteria
 *
 * @param int   $limit
 * @param int   $page
 * @param array $criteria
 * @param null  $orderBy
 * @param array $joins
 *
 * @return QueryBuilder|SqlQueryBuilder|SearchQuery|null
 */
public function getListQueryBuilder($limit = 10, $page = 1, $criteria = [], $orderBy = null, $joins = [])
{
    $criteria = $this->prepareQueryCriteria($limit, $page, $criteria, $orderBy);


    $qb = $this->getRepository()->createQueryBuilder('e');
    $this->applyJoins($qb, $joins);


    $qb->addCriteria($criteria);


    return $qb;
}

Step 3A. Oro\Bundle\SoapBundle\Entity\Manager\ApiEntityManager::prepareQueryCriteria()

Step 3B. Doctrine\ORM\EntityRepository::createQueryBuilder()

github.com

doctrine/orm/blob/v2.5.6/lib/Doctrine/ORM/EntityRepository.php#L71-L84


/**
 * Creates a new QueryBuilder instance that is prepopulated for this entity name.
 *
 * @param string $alias
 * @param string $indexBy The index for the from.
 *
 * @return QueryBuilder
 */
public function createQueryBuilder($alias, $indexBy = null)
{
    return $this->_em->createQueryBuilder()
        ->select($alias)
        ->from($this->_entityName, $alias, $indexBy);
}