1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 <?php
/**
* BEdita, API-first content management framework
* Copyright 2017 ChannelWeb Srl, Chialab Srl
*
* This file is part of BEdita: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* See LICENSE.LGPL or <http://gnu.org/licenses/lgpl-3.0.html> for more details.
*/
namespace BEdita\Core\Filesystem;
use Cake\Core\InstanceConfigTrait;
use League\Flysystem\AdapterInterface;
/**
* Filesystem adapter.
*
* This abstract class is a wrapper around Flysystem adapters, to ensure they can be instantiated
* in a consistent way by delegating adapter's specific initialization logic to subclasses.
*
* Also, subclasses of this class are responsible for building public URLs from which files can
* be accessed, although a generic implementation is present in this abstract class.
*
* @since 4.0.0
*/
abstract class FilesystemAdapter
{
use InstanceConfigTrait;
/**
* Default configuration for adapter.
*
* @var array
*/
protected $_defaultConfig = [
'baseUrl' => null,
'visibility' => 'public',
];
/**
* Inner adapter instance.
*
* @var \League\Flysystem\AdapterInterface
*/
protected $adapter;
/**
* Initialize filesystem adapter class.
*
* @param array $config Configuration.
* @return bool
*/
public function initialize(array $config)
{
$this->setConfig($config);
return true;
}
/**
* Get the inner adapter class.
*
* @return \League\Flysystem\AdapterInterface
*/
public function getInnerAdapter()
{
if (!empty($this->adapter)) {
return $this->adapter;
}
$adapter = $this->buildAdapter($this->getConfig());
if (!($adapter instanceof AdapterInterface)) {
throw new \RuntimeException(
sprintf('Filesystem adapters must use %s as a base class.', AdapterInterface::class)
);
}
return $this->adapter = $adapter;
}
/**
* Build the inner adapter from configuration.
*
* @param array $config Adapter configuration.
* @return \League\Flysystem\AdapterInterface
*/
abstract protected function buildAdapter(array $config);
/**
* Get public URL for an item.
*
* @param string $path Resource path.
* @return string
*/
public function getPublicUrl($path)
{
return sprintf(
'%s/%s',
rtrim($this->getConfig('baseUrl'), '/'),
ltrim($path, '/')
);
}
/**
* Get default visibility for this adapter.
*
* @return string|null
*/
public function getVisibility()
{
return $this->getConfig('visibility');
}
}