Algo-Web / POData-Laravel

src/Serialisers/IronicSerialiser.php

Doc Comments +12 added lines, -6 removed lines

@@ -107,7 +107,7 @@ 
     /**
      * Write a top level entry resource.
      *
-     * @param mixed $entryObject Reference to the entry object to be written
+     * @param QueryResult $entryObject Reference to the entry object to be written
      *
      * @return ODataEntry
      */
@@ -257,7 +257,7 @@ 
     /**
      * Write top level url element.
      *
-     * @param mixed $entryObject The entry resource whose url to be written
+     * @param QueryResult $entryObject The entry resource whose url to be written
      *
      * @return ODataURL
      */
@@ -281,7 +281,7 @@ 
     /**
      * Write top level url collection.
      *
-     * @param array $entryObjects Array of entry resources
+     * @param QueryResult $entryObjects Array of entry resources
      *                            whose url to be written
      *
      * @return ODataURLCollection
@@ -441,6 +441,9 @@ 
         return $this->stack;
     }
 
+    /**
+     * @param string $containerName
+     */
     protected function getEntryInstanceKey($entityInstance, ResourceType $resourceType, $containerName)
     {
         $typeName = $resourceType->getName();
@@ -472,7 +475,7 @@ 
     /**
      * @param $entryObject
      * @param $type
-     * @param $relativeUri
+     * @param string $relativeUri
      * @param $resourceType
      * @return array
      */
@@ -539,7 +542,7 @@ 
      * Find a 'ExpandedProjectionNode' instance in the projection tree
      * which describes the current segment.
      *
-     * @return ExpandedProjectionNode|null
+     * @return null|\POData\UriProcessor\QueryProcessor\ExpandProjectionParser\RootProjectionNode|ExpandedProjectionNode
      */
     protected function getCurrentExpandedProjectionNode()
     {
@@ -764,7 +767,7 @@ 
     /**
      * @param $entryObject
      * @param $prop
-     * @param $nuLink
+     * @param ODataLink $nuLink
      * @param $propKind
      * @param $propName
      */
@@ -875,6 +878,9 @@ 
         return $internalContent;
     }
 
+    /**
+     * @param ResourcePropertyKind $resourceKind
+     */
     public static function isMatchPrimitive($resourceKind)
     {
         if (16 > $resourceKind) {

Spacing +25 added lines, -25 removed lines

@@ -99,7 +99,7 @@ 
         $this->service = $service;
         $this->request = $request;
         $this->absoluteServiceUri = $service->getHost()->getAbsoluteServiceUri()->getUrlAsString();
-        $this->absoluteServiceUriWithSlash = rtrim($this->absoluteServiceUri, '/') . '/';
+        $this->absoluteServiceUriWithSlash = rtrim($this->absoluteServiceUri, '/').'/';
         $this->stack = new SegmentStack($request);
         $this->complexTypeInstanceCollection = [];
         $this->modelSerialiser = new ModelSerialiser();
@@ -145,7 +145,7 @@ 
             $resourceType,
             $resourceSet->getName()
         );
-        $absoluteUri = rtrim($this->absoluteServiceUri, '/') . '/' . $relativeUri;
+        $absoluteUri = rtrim($this->absoluteServiceUri, '/').'/'.$relativeUri;
 
         list($mediaLink, $mediaLinks) = $this->writeMediaData($entryObject->results, $type, $relativeUri, $resourceType);
 
@@ -166,8 +166,8 @@ 
             $propType = 'application/atom+xml;type='.$propTail;
             $propName = $prop->getName();
             $nuLink->title = $propName;
-            $nuLink->name = ODataConstants::ODATA_RELATED_NAMESPACE . $propName;
-            $nuLink->url = $relativeUri . '/' . $propName;
+            $nuLink->name = ODataConstants::ODATA_RELATED_NAMESPACE.$propName;
+            $nuLink->url = $relativeUri.'/'.$propName;
             $nuLink->type = $propType;
 
             $navProp = new ODataNavigationPropertyInfo($prop, $this->shouldExpandSegment($propName));
@@ -203,7 +203,7 @@ 
      *
      * @return ODataFeed
      */
-    public function writeTopLevelElements(QueryResult &$entryObjects)
+    public function writeTopLevelElements(QueryResult & $entryObjects)
     {
         assert(is_array($entryObjects->results), '!is_array($entryObjects->results)');
 
@@ -240,7 +240,7 @@ 
         $resourceSet = $this->getRequest()->getTargetResourceSetWrapper()->getResourceSet();
         $requestTop = $this->getRequest()->getTopOptionCount();
         $pageSize = $this->getService()->getConfiguration()->getEntitySetPageSize($resourceSet);
-        $requestTop = (null == $requestTop) ? $pageSize + 1 : $requestTop;
+        $requestTop = (null == $requestTop) ? $pageSize+1 : $requestTop;
 
         if (true === $entryObjects->hasMore && $requestTop > $pageSize) {
             $stackSegment = $setName;
@@ -248,7 +248,7 @@ 
             $segment = $this->getNextLinkUri($lastObject, $absoluteUri);
             $nextLink = new ODataLink();
             $nextLink->name = ODataConstants::ATOM_LINK_NEXT_ATTRIBUTE_STRING;
-            $nextLink->url = rtrim($this->absoluteServiceUri, '/') . '/' . $stackSegment . $segment;
+            $nextLink->url = rtrim($this->absoluteServiceUri, '/').'/'.$stackSegment.$segment;
             $odata->nextPageLink = $nextLink;
         }
 
@@ -273,7 +273,7 @@ 
                 $this->getCurrentResourceSetWrapper()->getName()
             );
 
-            $url->url = rtrim($this->absoluteServiceUri, '/') . '/' . $relativeUri;
+            $url->url = rtrim($this->absoluteServiceUri, '/').'/'.$relativeUri;
         }
 
         return $url;
@@ -303,7 +303,7 @@ 
                 $segment = $this->getNextLinkUri($lastObject, $this->getRequest()->getRequestUrl()->getUrlAsString());
                 $nextLink = new ODataLink();
                 $nextLink->name = ODataConstants::ATOM_LINK_NEXT_ATTRIBUTE_STRING;
-                $nextLink->url = rtrim($this->absoluteServiceUri, '/') . '/' . $stackSegment . $segment;
+                $nextLink->url = rtrim($this->absoluteServiceUri, '/').'/'.$stackSegment.$segment;
                 $urls->nextPageLink = $nextLink;
             }
         }
@@ -327,7 +327,7 @@ 
      *
      * @return ODataPropertyContent
      */
-    public function writeTopLevelComplexObject(QueryResult &$complexValue, $propertyName, ResourceType &$resourceType)
+    public function writeTopLevelComplexObject(QueryResult & $complexValue, $propertyName, ResourceType & $resourceType)
     {
         $result = $complexValue->results;
 
@@ -356,7 +356,7 @@ 
      *                                    bag object
      * @return ODataPropertyContent
      */
-    public function writeTopLevelBagObject(QueryResult &$BagValue, $propertyName, ResourceType &$resourceType)
+    public function writeTopLevelBagObject(QueryResult & $BagValue, $propertyName, ResourceType & $resourceType)
     {
         $result = $BagValue->results;
 
@@ -379,7 +379,7 @@ 
      *                                            primitive property to be written
      * @return ODataPropertyContent
      */
-    public function writeTopLevelPrimitive(QueryResult &$primitiveValue, ResourceProperty &$resourceProperty = null)
+    public function writeTopLevelPrimitive(QueryResult & $primitiveValue, ResourceProperty & $resourceProperty = null)
     {
         assert(null != $resourceProperty, "Resource property must not be null");
         $propertyContent = new ODataPropertyContent();
@@ -447,7 +447,7 @@ 
         $typeName = $resourceType->getName();
         $keyProperties = $resourceType->getKeyProperties();
         assert(count($keyProperties) != 0, 'count($keyProperties) == 0');
-        $keyString = $containerName . '(';
+        $keyString = $containerName.'(';
         $comma = null;
         foreach ($keyProperties as $keyName => $resourceProperty) {
             $keyType = $resourceProperty->getInstanceType();
@@ -461,7 +461,7 @@ 
             }
 
             $keyValue = $keyType->convertToOData($keyValue);
-            $keyString .= $comma . $keyName . '=' . $keyValue;
+            $keyString .= $comma.$keyName.'='.$keyValue;
             $comma = ',';
         }
 
@@ -486,7 +486,7 @@ 
         $mediaLink = null;
         if ($resourceType->isMediaLinkEntry()) {
             $eTag = $streamProviderWrapper->getStreamETag2($entryObject, null, $context);
-            $mediaLink = new ODataMediaLink($type, '/$value', $relativeUri . '/$value', '*/*', $eTag);
+            $mediaLink = new ODataMediaLink($type, '/$value', $relativeUri.'/$value', '*/*', $eTag);
         }
         $mediaLinks = [];
         if ($resourceType->hasNamedStream()) {
@@ -627,7 +627,7 @@ 
         $segmentWrappers = $this->getStack()->getSegmentWrappers();
         $count = count($segmentWrappers);
 
-        return 0 == $count ? $this->getRequest()->getTargetResourceSetWrapper() : $segmentWrappers[$count - 1];
+        return 0 == $count ? $this->getRequest()->getTargetResourceSetWrapper() : $segmentWrappers[$count-1];
     }
 
     /**
@@ -677,22 +677,22 @@ 
             $value = $this->getService()->getHost()->getQueryStringItem($queryOption);
             if (!is_null($value)) {
                 if (!is_null($queryParameterString)) {
-                    $queryParameterString = $queryParameterString . '&';
+                    $queryParameterString = $queryParameterString.'&';
                 }
 
-                $queryParameterString .= $queryOption . '=' . $value;
+                $queryParameterString .= $queryOption.'='.$value;
             }
         }
 
         $topCountValue = $this->getRequest()->getTopOptionCount();
         if (!is_null($topCountValue)) {
-            $remainingCount = $topCountValue - $this->getRequest()->getTopCount();
+            $remainingCount = $topCountValue-$this->getRequest()->getTopCount();
             if (0 < $remainingCount) {
                 if (!is_null($queryParameterString)) {
                     $queryParameterString .= '&';
                 }
 
-                $queryParameterString .= ODataConstants::HTTPQUERY_STRING_TOP . '=' . $remainingCount;
+                $queryParameterString .= ODataConstants::HTTPQUERY_STRING_TOP.'='.$remainingCount;
             }
         }
 
@@ -721,7 +721,7 @@ 
      *
      * @return string
      */
-    private function primitiveToString(IType &$type, $primitiveValue)
+    private function primitiveToString(IType & $type, $primitiveValue)
     {
         if ($type instanceof Boolean) {
             $stringValue = (true === $primitiveValue) ? 'true' : 'false';
@@ -793,7 +793,7 @@ 
                 $nuLink->expandedResult->selfLink->title = $propName;
                 $nuLink->expandedResult->selfLink->url = $nuLink->url;
                 $nuLink->expandedResult->title = $propName;
-                $nuLink->expandedResult->id = rtrim($this->absoluteServiceUri, '/') . '/' . $nuLink->url;
+                $nuLink->expandedResult->id = rtrim($this->absoluteServiceUri, '/').'/'.$nuLink->url;
             }
         }
     }
@@ -807,7 +807,7 @@ 
     {
         $this->service = $service;
         $this->absoluteServiceUri = $service->getHost()->getAbsoluteServiceUri()->getUrlAsString();
-        $this->absoluteServiceUriWithSlash = rtrim($this->absoluteServiceUri, '/') . '/';
+        $this->absoluteServiceUriWithSlash = rtrim($this->absoluteServiceUri, '/').'/';
     }
 
     /**
@@ -815,7 +815,7 @@ 
      * @param $result
      * @return ODataBagContent
      */
-    protected function writeBagValue(ResourceType &$resourceType, $result)
+    protected function writeBagValue(ResourceType & $resourceType, $result)
     {
         assert(null == $result || is_array($result), 'Bag parameter must be null or array');
         $typeKind = $resourceType->getResourceTypeKind();
@@ -847,7 +847,7 @@ 
      * @param string $propertyName
      * @return ODataPropertyContent
      */
-    protected function writeComplexValue(ResourceType &$resourceType, &$result, $propertyName = null)
+    protected function writeComplexValue(ResourceType & $resourceType, &$result, $propertyName = null)
     {
         assert(is_object($result), 'Supplied $customObject must be an object');