AssetHelper   A
last analyzed

Complexity

Total Complexity 6

Size/Duplication

Total Lines 29
Duplicated Lines 0 %

Test Coverage

Coverage 0%

Importance

Changes 1
Bugs 0 Features 0
Metric Value
wmc 6
eloc 14
c 1
b 0
f 0
dl 0
loc 29
ccs 0
cts 17
cp 0
rs 10

1 Method

Rating   Name   Duplication   Size   Complexity  
A getAssetInputSources() 0 22 6
1
<?php
2
/**
3
 * SEOmatic plugin for Craft CMS
4
 *
5
 * A turnkey SEO implementation for Craft CMS that is comprehensive, powerful,
6
 * and flexible
7
 *
8
 * @link      https://nystudio107.com
9
 * @copyright Copyright (c) nystudio107
10
 */
11
12
namespace nystudio107\seomatic\helpers;
13
14
use Craft;
15
use craft\elements\Asset;
16
use craft\helpers\ArrayHelper;
0 ignored issues
show
Bug introduced by
This use statement conflicts with another class in this namespace, nystudio107\seomatic\helpers\ArrayHelper. Consider defining an alias.

Let?s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let?s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/Foo.php are loaded in the same runtime, you will see a PHP error such as the following:

PHP Fatal error:  Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php

However, as OtherDir/Foo.php does not necessarily have to be loaded and the error is only triggered if it is loaded before OtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
17
18
/**
19
 * @author    nystudio107
20
 * @package   Seomatic
21
 * @since     3.5.21
22
 */
23
class AssetHelper
24
{
25
    /**
26
     * Return asset volume sources that can be accessed by the current user
27
     *
28
     * @return array
29
     */
30
    public static function getAssetInputSources(): array
31
    {
32
        $sources = [];
33
        foreach (Craft::$app->getElementIndexes()->getSources(Asset::class) as $source) {
34
            if (isset($source['key'])) {
35
                $sources[] = $source['key'];
36
            }
37
        }
38
39
        // Now enforce the showUnpermittedVolumes setting
40
        $assetsService = Craft::$app->getAssets();
41
        $userService = Craft::$app->getUser();
42
        return ArrayHelper::where($sources, function(string $source) use ($assetsService, $userService) {
43
            // If it's not a volume folder, let it through
44
            if (strpos($source, 'folder:') !== 0) {
45
                return true;
46
            }
47
            // Only show it if they have permission to view it
48
            $folder = $assetsService->getFolderByUid(explode(':', $source)[1]);
49
            $volume = $folder ? $folder->getVolume() : null;
50
            return $volume && $userService->checkPermission("viewVolume:{$volume->uid}");
51
        }, true, true, false);
52
    }
53
}
54