mirror of
https://github.com/flarum/core.git
synced 2025-10-28 22:07:33 +01:00
7bceda976b
* Extender docblocks cleanup * Excplicit type hinting in extenders * Bring method under constructor * Mark some classes and methods as internal * Remove beta references Co-authored-by: Clark Winkelmann <clark.winkelmann@gmail.com>
93 lines
2.8 KiB
PHP
93 lines
2.8 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of Flarum.
|
|
*
|
|
* For detailed copyright and license information, please view the
|
|
* LICENSE file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Flarum\Extend;
|
|
|
|
use Flarum\Extension\Extension;
|
|
use Flarum\Foundation\ContainerUtil;
|
|
use Illuminate\Contracts\Container\Container;
|
|
|
|
class Filesystem implements ExtenderInterface
|
|
{
|
|
private $disks = [];
|
|
private $drivers = [];
|
|
|
|
/**
|
|
* Declare a new filesystem disk.
|
|
* Disks represent storage locations, and are backed by storage drivers.
|
|
* Flarum core uses disks for storing assets and avatars.
|
|
*
|
|
* By default, the "local" driver will be used for disks.
|
|
* The "local" driver represents the filesystem where your Flarum installation is running.
|
|
*
|
|
* To declare a new disk, you must provide default configuration a "local" driver.
|
|
*
|
|
* @param string $name: The name of the disk.
|
|
* @param string|callable $callback
|
|
*
|
|
* The callback can be a closure or an invokable class, and should accept:
|
|
* - \Flarum\Foundation\Paths $paths
|
|
* - \Flarum\Http\UrlGenerator $url
|
|
*
|
|
* The callable should return:
|
|
* - A Laravel disk config array,
|
|
* The `driver` key is not necessary for this array, and will be ignored.
|
|
*
|
|
* @example
|
|
* ```
|
|
* ->disk('flarum-uploads', function (Paths $paths, UrlGenerator $url) {
|
|
* return [
|
|
* 'root' => "$paths->public/assets/uploads",
|
|
* 'url' => $url->to('forum')->path('assets/uploads')
|
|
* ];
|
|
* });
|
|
* ```
|
|
*
|
|
* @see https://laravel.com/docs/8.x/filesystem#configuration
|
|
*
|
|
* @return self
|
|
*/
|
|
public function disk(string $name, $callback): self
|
|
{
|
|
$this->disks[$name] = $callback;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Register a new filesystem driver.
|
|
*
|
|
* @param string $name: The name of the driver.
|
|
* @param string $driverClass: The ::class attribute of the driver.
|
|
* Driver must implement `\Flarum\Filesystem\DriverInterface`.
|
|
* @return self
|
|
*/
|
|
public function driver(string $name, string $driverClass): self
|
|
{
|
|
$this->drivers[$name] = $driverClass;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function extend(Container $container, Extension $extension = null)
|
|
{
|
|
$container->extend('flarum.filesystem.disks', function ($existingDisks) use ($container) {
|
|
foreach ($this->disks as $name => $disk) {
|
|
$existingDisks[$name] = ContainerUtil::wrapCallback($disk, $container);
|
|
}
|
|
|
|
return $existingDisks;
|
|
});
|
|
|
|
$container->extend('flarum.filesystem.drivers', function ($existingDrivers) {
|
|
return array_merge($existingDrivers, $this->drivers);
|
|
});
|
|
}
|
|
}
|