/**
* Process the $expand and $select option and update the request description.
*
* @return void
*
* @throws ODataException Throws bad request error in the following cases
* (1) If $expand or select cannot be applied to the
* requested resource.
* (2) If projection is disabled by the developer
* (3) If some error occurs while parsing the options
*/
private function _processExpandAndSelect()
{
$expand = $this->_dataService->getHost()->getQueryStringItem(ODataConstants::HTTPQUERY_STRING_EXPAND);
if (!is_null($expand)) {
$this->_checkExpandOrSelectApplicable(ODataConstants::HTTPQUERY_STRING_EXPAND);
}
$select = $this->_dataService->getHost()->getQueryStringItem(ODataConstants::HTTPQUERY_STRING_SELECT);
if (!is_null($select)) {
if (!$this->_dataService->getServiceConfiguration()->getAcceptProjectionRequests()) {
ODataException::createBadRequestError(Messages::dataServiceConfigurationProjectionsNotAccepted());
}
$this->_checkExpandOrSelectApplicable(ODataConstants::HTTPQUERY_STRING_SELECT);
}
// We will generate RootProjectionNode in case of $link request also, but
// expand and select in this case must be null (we are ensuring this above)
// 'RootProjectionNode' is required while generating next page Link
if ($this->_expandSelectApplicable || $this->_requestDescription->isLinkUri()) {
try {
$rootProjectionNode = ExpandProjectionParser::parseExpandAndSelectClause($this->_requestDescription->getTargetResourceSetWrapper(), $this->_requestDescription->getTargetResourceType(), $this->_requestDescription->getInternalOrderByInfo(), $this->_requestDescription->getSkipCount(), $this->_requestDescription->getTopCount(), $expand, $select, $this->_dataService->getMetadataQueryProviderWrapper());
if ($rootProjectionNode->isSelectionSpecified()) {
$this->_requestDescription->raiseMinimumVersionRequirement(2, 0, $this->_dataService);
}
if ($rootProjectionNode->hasPagedExpandedResult()) {
$this->_requestDescription->raiseResponseVersion(2, 0, $this->_dataService);
}
$this->_requestDescription->setRootProjectionNode($rootProjectionNode);
} catch (ODataException $odataException) {
throw $odataException;
}
}
}
/**
* Applies the query options to the resource(s) retrieved from the data source.
*
* @param SegmentDescriptor &$segmentDescriptor The descriptor which holds
* resource(s) on which query
* options to be applied.
*
* @return void
*/
private function _applyQueryOptions(SegmentDescriptor &$segmentDescriptor)
{
// This function will not set RequestDescription::Count value if IDSQP2::canApplyQueryOptions
// returns false, this function assumes IDSQP2 has already set the count value in the global
// variable named _odata_server_count. temporary fix for Drupal OData Plugin support
global $_odata_server_count;
$result = $segmentDescriptor->getResult();
//Apply $filter option
if (!is_null($result)) {
$internalFilterInfo = $this->_requestDescription->getInternalFilterInfo();
if (!is_null($internalFilterInfo)) {
if (!$internalFilterInfo->isCustomExpression()) {
// The QP implementation is not going to perform the filtering
// opted for PHPExpressionProvider so run the filtering.
$filterFunction = $internalFilterInfo->getFilterFunction()->getReference();
if (is_array($result)) {
$count = count($result);
for ($i = 0; $i < $count; $i++) {
if (!$filterFunction($result[$i])) {
unset($result[$i]);
}
}
$result = array_merge($result);
} else {
if (!$filterFunction($result)) {
unset($result);
$result = null;
}
}
unset($filterFunction);
} else {
// The QP2 implementation performed the filtering so don't perform
// filtering using library generated filter function.
}
unset($internalFilterInfo);
}
}
// $inlinecount=allpages should ignore the query options
// $skiptoken, $top and $skip so take count before applying these options
if ($this->_requestDescription->getRequestCountOption() != RequestCountOption::NONE && is_array($result)) {
if ($this->_provider->canApplyQueryOptions()) {
$this->_requestDescription->setCountValue(count($result));
} else {
$this->_requestDescription->setCountValue($_odata_server_count);
}
}
// Library applies query options only if the IDSQP2::canApplyQueryOptions returns true, IDSQP::canApplyQueryOptions
// always returns true.
$applicableForSetQuery = $this->_provider->canApplyQueryOptions() && is_array($result) && !empty($result);
if ($applicableForSetQuery) {
//Apply (implicit and explicit) $orderby option
$internalOrderByInfo = $this->_requestDescription->getInternalOrderByInfo();
if (!is_null($internalOrderByInfo)) {
$orderByFunction = $internalOrderByInfo->getSorterFunction()->getReference();
usort($result, $orderByFunction);
}
//Apply $skiptoken option
$internalSkipTokenInfo = $this->_requestDescription->getInternalSkipTokenInfo();
if (!is_null($internalSkipTokenInfo)) {
$matchingIndex = $internalSkipTokenInfo->getIndexOfFirstEntryInTheNextPage($result);
$result = array_slice($result, $matchingIndex);
}
//Apply $top and $skip option
if (!empty($result)) {
$top = $this->_requestDescription->getTopCount();
$skip = $this->_requestDescription->getSkipCount();
if (!is_null($top) && !is_null($skip)) {
$result = array_slice($result, $skip, $top);
} else {
if (is_null($top)) {
$result = array_slice($result, $skip);
} else {
if (is_null($skip)) {
$result = array_slice($result, 0, $top);
}
}
}
//$skip and $top affects $count so consider here.
if ($this->_requestDescription->getRequestCountOption() == RequestCountOption::VALUE_ONLY) {
$this->_requestDescription->setCountValue(count($result));
}
}
}
$segmentDescriptor->setResult($result);
}