- md5
- 9d0bb23664263a1b737f015474a2ccc7
- sha1
- 67ac8b1e1e00850c95de1af43b5e2d33837f71de
- sha256
- a88997fa5a9cacab5cbb87d01b7187d4fdcd2b6c7e2ff1d0032b463c75d6f75d
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169
<?php
/**
* @package Joomla.API
* @subpackage com_media
*
* @copyright (C) 2021 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\Component\Media\Api\Helper;
\defined('_JEXEC') or die;
use Joomla\CMS\Component\ComponentHelper;
use Joomla\CMS\Factory;
use Joomla\CMS\Plugin\PluginHelper;
use Joomla\Component\Media\Administrator\Adapter\AdapterInterface;
use Joomla\Component\Media\Administrator\Event\MediaProviderEvent;
use Joomla\Component\Media\Administrator\Provider\ProviderInterface;
use Joomla\Component\Media\Administrator\Provider\ProviderManager;
/**
* Trait for classes that need adapters.
*
* @since 4.1.0
*/
trait AdapterTrait
{
/**
* Holds the available media file adapters.
*
* @var ProviderManager
*
* @since 4.1.0
*/
private $providerManager = null;
/**
* The default adapter name.
*
* @var string
*
* @since 4.1.0
*/
private $defaultAdapterName = null;
/**
* Returns an array with the adapter name as key and the path of the file.
*
* @return array
*
* @throws \Exception
*
* @since 4.1.0
*/
private function resolveAdapterAndPath(String $path): array
{
$result = [];
$parts = explode(':', $path, 2);
// If we have 2 parts, we have both an adapter name and a file path
if (\count($parts) == 2)
{
$result['adapter'] = $parts[0];
$result['path'] = $parts[1];
return $result;
}
if (!$this->getDefaultAdapterName())
{
throw new \InvalidArgumentException('No adapter found');
}
// If we have less than 2 parts, we return a default adapter name
$result['adapter'] = $this->getDefaultAdapterName();
// If we have 1 part, we return it as the path. Otherwise we return a default path
$result['path'] = \count($parts) ? $parts[0] : '/';
return $result;
}
/**
* Returns a provider for the given id.
*
* @return ProviderInterface
*
* @throws \Exception
*
* @since 4.1.0
*/
private function getProvider(String $id): ProviderInterface
{
return $this->getProviderManager()->getProvider($id);
}
/**
* Return an adapter for the given name.
*
* @return AdapterInterface
*
* @throws \Exception
*
* @since 4.1.0
*/
private function getAdapter(String $name): AdapterInterface
{
return $this->getProviderManager()->getAdapter($name);
}
/**
* Returns the default adapter name.
*
* @return string|null
*
* @throws \Exception
*
* @since 4.1.0
*/
private function getDefaultAdapterName(): ?string
{
if ($this->defaultAdapterName)
{
return $this->defaultAdapterName;
}
$defaultAdapter = $this->getAdapter('local-' . ComponentHelper::getParams('com_media')->get('file_path', 'images'));
if (!$defaultAdapter
&& $this->getProviderManager()->getProvider('local')
&& $this->getProviderManager()->getProvider('local')->getAdapters())
{
$defaultAdapter = $this->getProviderManager()->getProvider('local')->getAdapters()[0];
}
if (!$defaultAdapter)
{
return null;
}
$this->defaultAdapterName = 'local-' . $defaultAdapter->getAdapterName();
return $this->defaultAdapterName;
}
/**
* Return a provider manager.
*
* @return ProviderManager
*
* @since 4.1.0
*/
private function getProviderManager(): ProviderManager
{
if (!$this->providerManager)
{
$this->providerManager = new ProviderManager;
// Fire the event to get the results
$eventParameters = ['context' => 'AdapterManager', 'providerManager' => $this->providerManager];
$event = new MediaProviderEvent('onSetupProviders', $eventParameters);
PluginHelper::importPlugin('filesystem');
Factory::getApplication()->triggerEvent('onSetupProviders', $event);
}
return $this->providerManager;
}
}
The same content is in 3 releases, Joomla 4.1.0-beta1 to 4.1.0-beta3. See them all, or every version of this file.