mirror/php-flarum
1
0
Fork 0
mirror of https://github.com/flarum/core.git synced 2025-08-07 00:47:00 +02:00
Code Issues Releases Wiki Activity

chore: increase phpstan level to 6 (#3836)

Browse Source 
* chore: increase phpstan level to 6

Signed-off-by: Sami Mazouz <sychocouldy@gmail.com>

* Apply fixes from StyleCI

---------

Signed-off-by: Sami Mazouz <sychocouldy@gmail.com>
Co-authored-by: StyleCI Bot <bot@styleci.io>
This commit is contained in:
Sami Mazouz
2023-06-21 14:31:24 +01:00
committed by GitHub
parent 4a966b830f
commit 5820a16a96
84 changed files with 228 additions and 189 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
framework/core/src/Api/Controller/CreatePostController.php
View File

@@ -39,9 +39,10 @@ class CreatePostController extends AbstractCreateController
{
$actor = RequestUtil::getActor($request);
$data = Arr::get($request->getParsedBody(), 'data', []);
$discussionId = Arr::get($data, 'relationships.discussion.data.id');
$discussionId = (int) Arr::get($data, 'relationships.discussion.data.id');
$ipAddress = $request->getAttribute('ipAddress');
/** @var CommentPost $post */
$post = $this->bus->dispatch(
new PostReply($discussionId, $actor, $data, $ipAddress)
);
@@ -56,7 +57,7 @@ class CreatePostController extends AbstractCreateController
}
$discussion = $post->discussion;
$discussion->posts = $discussion->posts()->whereVisibleTo($actor)->orderBy('created_at')->pluck('id');
$discussion->setRelation('posts', $discussion->posts()->whereVisibleTo($actor)->orderBy('created_at')->pluck('id'));
$this->loadRelations($post->newCollection([$post]), $this->extractInclude($request), $request);

2
framework/core/src/Api/Controller/UpdateDiscussionController.php
View File

@@ -33,7 +33,7 @@ class UpdateDiscussionController extends AbstractShowController
protected function data(ServerRequestInterface $request, Document $document): Discussion
{
$actor = RequestUtil::getActor($request);
$discussionId = Arr::get($request->getQueryParams(), 'id');
$discussionId = (int) Arr::get($request->getQueryParams(), 'id');
$data = Arr::get($request->getParsedBody(), 'data', []);
/** @var Discussion $discussion */

11
framework/core/src/Api/Middleware/ThrottleApi.php
View File

@@ -17,11 +17,9 @@ use Psr\Http\Server\RequestHandlerInterface as Handler;
class ThrottleApi implements Middleware
{
protected $throttlers;
public function __construct(array $throttlers)
{
$this->throttlers = $throttlers;
public function __construct(
protected array $throttlers
) {
}
public function process(Request $request, Handler $handler): Response
@@ -33,9 +31,6 @@ class ThrottleApi implements Middleware
return $handler->handle($request);
}
/**
* @return bool
*/
public function throttle(Request $request): bool
{
$throttle = false;

14
framework/core/src/Api/Serializer/BasicDiscussionSerializer.php
View File

@@ -40,37 +40,37 @@ class BasicDiscussionSerializer extends AbstractSerializer
];
}
protected function user($discussion): ?Relationship
protected function user(Discussion $discussion): ?Relationship
{
return $this->hasOne($discussion, BasicUserSerializer::class);
}
protected function firstPost($discussion): ?Relationship
protected function firstPost(Discussion $discussion): ?Relationship
{
return $this->hasOne($discussion, BasicPostSerializer::class);
}
protected function lastPostedUser($discussion): ?Relationship
protected function lastPostedUser(Discussion $discussion): ?Relationship
{
return $this->hasOne($discussion, BasicUserSerializer::class);
}
protected function lastPost($discussion): ?Relationship
protected function lastPost(Discussion $discussion): ?Relationship
{
return $this->hasOne($discussion, BasicPostSerializer::class);
}
protected function posts($discussion): ?Relationship
protected function posts(Discussion $discussion): ?Relationship
{
return $this->hasMany($discussion, PostSerializer::class);
}
protected function mostRelevantPost($discussion): ?Relationship
protected function mostRelevantPost(Discussion $discussion): ?Relationship
{
return $this->hasOne($discussion, PostSerializer::class);
}
protected function hiddenUser($discussion): ?Relationship
protected function hiddenUser(Discussion $discussion): ?Relationship
{
return $this->hasOne($discussion, BasicUserSerializer::class);
}

2
framework/core/src/Api/Serializer/BasicUserSerializer.php
View File

@@ -42,7 +42,7 @@ class BasicUserSerializer extends AbstractSerializer
];
}
protected function groups($user): Relationship
protected function groups(User $user): Relationship
{
if ($this->getActor()->can('viewHiddenGroups')) {
return $this->hasMany($user, GroupSerializer::class);

6
framework/core/src/Api/Serializer/ForumSerializer.php
View File

@@ -100,7 +100,7 @@ class ForumSerializer extends AbstractSerializer
return $attributes;
}
protected function groups($model): ?Relationship
protected function groups(array $model): ?Relationship
{
return $this->hasMany($model, GroupSerializer::class);
}
@@ -119,12 +119,12 @@ class ForumSerializer extends AbstractSerializer
return $faviconPath ? $this->getAssetUrl($faviconPath) : null;
}
public function getAssetUrl($assetPath): string
public function getAssetUrl(string $assetPath): string
{
return $this->assetsFilesystem->url($assetPath);
}
protected function actor($model): ?Relationship
protected function actor(array $model): ?Relationship
{
return $this->hasOne($model, CurrentUserSerializer::class);
}

3
framework/core/src/Console/Schedule.php
View File

@@ -11,6 +11,7 @@ namespace Flarum\Console;
use Flarum\Foundation\Config;
use Illuminate\Console\Scheduling\Schedule as LaravelSchedule;
use Illuminate\Contracts\Container\Container;
use Illuminate\Support\Collection;
class Schedule extends LaravelSchedule
@@ -21,7 +22,7 @@ class Schedule extends LaravelSchedule
return (new Collection($this->events))->filter->isDue(new class($app) {
protected Config $config;
public function __construct($app)
public function __construct(Container $app)
{
$this->config = $app->make(Config::class);
}

14
framework/core/src/Database/Migration.php
View File

@@ -21,7 +21,7 @@ use Illuminate\Database\Schema\Builder;
*/
abstract class Migration
{
public static function createTable($name, callable $definition): array
public static function createTable(string $name, callable $definition): array
{
return [
'up' => function (Builder $schema) use ($name, $definition) {
@@ -35,7 +35,7 @@ abstract class Migration
];
}
public static function createTableIfNotExists($name, callable $definition): array
public static function createTableIfNotExists(string $name, callable $definition): array
{
return [
'up' => function (Builder $schema) use ($name, $definition) {
@@ -51,7 +51,7 @@ abstract class Migration
];
}
public static function renameTable($from, $to): array
public static function renameTable(string $from, string $to): array
{
return [
'up' => function (Builder $schema) use ($from, $to) {
@@ -63,7 +63,7 @@ abstract class Migration
];
}
public static function addColumns($tableName, array $columnDefinitions): array
public static function addColumns(string $tableName, array $columnDefinitions): array
{
return [
'up' => function (Builder $schema) use ($tableName, $columnDefinitions) {
@@ -82,7 +82,7 @@ abstract class Migration
];
}
public static function dropColumns($tableName, array $columnDefinitions): array
public static function dropColumns(string $tableName, array $columnDefinitions): array
{
$inverse = static::addColumns($tableName, $columnDefinitions);
@@ -92,12 +92,12 @@ abstract class Migration
];
}
public static function renameColumn($tableName, $from, $to): array
public static function renameColumn(string $tableName, string $from, string $to): array
{
return static::renameColumns($tableName, [$from => $to]);
}
public static function renameColumns($tableName, array $columnNames): array
public static function renameColumns(string $tableName, array $columnNames): array
{
return [
'up' => function (Builder $schema) use ($tableName, $columnNames) {

2
framework/core/src/Database/ScopeVisibilityTrait.php
View File

@@ -22,7 +22,7 @@ trait ScopeVisibilityTrait
*/
protected static array $visibilityScopers = [];
public static function registerVisibilityScoper($scoper, ?string $ability = null): void
public static function registerVisibilityScoper(callable $scoper, ?string $ability = null): void
{
$model = static::class;

12
framework/core/src/Discussion/Access/DiscussionPolicy.php
View File

@@ -21,14 +21,16 @@ class DiscussionPolicy extends AbstractPolicy
) {
}
public function can(User $actor, string $ability)
public function can(User $actor, string $ability): ?string
{
if ($actor->hasPermission('discussion.'.$ability)) {
return $this->allow();
}
return null;
}
public function rename(User $actor, Discussion $discussion)
public function rename(User $actor, Discussion $discussion): ?string
{
if ($discussion->user_id == $actor->id && $actor->can('reply', $discussion)) {
$allowRenaming = $this->settings->get('allow_renaming');
@@ -39,9 +41,11 @@ class DiscussionPolicy extends AbstractPolicy
return $this->allow();
}
}
return null;
}
public function hide(User $actor, Discussion $discussion)
public function hide(User $actor, Discussion $discussion): ?string
{
if ($discussion->user_id == $actor->id
&& $discussion->participant_count <= 1
@@ -50,5 +54,7 @@ class DiscussionPolicy extends AbstractPolicy
) {
return $this->allow();
}
return null;
}
}

2
framework/core/src/Discussion/Command/EditDiscussion.php
View File

@@ -14,7 +14,7 @@ use Flarum\User\User;
class EditDiscussion
{
public function __construct(
public $discussionId,
public int $discussionId,
public User $actor,
public array $data
) {

4
framework/core/src/Discussion/Command/ReadDiscussion.php
View File

@@ -14,11 +14,11 @@ use Flarum\User\User;
class ReadDiscussion
{
public function __construct(
public $discussionId,
public int $discussionId,
/** The user to mark the discussion as read for */
public User $actor,
/** The number of the post to mark as read */
public $lastReadPostNumber
public int $lastReadPostNumber
) {
}
}

2
framework/core/src/Discussion/Query/AuthorFilterGambit.php
View File

@@ -46,7 +46,7 @@ class AuthorFilterGambit extends AbstractRegexGambit implements FilterInterface
$this->constrain($filterState->getQuery(), $filterValue, $negate);
}
protected function constrain(Builder $query, string|array $rawUsernames, $negate)
protected function constrain(Builder $query, string|array $rawUsernames, bool $negate): void
{
$usernames = $this->asStringArray($rawUsernames);

2
framework/core/src/Discussion/Query/CreatedFilterGambit.php
View File

@@ -45,7 +45,7 @@ class CreatedFilterGambit extends AbstractRegexGambit implements FilterInterface
$this->constrain($filterState->getQuery(), Arr::get($matches, 1), Arr::get($matches, 3), $negate);
}
public function constrain(Builder $query, ?string $firstDate, ?string $secondDate, $negate)
public function constrain(Builder $query, ?string $firstDate, ?string $secondDate, bool $negate): void
{
// If we've just been provided with a single YYYY-MM-DD date, then find
// discussions that were started on that exact date. But if we've been

2
framework/core/src/Discussion/Query/HiddenFilterGambit.php
View File

@@ -37,7 +37,7 @@ class HiddenFilterGambit extends AbstractRegexGambit implements FilterInterface
$this->constrain($filterState->getQuery(), $negate);
}
protected function constrain(Builder $query, bool $negate)
protected function constrain(Builder $query, bool $negate): void
{
$query->where(function ($query) use ($negate) {
if ($negate) {

2
framework/core/src/Discussion/Query/UnreadFilterGambit.php
View File

@@ -52,7 +52,7 @@ class UnreadFilterGambit extends AbstractRegexGambit implements FilterInterface
$this->constrain($filterState->getQuery(), $filterState->getActor(), $negate);
}
protected function constrain(Builder $query, User $actor, bool $negate)
protected function constrain(Builder $query, User $actor, bool $negate): void
{
if ($actor->exists) {
$readIds = $this->discussions->getReadIdsQuery($actor);

2
framework/core/src/Extend/Console.php
View File

@@ -43,7 +43,7 @@ class Console implements ExtenderInterface
* The callback should apply relevant methods to $event, and does not need to return anything.
*
* @see https://laravel.com/api/8.x/Illuminate/Console/Scheduling/Event.html
* @see https://laravel.com/docs/8.x/scheduling#schedule-frequency-options
* @see https://laravel.com/docs/10.x/scheduling#schedule-frequency-options
* for more information on available methods and what they do.
*
* @param array $args An array of args to call the command with.

2
framework/core/src/Extend/Event.php
View File

@@ -44,7 +44,7 @@ class Event implements ExtenderInterface
* Event subscribers are classes that may subscribe to multiple events from within the subscriber class itself,
* allowing you to define several event handlers within a single class.
*
* @see https://laravel.com/docs/8.x/events#writing-event-subscribers
* @see https://laravel.com/docs/10.x/events#writing-event-subscribers
*
* @param string $subscriber: The ::class attribute of the subscriber class.
* @return self

2
framework/core/src/Extend/Filesystem.php
View File

@@ -51,7 +51,7 @@ class Filesystem implements ExtenderInterface
* });
* ```
*
* @see https://laravel.com/docs/8.x/filesystem#configuration
* @see https://laravel.com/docs/10.x/filesystem#configuration
*
* @return self
*/

2
framework/core/src/Extend/LanguagePack.php
View File

@@ -61,7 +61,7 @@ class LanguagePack implements ExtenderInterface, LifecycleInterface
);
}
private function registerLocale(Container $container, LocaleManager $locales, Extension $extension, $locale, $title): void
private function registerLocale(Container $container, LocaleManager $locales, Extension $extension, string $locale, string $title): void
{
$locales->addLocale($locale, $title);

2
framework/core/src/Extend/Model.php
View File

@@ -48,7 +48,7 @@ class Model implements ExtenderInterface
* Add a custom attribute type cast. Should not be applied to non-extension attributes.
*
* @param string $attribute: The new attribute name.
* @param string $cast: The cast type. See https://laravel.com/docs/8.x/eloquent-mutators#attribute-casting
* @param string $cast: The cast type. See https://laravel.com/docs/10.x/eloquent-mutators#attribute-casting
* @return self
*/
public function cast(string $attribute, string $cast): self

2
framework/core/src/Extend/ModelPrivate.php
View File

@@ -34,7 +34,7 @@ use Illuminate\Contracts\Container\Container;
*/
class ModelPrivate implements ExtenderInterface
{
private $checkers = [];
private array $checkers = [];
/**
* @param class-string<AbstractModel> $modelClass: The ::class attribute of the model you are applying private checkers to.

2
framework/core/src/Extend/Routes.php
View File

@@ -148,7 +148,7 @@ class Routes implements ExtenderInterface
return $this->route('DELETE', $path, $name, $handler);
}
private function route(string $httpMethod, string $path, string $name, $handler): self
private function route(string $httpMethod, string $path, string $name, callable|string $handler): self
{
$this->routes[] = [
'method' => $httpMethod,

2
framework/core/src/Extension/Exception/ExtensionBootError.php
View File

@@ -17,7 +17,7 @@ class ExtensionBootError extends Exception
{
public function __construct(
public Extension $extension,
public $extender,
public object $extender,
Throwable $previous = null
) {
$extenderClass = get_class($extender);

15
framework/core/src/Extension/Extension.php
View File

@@ -84,7 +84,7 @@ class Extension implements Arrayable
$this->assignId();
}
protected static function nameToId($name): string
protected static function nameToId(string $name): string
{
[$vendor, $package] = explode('/', $name);
$package = str_replace(['flarum-ext-', 'flarum-'], '', $package);
@@ -114,12 +114,12 @@ class Extension implements Arrayable
}
}
public function __get($name)
public function __get(string $name): mixed
{
return $this->composerJsonAttribute(Str::snake($name, '-'));
}
public function __isset($name)
public function __isset(string $name): bool
{
return isset($this->{$name}) || $this->composerJsonAttribute(Str::snake($name, '-'));
}
@@ -127,12 +127,9 @@ class Extension implements Arrayable
/**
* Dot notation getter for composer.json attributes.
*
* @see https://laravel.com/docs/8.x/helpers#arrays
*
* @param $name
* @return mixed
* @see https://laravel.com/docs/10.x/helpers#arrays
*/
public function composerJsonAttribute($name): mixed
public function composerJsonAttribute(string $name): mixed
{
return Arr::get($this->composerJson, $name);
}
@@ -433,7 +430,7 @@ class Extension implements Arrayable
/**
* @internal
*/
public function migrate(Migrator $migrator, $direction = 'up'): ?int
public function migrate(Migrator $migrator, string $direction = 'up'): ?int
{
if (! $this->hasMigrations()) {
return null;

10
framework/core/src/Filter/ValidateFilterTrait.php
View File

@@ -18,7 +18,7 @@ trait ValidateFilterTrait
* @throws FlarumValidationException
* @return array<string>|array<array>
*/
protected function asStringArray($filterValue, bool $multidimensional = false): array
protected function asStringArray(string|array $filterValue, bool $multidimensional = false): array
{
if (is_array($filterValue)) {
$value = array_map(function ($subValue) use ($multidimensional) {
@@ -40,7 +40,7 @@ trait ValidateFilterTrait
/**
* @throws FlarumValidationException
*/
protected function asString($filterValue): string
protected function asString(string|array $filterValue): string
{
if (is_array($filterValue)) {
$this->throwValidationException('core.api.invalid_filter_type.must_not_be_array_message');
@@ -52,7 +52,7 @@ trait ValidateFilterTrait
/**
* @throws FlarumValidationException
*/
protected function asInt($filterValue): int
protected function asInt(string|array $filterValue): int
{
if (! is_numeric($filterValue)) {
$this->throwValidationException('core.api.invalid_filter_type.must_be_numeric_message');
@@ -65,7 +65,7 @@ trait ValidateFilterTrait
* @throws FlarumValidationException
* @return array<int>
*/
protected function asIntArray($filterValue): array
protected function asIntArray(string|array $filterValue): array
{
return array_map(function ($value) {
return $this->asInt($value);
@@ -75,7 +75,7 @@ trait ValidateFilterTrait
/**
* @throws FlarumValidationException
*/
protected function asBool($filterValue): bool
protected function asBool(string|array $filterValue): bool
{
return $this->asString($filterValue) === '1';
}

2
framework/core/src/Formatter/Formatter.php
View File

@@ -94,7 +94,7 @@ class Formatter
return $renderer->render($xml);
}
public function unparse(string $xml, $context = null): string
public function unparse(string $xml, mixed $context = null): string
{
foreach ($this->unparsingCallbacks as $callback) {
$xml = $callback($context, $xml);

2
framework/core/src/Forum/Auth/Registration.php
View File

@@ -66,7 +66,7 @@ class Registration
return $this->suggest('email', $email);
}
public function setPayload($payload): self
public function setPayload(mixed $payload): self
{
$this->payload = $payload;

2
framework/core/src/Forum/Content/Discussion.php
View File

@@ -92,7 +92,7 @@ class Discussion
*
* @throws RouteNotFoundException
*/
protected function getApiDocument(Request $request, string $id, array $params)
protected function getApiDocument(Request $request, string $id, array $params): object
{
$params['bySlug'] = true;
$response = $this->api

2
framework/core/src/Forum/Content/User.php
View File

@@ -44,7 +44,7 @@ class User
*
* @throws ModelNotFoundException
*/
protected function getApiDocument(Request $request, string $username)
protected function getApiDocument(Request $request, string $username): object
{
$response = $this->api->withParentRequest($request)->withQueryParams(['bySlug' => true])->get("/users/$username");
$statusCode = $response->getStatusCode();

2
framework/core/src/Foundation/AbstractValidator.php
View File

@@ -33,7 +33,7 @@ abstract class AbstractValidator
) {
}
public function addConfiguration($callable): void
public function addConfiguration(callable $callable): void
{
$this->configuration[] = $callable;
}

2
framework/core/src/Foundation/Config.php
View File

@@ -39,7 +39,7 @@ class Config implements ArrayAccess
return $this->data['offline'] ?? false;
}
private function requireKeys(...$keys): void
private function requireKeys(mixed ...$keys): void
{
foreach ($keys as $key) {
if (! array_key_exists($key, $this->data)) {

2
framework/core/src/Foundation/Container.php
View File

@@ -20,7 +20,7 @@ class Container extends LaravelContainer
*
* @TODO: Implement the Application contract and merge the container into it.
*/
public function __call(string $name, array $arguments)
public function __call(string $name, array $arguments): mixed
{
return $this->get('flarum')->$name(...$arguments);
}

8
framework/core/src/Foundation/DispatchEventsTrait.php
View File

@@ -16,8 +16,14 @@ trait DispatchEventsTrait
/**
* Dispatch all events for an entity.
*/
public function dispatchEventsFor($entity, User $actor = null): void
public function dispatchEventsFor(mixed $entity, User $actor = null): void
{
if (! method_exists($entity, 'releaseEvents')) {
throw new \InvalidArgumentException(
'The entity must use the EventGeneratorTrait trait in order to dispatch events.'
);
}
foreach ($entity->releaseEvents() as $event) {
$event->actor = $actor;

2
framework/core/src/Foundation/ErrorHandling/ExceptionHandler/ValidationExceptionHandler.php
View File

@@ -26,7 +26,7 @@ class ValidationExceptionHandler
));
}
private function buildDetails(array $messages, $pointer): array
private function buildDetails(array $messages, string $pointer): array
{
return array_map(function ($path, $detail) use ($pointer) {
return [

5
framework/core/src/Foundation/EventGeneratorTrait.php
View File

@@ -13,10 +13,7 @@ trait EventGeneratorTrait
{
protected array $pendingEvents = [];
/**
* Raise a new event.
*/
public function raise($event): void
public function raise(object $event): void
{
$this->pendingEvents[] = $event;
}

2
framework/core/src/Foundation/InstalledApp.php
View File

@@ -83,7 +83,7 @@ class InstalledApp implements AppInterface
return $this->config->url()->getPath() ?: '/';
}
protected function subPath($pathName): string
protected function subPath(string $pathName): string
{
return '/'.($this->config['paths'][$pathName] ?? $pathName);
}

2
framework/core/src/Foundation/Paths.php
View File

@@ -37,7 +37,7 @@ class Paths
$this->paths['vendor'] = $this->vendor ?? $this->base.'/vendor';
}
public function __get($name): ?string
public function __get(string $name): ?string
{
return $this->paths[$name] ?? null;
}

6
framework/core/src/Foundation/Site.php
View File

@@ -34,12 +34,12 @@ class Site
)->extendWith(static::loadExtenders($paths->base));
}
protected static function hasConfigFile($basePath): bool
protected static function hasConfigFile(string $basePath): bool
{
return file_exists("$basePath/config.php");
}
protected static function loadConfig($basePath): Config
protected static function loadConfig(string $basePath): Config
{
$config = include "$basePath/config.php";
@@ -50,7 +50,7 @@ class Site
return new Config($config);
}
protected static function loadExtenders($basePath): array
protected static function loadExtenders(string $basePath): array
{
$extenderFile = "$basePath/extend.php";

26
framework/core/src/Frontend/Assets.php
View File

@@ -44,35 +44,35 @@ class Assets
) {
}
public function js($sources): static
public function js(callable $callback): static
{
$this->addSources('js', $sources);
$this->addSources('js', $callback);
return $this;
}
public function css($callback): static
public function css(callable $callback): static
{
$this->addSources('css', $callback);
return $this;
}
public function localeJs($callback): static
public function localeJs(callable $callback): static
{
$this->addSources('localeJs', $callback);
return $this;
}
public function localeCss($callback): static
public function localeCss(callable $callback): static
{
$this->addSources('localeCss', $callback);
return $this;
}
private function addSources($type, $callback): void
private function addSources(string $type, callable $callback): void
{
$this->sources[$type][] = $callback;
}
@@ -122,7 +122,7 @@ class Assets
return $compiler;
}
protected function makeJsCompiler(string $filename)
protected function makeJsCompiler(string $filename): JsCompiler
{
return resolve(JsCompiler::class, [
'assetsDir' => $this->assetsDir,
@@ -163,7 +163,7 @@ class Assets
return $this->name;
}
public function setName(string $name)
public function setName(string $name): void
{
$this->name = $name;
}
@@ -173,7 +173,7 @@ class Assets
return $this->assetsDir;
}
public function setAssetsDir(Cloud $assetsDir)
public function setAssetsDir(Cloud $assetsDir): void
{
$this->assetsDir = $assetsDir;
}
@@ -183,7 +183,7 @@ class Assets
return $this->cacheDir;
}
public function setCacheDir(?string $cacheDir)
public function setCacheDir(?string $cacheDir): void
{
$this->cacheDir = $cacheDir;
}
@@ -193,17 +193,17 @@ class Assets
return $this->lessImportDirs;
}
public function setLessImportDirs(array $lessImportDirs)
public function setLessImportDirs(array $lessImportDirs): void
{
$this->lessImportDirs = $lessImportDirs;
}
public function addLessImportOverrides(array $lessImportOverrides)
public function addLessImportOverrides(array $lessImportOverrides): void
{
$this->lessImportOverrides = array_merge($this->lessImportOverrides, $lessImportOverrides);
}
public function addFileSourceOverrides(array $fileSourceOverrides)
public function addFileSourceOverrides(array $fileSourceOverrides): void
{
$this->fileSourceOverrides = array_merge($this->fileSourceOverrides, $fileSourceOverrides);
}

2
framework/core/src/Frontend/Compiler/VersionerInterface.php
View File

@@ -11,7 +11,7 @@ namespace Flarum\Frontend\Compiler;
interface VersionerInterface
{
public function putRevision(string $file, ?string $revision);
public function putRevision(string $file, ?string $revision): void;
public function getRevision(string $file): ?string;
}

4
framework/core/src/Frontend/FrontendServiceProvider.php
View File

@@ -40,8 +40,8 @@ class FrontendServiceProvider extends AbstractServiceProvider
$paths->vendor.'/components/font-awesome/less' => ''
]);
$assets->css([$this, 'addBaseCss']);
$assets->localeCss([$this, 'addBaseCss']);
$assets->css($this->addBaseCss(...));
$assets->localeCss($this->addBaseCss(...));
return $assets;
};

4
framework/core/src/Group/Access/GroupPolicy.php
View File

@@ -14,10 +14,12 @@ use Flarum\User\User;
class GroupPolicy extends AbstractPolicy
{
public function can(User $actor, string $ability)
public function can(User $actor, string $ability): ?string
{
if ($actor->hasPermission('group.'.$ability)) {
return $this->allow();
}
return null;
}
}

4
framework/core/src/Http/Access/AccessTokenPolicy.php
View File

@@ -15,10 +15,12 @@ use Flarum\User\User;
class AccessTokenPolicy extends AbstractPolicy
{
public function revoke(User $actor, AccessToken $token)
public function revoke(User $actor, AccessToken $token): ?string
{
if ($token->user_id === $actor->id || $actor->hasPermission('moderateAccessTokens')) {
return $this->allow();
}
return null;
}
}

2
framework/core/src/Http/Middleware/AuthenticateWithHeader.php
View File

@@ -58,7 +58,7 @@ class AuthenticateWithHeader implements Middleware
return $handler->handle($request);
}
private function getUser($string): ?User
private function getUser(string $string): ?User
{
$parts = explode('=', trim($string));

14
framework/core/src/Http/RouteCollection.php
View File

@@ -30,32 +30,32 @@ class RouteCollection
$this->routeParser = new RouteParser\Std;
}
public function get($path, $name, $handler): self
public function get(string $path, string $name, callable|string $handler): self
{
return $this->addRoute('GET', $path, $name, $handler);
}
public function post($path, $name, $handler): self
public function post(string $path, string $name, callable|string $handler): self
{
return $this->addRoute('POST', $path, $name, $handler);
}
public function put($path, $name, $handler): self
public function put(string $path, string $name, callable|string $handler): self
{
return $this->addRoute('PUT', $path, $name, $handler);
}
public function patch($path, $name, $handler): self
public function patch(string $path, string $name, callable|string $handler): self
{
return $this->addRoute('PATCH', $path, $name, $handler);
}
public function delete($path, $name, $handler): self
public function delete(string $path, string $name, callable|string $handler): self
{
return $this->addRoute('DELETE', $path, $name, $handler);
}
public function addRoute($method, $path, $name, $handler): self
public function addRoute(string $method, string $path, string $name, callable|string $handler): self
{
if (isset($this->routes[$name])) {
throw new \RuntimeException("Route $name already exists");
@@ -102,7 +102,7 @@ class RouteCollection
return $this->dataGenerator->getData();
}
protected function fixPathPart(mixed $part, array $parameters, string $routeName)
protected function fixPathPart(mixed $part, array $parameters, string $routeName): string
{
if (! is_array($part)) {
return $part;

4
framework/core/src/Http/RouteHandlerFactory.php
View File

@@ -26,7 +26,7 @@ class RouteHandlerFactory
) {
}
public function toController($controller): Closure
public function toController(callable|string $controller): Closure
{
return function (Request $request, array $routeParams) use ($controller) {
$controller = $this->resolveController($controller);
@@ -60,7 +60,7 @@ class RouteHandlerFactory
return $this->toFrontend('admin', $content);
}
private function resolveController($controller): Handler
private function resolveController(callable|string $controller): Handler
{
if (is_callable($controller)) {
$controller = $this->container->call($controller);

2
framework/core/src/Http/Server.php
View File

@@ -52,7 +52,7 @@ class Server
*
* @throws Throwable
*/
private function safelyBootAndGetHandler()
private function safelyBootAndGetHandler() // @phpstan-ignore-line
{
try {
return $this->site->bootApp()->getRequestHandler();

2
framework/core/src/Install/Console/InstallCommand.php
View File

@@ -103,7 +103,7 @@ class InstallCommand extends AbstractCommand
->run();
}
protected function showProblems($problems): void
protected function showProblems(iterable $problems): void
{
$this->output->writeln(
'<error>Please fix the following problems before we can continue with the installation.</error>'

8
framework/core/src/Install/Console/UserDataProvider.php
View File

@@ -76,7 +76,7 @@ class UserDataProvider implements DataProviderInterface
);
}
private function askForAdminPassword()
private function askForAdminPassword(): string
{
while (true) {
$password = $this->secret('Admin password (required >= 8 characters):');
@@ -108,14 +108,14 @@ class UserDataProvider implements DataProviderInterface
];
}
private function ask($question, $default = null): mixed
private function ask(string $question, string $default = null): mixed
{
$question = new Question("<question>$question</question> ", $default);
return $this->questionHelper->ask($this->input, $this->output, $question);
}
private function secret($question): mixed
private function secret(string $question): mixed
{
$question = new Question("<question>$question</question> ");
@@ -124,7 +124,7 @@ class UserDataProvider implements DataProviderInterface
return $this->questionHelper->ask($this->input, $this->output, $question);
}
private function validationError($message): void
private function validationError(string $message): void
{
$this->output->writeln("<error>$message</error>");
$this->output->writeln('Please try again.');

4
framework/core/src/Install/Pipeline.php
View File

@@ -33,7 +33,7 @@ class Pipeline
return $this;
}
public function on($event, callable $callback): self
public function on(string $event, callable $callback): self
{
$this->callbacks[$event] = $callback;
@@ -88,7 +88,7 @@ class Pipeline
}
}
private function fireCallbacks($event, Step $step): void
private function fireCallbacks(string $event, Step $step): void
{
if (isset($this->callbacks[$event])) {
($this->callbacks[$event])($step);

2
framework/core/src/Install/Prerequisite/WritablePaths.php
View File

@@ -54,7 +54,7 @@ class WritablePaths implements PrerequisiteInterface
});
}
private function getAbsolutePath($path)
private function getAbsolutePath(string $path): string
{
$path = str_replace(['/', '\\'], DIRECTORY_SEPARATOR, $path);
$parts = array_filter(explode(DIRECTORY_SEPARATOR, $path), 'strlen');

2
framework/core/src/Locale/LocaleManager.php
View File

@@ -49,7 +49,7 @@ class LocaleManager
return isset($this->locales[$locale]);
}
public function addTranslations(string $locale, $file, string $module = null): void
public function addTranslations(string $locale, string $file, string $module = null): void
{
$prefix = $module ? $module.'::' : '';

2
framework/core/src/Locale/PrefixedYamlFileLoader.php
View File

@@ -14,7 +14,7 @@ use Symfony\Component\Translation\MessageCatalogue;
class PrefixedYamlFileLoader extends YamlFileLoader
{
public function load(mixed $resource, $locale, $domain = 'messages'): MessageCatalogue
public function load(mixed $resource, string $locale, string $domain = 'messages'): MessageCatalogue
{
$catalogue = parent::load($resource['file'], $locale, $domain);

12
framework/core/src/Post/Access/PostPolicy.php
View File

@@ -22,14 +22,16 @@ class PostPolicy extends AbstractPolicy
) {
}
public function can(User $actor, string $ability, Post $post)
public function can(User $actor, string $ability, Post $post): ?string
{
if ($actor->can($ability.'Posts', $post->discussion)) {
return $this->allow();
}
return null;
}
public function edit(User $actor, Post $post)
public function edit(User $actor, Post $post): ?string
{
// A post is allowed to be edited if the user is the author, the post
// hasn't been deleted by someone else, and the user is allowed to
@@ -43,9 +45,11 @@ class PostPolicy extends AbstractPolicy
return $this->allow();
}
}
return null;
}
public function hide(User $actor, Post $post)
public function hide(User $actor, Post $post): ?string
{
if ($post->user_id == $actor->id && (! $post->hidden_at || $post->hidden_user_id == $actor->id) && $actor->can('reply', $post->discussion)) {
$allowHiding = $this->settings->get('allow_hide_own_posts');
@@ -56,5 +60,7 @@ class PostPolicy extends AbstractPolicy
return $this->allow();
}
}
return null;
}
}

18
framework/core/src/Queue/QueueServiceProvider.php
View File

@@ -16,6 +16,7 @@ use Flarum\Foundation\ErrorHandling\Reporter;
use Flarum\Foundation\Paths;
use Illuminate\Container\Container as ContainerImplementation;
use Illuminate\Contracts\Cache\Factory as CacheFactory;
use Illuminate\Contracts\Cache\Repository;
use Illuminate\Contracts\Container\Container;
use Illuminate\Contracts\Debug\ExceptionHandler as ExceptionHandling;
use Illuminate\Contracts\Events\Dispatcher;
@@ -91,29 +92,24 @@ class QueueServiceProvider extends AbstractServiceProvider
// Bind a simple cache manager that returns the cache store.
$this->container->singleton('cache', function (Container $container) {
return new class($container) implements CacheFactory {
/**
* @var Container
*/
private $container;
public function __construct(Container $container)
{
$this->container = $container;
public function __construct(
private readonly Container $container
) {
}
public function driver()
public function driver(): Repository
{
return $this->container['cache.store'];
}
// We have to define this explicitly
// so that we implement the interface.
public function store($name = null)
public function store($name = null): mixed
{
return $this->__call($name, null);
}
public function __call($name, $arguments)
public function __call(string $name, ?array $arguments): mixed
{
return call_user_func_array([$this->driver(), $name], $arguments);
}

2
framework/core/src/Settings/DatabaseSettingsRepository.php
View File

@@ -23,7 +23,7 @@ class DatabaseSettingsRepository implements SettingsRepositoryInterface
return $this->database->table('settings')->pluck('value', 'key')->all();
}
public function get(string $key, $default = null): mixed
public function get(string $key, mixed $default = null): mixed
{
if (is_null($value = $this->database->table('settings')->where('key', $key)->value('value'))) {
return $default;

2
framework/core/src/Settings/DefaultSettingsRepository.php
View File

@@ -19,7 +19,7 @@ class DefaultSettingsRepository implements SettingsRepositoryInterface
) {
}
public function get(string $key, $default = null): mixed
public function get(string $key, mixed $default = null): mixed
{
// Global default overrules local default because local default is deprecated,
// and will be removed in 2.0

2
framework/core/src/Settings/MemoryCacheSettingsRepository.php
View File

@@ -31,7 +31,7 @@ class MemoryCacheSettingsRepository implements SettingsRepositoryInterface
return $this->cache;
}
public function get(string $key, $default = null): mixed
public function get(string $key, mixed $default = null): mixed
{
if (array_key_exists($key, $this->cache)) {
return $this->cache[$key];

2
framework/core/src/Settings/OverrideSettingsRepository.php
View File

@@ -36,7 +36,7 @@ class OverrideSettingsRepository implements SettingsRepositoryInterface
return array_merge($this->inner->all(), $this->overrides);
}
public function get(string $key, $default = null): mixed
public function get(string $key, mixed $default = null): mixed
{
if (array_key_exists($key, $this->overrides)) {
return $this->overrides[$key];

2
framework/core/src/Settings/SettingsRepositoryInterface.php
View File

@@ -16,7 +16,7 @@ interface SettingsRepositoryInterface
/**
* @todo remove deprecated $default in 2.0
*/
public function get(string $key, $default = null): mixed;
public function get(string $key, mixed $default = null): mixed;
public function set(string $key, mixed $value): void;

2
framework/core/src/Settings/UninstalledSettingsRepository.php
View File

@@ -16,7 +16,7 @@ class UninstalledSettingsRepository implements SettingsRepositoryInterface
return [];
}
public function get(string $key, $default = null): mixed
public function get(string $key, mixed $default = null): mixed
{
return $default;
}

5
framework/core/src/User/Access/AbstractPolicy.php
View File

@@ -9,6 +9,7 @@
namespace Flarum\User\Access;
use Flarum\Database\AbstractModel;
use Flarum\User\User;
abstract class AbstractPolicy
@@ -39,7 +40,7 @@ abstract class AbstractPolicy
return static::FORCE_DENY;
}
public function checkAbility(User $actor, string $ability, $instance)
public function checkAbility(User $actor, string $ability, string|AbstractModel|null $instance): ?string
{
// If a specific method for this ability is defined,
// call that and return any non-null results
@@ -55,6 +56,8 @@ abstract class AbstractPolicy
if (method_exists($this, 'can')) {
return $this->sanitizeResult(call_user_func_array([$this, 'can'], [$actor, $ability, $instance]));
}
return null;
}
/**

1
framework/core/src/User/Access/Gate.php
View File

@@ -46,6 +46,7 @@ class Gate
public function allows(User $actor, string $ability, string|AbstractModel|null $model): bool
{
$results = [];
/** @var AbstractPolicy[] $appliedPolicies */
$appliedPolicies = [];
if ($model) {

8
framework/core/src/User/Access/UserPolicy.php
View File

@@ -13,14 +13,16 @@ use Flarum\User\User;
class UserPolicy extends AbstractPolicy
{
public function can(User $actor, string $ability)
public function can(User $actor, string $ability): ?string
{
if ($actor->hasPermission('user.'.$ability)) {
return $this->allow();
}
return null;
}
public function editCredentials(User $actor, User $user)
public function editCredentials(User $actor, User $user): ?string
{
if ($user->isAdmin() && ! $actor->isAdmin()) {
return $this->deny();
@@ -29,5 +31,7 @@ class UserPolicy extends AbstractPolicy
if ($actor->hasPermission('user.editCredentials')) {
return $this->allow();
}
return null;
}
}

2
framework/core/src/User/AvatarValidator.php
View File

@@ -91,7 +91,7 @@ class AvatarValidator extends AbstractValidator
}
}
protected function raise($error, array $parameters = [], $rule = null): void
protected function raise(string $error, array $parameters = [], string $rule = null): void
{
// When we switched to intl ICU message format, the translation parameters
// have become required to be in the format `{param}`.

2
framework/core/src/User/Command/RegisterUserHandler.php
View File

@@ -96,7 +96,7 @@ class RegisterUserHandler
return $user;
}
private function applyToken(User $user, RegistrationToken $token)
private function applyToken(User $user, RegistrationToken $token): void
{
foreach ($token->user_attributes as $k => $v) {
if ($k === 'avatar_url') {

2
framework/core/src/User/Query/EmailFilterGambit.php
View File

@@ -53,7 +53,7 @@ class EmailFilterGambit extends AbstractRegexGambit implements FilterInterface
$this->constrain($filterState->getQuery(), $filterValue, $negate);
}
protected function constrain(Builder $query, $rawEmail, bool $negate): void
protected function constrain(Builder $query, string|array $rawEmail, bool $negate): void
{
$email = $this->asString($rawEmail);

2
framework/core/src/User/Query/GroupFilterGambit.php
View File

@@ -42,7 +42,7 @@ class GroupFilterGambit extends AbstractRegexGambit implements FilterInterface
$this->constrain($filterState->getQuery(), $filterState->getActor(), $filterValue, $negate);
}
protected function constrain(Builder $query, User $actor, $rawQuery, bool $negate): void
protected function constrain(Builder $query, User $actor, string|array $rawQuery, bool $negate): void
{
$groupIdentifiers = $this->asStringArray($rawQuery);
$groupQuery = Group::whereVisibleTo($actor);

2
framework/core/src/helpers.php
View File

@@ -114,7 +114,7 @@ if (! function_exists('config')) {
/**
* @deprecated do not use, will be transferred to flarum/laravel-helpers.
*/
function config(string $key, $default = null)
function config(string $key, mixed $default = null): mixed
{
return resolve(Repository::class)->get($key, $default);
}