League\Flysystem\Plugin\GetWithMetadata Class Reference

Inheritance diagram for League\Flysystem\Plugin\GetWithMetadata:

Collaboration diagram for League\Flysystem\Plugin\GetWithMetadata:

Public Member Functions
	getMethod ()
	Get the method name. More...
	handle ($path, array $metadata)
	Get metadata for an object with required metadata. More...
Public Member Functions inherited from League\Flysystem\Plugin\AbstractPlugin
	setFilesystem (FilesystemInterface $filesystem)
	Set the Filesystem object. More...

Additional Inherited Members
Protected Attributes inherited from League\Flysystem\Plugin\AbstractPlugin
	$filesystem

Detailed Description

Definition at line 7 of file GetWithMetadata.php.

Member Function Documentation

getMethod()

League\Flysystem\Plugin\GetWithMetadata::getMethod

(

)

Get the method name.

Returns

string

Implements League\Flysystem\PluginInterface.

Definition at line 14 of file GetWithMetadata.php.

    {
        return 'getWithMetadata';
    }

handle()

League\Flysystem\Plugin\GetWithMetadata::handle	(		$path,
		array	$metadata
	)

Get metadata for an object with required metadata.

Parameters

string	$path	path to file
array	$metadata	metadata keys

Exceptions

InvalidArgumentException

Returns

array|false metadata

Definition at line 29 of file GetWithMetadata.php.

References $key, $keys, and $path.

    {
        $object = $this->filesystem->getMetadata($path);

        if ( ! $object) {
            return false;
        }

        $keys = array_diff($metadata, array_keys($object));

        foreach ($keys as $key) {
            if ( ! method_exists($this->filesystem, $method = 'get' . ucfirst($key))) {
                throw new InvalidArgumentException('Could not fetch metadata: ' . $key);
            }

            $object[$key] = $this->filesystem->{$method}($path);
        }

        return $object;
    }

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/league/flysystem/src/Plugin/GetWithMetadata.php