Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface::getIncludePaths PHP Method

getIncludePaths() public method

Get requested include paths.
public getIncludePaths ( ) : array | null
return array | null
    public function getIncludePaths();

Usage Example

 /**
  * @param string $type
  *
  * @return string[]
  */
 private function getIncludePathsByType($type)
 {
     // if include paths are set in params use them otherwise use default include paths from schema
     $includePaths = $this->parameters->getIncludePaths();
     if (empty($includePaths) === false) {
         $typePaths = $includePaths;
     } else {
         $schema = $this->container->getSchemaByResourceType($type);
         $typePaths = $schema->getIncludePaths();
     }
     return $typePaths;
 }
All Usage Examples Of Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface::getIncludePaths