feat(assets): add getAssets and isAssetUnlinked methods

Author: Grant Ellis

src/Contentful.php

@@ -15,6 +15,7 @@
 use Markup\Contentful\Exception\ResourceUnavailableException;
 use Markup\Contentful\Filter\ContentTypeFilterProvider;
 use Markup\Contentful\Filter\DecidesCacheKeyInterface;
+use Markup\Contentful\Filter\LinksToAssetFilter;
 use Markup\Contentful\Filter\LocaleFilter;
 use Markup\Contentful\Log\LoggerInterface;
 use Markup\Contentful\Log\LogInterface;
@@ -274,6 +275,61 @@ public function getAssetAsync($id, $space = null, array $options = [], $locale =
         );
     }
 
+    /**
+     * @param array $parameters
+     * @param null $space
+     * @param array $options
+     * @return PromiseInterface|AssetInterface[]
+     */
+    public function getAssets(array $parameters = [], $space = null, array $options = [])
+    {
+        $spaceName = ($space instanceof SpaceInterface) ? $space->getName() : $space;
+        $spaceData = $this->getSpaceDataForName($spaceName);
+        $api = ($spaceData['preview_mode']) ? self::PREVIEW_API : self::CONTENT_DELIVERY_API;
+
+        return $this->doRequest(
+            $spaceData,
+            $spaceName,
+            $this->getEndpointUrl(sprintf('/spaces/%s/assets', $spaceData['key']), $api),
+            sprintf('The assets from the space "%s" were unavailable.', $spaceName),
+            $api,
+            'assets',
+            '',
+            $parameters,
+            $options
+        );
+    }
+
+    /**
+     * @param array $parameters
+     * @param null $space
+     * @param array $options
+     * @return ResourceArrayPromise
+     */
+    public function getAssetsAsync(array $parameters = [], $space = null, array $options = [])
+    {
+        return new ResourceArrayPromise(
+            $this->getAssets($parameters, $space, array_merge($options, ['async' => true]))
+        );
+    }
+
+    /**
+     * @param string $assetId
+     * @param string|SpaceInterface $space
+     * @return bool
+     */
+    public function isAssetUnlinked($assetId, $space = null)
+    {
+        $filters = [];
+        $filters[] = new LinksToAssetFilter($assetId);
+
+        $linkedEntries = $this->getEntries($filters, $space);
+
+        $totalEntries = $linkedEntries->getTotal();
+
+        return ($totalEntries > 0) ? false : true;
+    }
+
     /**
      * @param string                $id
      * @param string|SpaceInterface $space

src/Filter/LinksToAssetFilter.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Markup\Contentful\Filter;
+
+use Markup\Contentful\FilterInterface;
+
+class LinksToAssetFilter implements FilterInterface
+{
+    use ClassBasedNameTrait;
+
+    const KEY = 'links_to_asset';
+
+    /**
+     * @var string
+     */
+    private $value;
+
+    /**
+     * @param string $value
+     */
+    public function __construct($value)
+    {
+        $this->value = $value;
+    }
+
+    /**
+     * The key in a query string on an API request.
+     *
+     * @return string
+     */
+    public function getKey()
+    {
+        return self::KEY;
+    }
+
+    /**
+     * The value in a query string on an API request.
+     *
+     * @return string
+     */
+    public function getValue()
+    {
+        return $this->value;
+    }
+}

tests/ContentfulTest.php

@@ -17,6 +17,7 @@
 use Markup\Contentful\Link;
 use Markup\Contentful\Log\LogInterface;
 use Markup\Contentful\Metadata;
+use Markup\Contentful\Promise\ResourceArrayPromise;
 use Markup\Contentful\Property\FieldProperty;
 use Markup\Contentful\Property\SystemProperty;
 use Markup\Contentful\ResourceArray;
@@ -199,6 +200,32 @@ public function testGetAssetDecorates()
         $this->assertSame($asset, $decoratedAsset);
     }
 
+    public function testGetAssets()
+    {
+        $handlerOption = $this->getSuccessHandlerOption($this->getSuccessAssetData(), '235345lj34h53j4h');
+        $contentful = $this->getContentful(null, array_merge($this->options, $handlerOption));
+        $assets = $contentful->getAssets();
+        $this->assertInstanceOf(AssetInterface::class, $assets);
+    }
+
+    public function testGetAssetsAsync()
+    {
+        $handlerOption = $this->getSuccessHandlerOption($this->getSuccessAssetData(), '235345lj34h53j4h');
+        $contentful = $this->getContentful(null, array_merge($this->options, $handlerOption));
+        $assets = $contentful->getAssetsAsync();
+        $this->assertInstanceOf(ResourceArrayPromise::class, $assets);
+        $this->assertInstanceOf(PromiseInterface::class, $assets);
+    }
+
+    public function testIsAssetUnlinked()
+    {
+        $handlerOption = $this->getSuccessHandlerOption($this->getEntriesData(), '235345lj34h53j4h');
+        $contentful = $this->getContentful(null, array_merge($this->options, $handlerOption));
+        $assetUnlinked = $contentful->isAssetUnlinked('nyancat');
+        $this->assertInternalType('bool', $assetUnlinked);
+        $this->assertFalse($assetUnlinked);
+    }
+
     private function getSuccessAssetData()
     {
         return [