github-mirror/framework
2
0
Fork 0
mirror of https://github.com/flarum/framework.git synced 2025-01-19 16:02:44 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Rework public API based on events

Browse Source
This commit is contained in:
Toby Zerner 2015-07-18 22:59:47 +09:30
parent 178474adf9
commit 77d0bfccd7
136 changed files with 1157 additions and 1245 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
framework/core/src/Api/Actions/Activity/IndexAction.php
View File

@ -21,12 +21,12 @@ class IndexAction extends SerializeCollectionAction
/**
* @inheritdoc
*/
public static $serializer = 'Flarum\Api\Serializers\ActivitySerializer';
public $serializer = 'Flarum\Api\Serializers\ActivitySerializer';
/**
* @inheritdoc
*/
public static $include = [
public $include = [
'subject' => true,
'subject.user' => true,
'subject.discussion' => true
@ -35,27 +35,27 @@ class IndexAction extends SerializeCollectionAction
/**
* @inheritdoc
*/
public static $link = ['user'];
public $link = ['user'];
/**
* @inheritdoc
*/
public static $limitMax = 50;
public $limitMax = 50;
/**
* @inheritdoc
*/
public static $limit = 20;
public $limit = 20;
/**
* @inheritdoc
*/
public static $sortFields = [];
public $sortFields = [];
/**
* @inheritdoc
*/
public static $sort;
public $sort;
/**
* @param UserRepository $users

14
framework/core/src/Api/Actions/Discussions/CreateAction.php
View File

@ -18,12 +18,12 @@ class CreateAction extends BaseCreateAction
/**
* @inheritdoc
*/
public static $serializer = 'Flarum\Api\Serializers\DiscussionSerializer';
public $serializer = 'Flarum\Api\Serializers\DiscussionSerializer';
/**
* @inheritdoc
*/
public static $include = [
public $include = [
'posts' => true,
'startUser' => true,
'lastUser' => true,
@ -34,27 +34,27 @@ class CreateAction extends BaseCreateAction
/**
* @inheritdoc
*/
public static $link = [];
public $link = [];
/**
* @inheritdoc
*/
public static $limitMax = 50;
public $limitMax = 50;
/**
* @inheritdoc
*/
public static $limit = 20;
public $limit = 20;
/**
* @inheritdoc
*/
public static $sortFields = [];
public $sortFields = [];
/**
* @inheritdoc
*/
public static $sort;
public $sort;
/**
* Instantiate the action.

16
framework/core/src/Api/Actions/Discussions/IndexAction.php
View File

@ -22,12 +22,12 @@ class IndexAction extends SerializeCollectionAction
/**
* @inheritdoc
*/
public static $serializer = 'Flarum\Api\Serializers\DiscussionSerializer';
public $serializer = 'Flarum\Api\Serializers\DiscussionSerializer';
/**
* @inheritdoc
*/
public static $include = [
public $include = [
'startUser' => true,
'lastUser' => true,
'startPost' => false,
@ -40,27 +40,27 @@ class IndexAction extends SerializeCollectionAction
/**
* @inheritdoc
*/
public static $link = [];
public $link = [];
/**
* @inheritdoc
*/
public static $limitMax = 50;
public $limitMax = 50;
/**
* @inheritdoc
*/
public static $limit = 20;
public $limit = 20;
/**
* @inheritdoc
*/
public static $sortFields = ['lastTime', 'commentsCount', 'startTime'];
public $sortFields = ['lastTime', 'commentsCount', 'startTime'];
/**
* @inheritdoc
*/
public static $sort;
public $sort;
/**
* @param DiscussionSearcher $searcher
@ -93,7 +93,7 @@ class IndexAction extends SerializeCollectionAction
$results = $this->searcher->search($criteria, $request->limit, $request->offset, $load);
// TODO: add query params (filter, sort, include) to the pagination URLs
static::addPaginationLinks(
$this->addPaginationLinks(
$document,
$request,
$request->http ? $this->url->toRoute('flarum.api.discussions.index') : '',

14
framework/core/src/Api/Actions/Discussions/ShowAction.php
View File

@ -19,12 +19,12 @@ class ShowAction extends SerializeResourceAction
/**
* @inheritdoc
*/
public static $serializer = 'Flarum\Api\Serializers\DiscussionSerializer';
public $serializer = 'Flarum\Api\Serializers\DiscussionSerializer';
/**
* @inheritdoc
*/
public static $include = [
public $include = [
'startUser' => false,
'lastUser' => false,
'startPost' => false,
@ -39,27 +39,27 @@ class ShowAction extends SerializeResourceAction
/**
* @inheritdoc
*/
public static $link = ['posts', 'posts.discussion'];
public $link = ['posts', 'posts.discussion'];
/**
* @inheritdoc
*/
public static $limitMax = 50;
public $limitMax = 50;
/**
* @inheritdoc
*/
public static $limit = 20;
public $limit = 20;
/**
* @inheritdoc
*/
public static $sortFields = ['time'];
public $sortFields = ['time'];
/**
* @inheritdoc
*/
public static $sort = ['time' => 'asc'];
public $sort = ['time' => 'asc'];
/**
* Instantiate the action.

14
framework/core/src/Api/Actions/Discussions/UpdateAction.php
View File

@ -17,37 +17,37 @@ class UpdateAction extends SerializeResourceAction
/**
* @inheritdoc
*/
public static $serializer = 'Flarum\Api\Serializers\DiscussionSerializer';
public $serializer = 'Flarum\Api\Serializers\DiscussionSerializer';
/**
* @inheritdoc
*/
public static $include = [];
public $include = [];
/**
* @inheritdoc
*/
public static $link = [];
public $link = [];
/**
* @inheritdoc
*/
public static $limitMax = 50;
public $limitMax = 50;
/**
* @inheritdoc
*/
public static $limit = 20;
public $limit = 20;
/**
* @inheritdoc
*/
public static $sortFields = [];
public $sortFields = [];
/**
* @inheritdoc
*/
public static $sort;
public $sort;
/**
* @param Dispatcher $bus

14
framework/core/src/Api/Actions/Forum/ShowAction.php
View File

@ -9,37 +9,37 @@ class ShowAction extends SerializeResourceAction
/**
* @inheritdoc
*/
public static $serializer = 'Flarum\Api\Serializers\ForumSerializer';
public $serializer = 'Flarum\Api\Serializers\ForumSerializer';
/**
* @inheritdoc
*/
public static $include = [];
public $include = [];
/**
* @inheritdoc
*/
public static $link = [];
public $link = [];
/**
* @inheritdoc
*/
public static $limitMax = 50;
public $limitMax = 50;
/**
* @inheritdoc
*/
public static $limit = 20;
public $limit = 20;
/**
* @inheritdoc
*/
public static $sortFields = [];
public $sortFields = [];
/**
* @inheritdoc
*/
public static $sort;
public $sort;
/**
* Get the forum, ready to be serialized and assigned to the JsonApi

14
framework/core/src/Api/Actions/Groups/IndexAction.php
View File

@ -10,37 +10,37 @@ class IndexAction extends SerializeCollectionAction
/**
* @inheritdoc
*/
public static $serializer = 'Flarum\Api\Serializers\GroupSerializer';
public $serializer = 'Flarum\Api\Serializers\GroupSerializer';
/**
* @inheritdoc
*/
public static $include = [];
public $include = [];
/**
* @inheritdoc
*/
public static $link = [];
public $link = [];
/**
* @inheritdoc
*/
public static $limitMax = 50;
public $limitMax = 50;
/**
* @inheritdoc
*/
public static $limit = 20;
public $limit = 20;
/**
* @inheritdoc
*/
public static $sortFields = [];
public $sortFields = [];
/**
* @inheritdoc
*/
public static $sort;
public $sort;
/**
* Get the groups, ready to be serialized and assigned to the document

14
framework/core/src/Api/Actions/Notifications/IndexAction.php
View File

@ -16,12 +16,12 @@ class IndexAction extends SerializeCollectionAction
/**
* @inheritdoc
*/
public static $serializer = 'Flarum\Api\Serializers\NotificationSerializer';
public $serializer = 'Flarum\Api\Serializers\NotificationSerializer';
/**
* @inheritdoc
*/
public static $include = [
public $include = [
'sender' => true,
'subject' => true,
'subject.discussion' => true
@ -30,27 +30,27 @@ class IndexAction extends SerializeCollectionAction
/**
* @inheritdoc
*/
public static $link = [];
public $link = [];
/**
* @inheritdoc
*/
public static $limitMax = 50;
public $limitMax = 50;
/**
* @inheritdoc
*/
public static $limit = 10;
public $limit = 10;
/**
* @inheritdoc
*/
public static $sortFields = [];
public $sortFields = [];
/**
* @inheritdoc
*/
public static $sort;
public $sort;
/**
* Instantiate the action.

14
framework/core/src/Api/Actions/Notifications/UpdateAction.php
View File

@ -16,37 +16,37 @@ class UpdateAction extends SerializeResourceAction
/**
* @inheritdoc
*/
public static $serializer = 'Flarum\Api\Serializers\NotificationSerializer';
public $serializer = 'Flarum\Api\Serializers\NotificationSerializer';
/**
* @inheritdoc
*/
public static $include = [];
public $include = [];
/**
* @inheritdoc
*/
public static $link = [];
public $link = [];
/**
* @inheritdoc
*/
public static $limitMax = 50;
public $limitMax = 50;
/**
* @inheritdoc
*/
public static $limit = 20;
public $limit = 20;
/**
* @inheritdoc
*/
public static $sortFields = [];
public $sortFields = [];
/**
* @inheritdoc
*/
public static $sort;
public $sort;
/**
* @param Dispatcher $bus

14
framework/core/src/Api/Actions/Posts/CreateAction.php
View File

@ -16,12 +16,12 @@ class CreateAction extends BaseCreateAction
/**
* @inheritdoc
*/
public static $serializer = 'Flarum\Api\Serializers\PostSerializer';
public $serializer = 'Flarum\Api\Serializers\PostSerializer';
/**
* @inheritdoc
*/
public static $include = [
public $include = [
'user' => true,
'discussion' => true
];
@ -29,27 +29,27 @@ class CreateAction extends BaseCreateAction
/**
* @inheritdoc
*/
public static $link = ['discussion.posts'];
public $link = ['discussion.posts'];
/**
* @inheritdoc
*/
public static $limitMax = 50;
public $limitMax = 50;
/**
* @inheritdoc
*/
public static $limit = 20;
public $limit = 20;
/**
* @inheritdoc
*/
public static $sortFields = [];
public $sortFields = [];
/**
* @inheritdoc
*/
public static $sort;
public $sort;
/**
* Instantiate the action.

14
framework/core/src/Api/Actions/Posts/IndexAction.php
View File

@ -12,12 +12,12 @@ class IndexAction extends SerializeCollectionAction
/**
* @inheritdoc
*/
public static $serializer = 'Flarum\Api\Serializers\PostSerializer';
public $serializer = 'Flarum\Api\Serializers\PostSerializer';
/**
* @inheritdoc
*/
public static $include = [
public $include = [
'user' => true,
'user.groups' => true,
'editUser' => true,
@ -28,27 +28,27 @@ class IndexAction extends SerializeCollectionAction
/**
* @inheritdoc
*/
public static $link = [];
public $link = [];
/**
* @inheritdoc
*/
public static $limitMax = 50;
public $limitMax = 50;
/**
* @inheritdoc
*/
public static $limit = 20;
public $limit = 20;
/**
* @inheritdoc
*/
public static $sortFields = [];
public $sortFields = [];
/**
* @inheritdoc
*/
public static $sort;
public $sort;
/**
* @param PostRepository $posts

14
framework/core/src/Api/Actions/Posts/ShowAction.php
View File

@ -16,12 +16,12 @@ class ShowAction extends SerializeResourceAction
/**
* @inheritdoc
*/
public static $serializer = 'Flarum\Api\Serializers\PostSerializer';
public $serializer = 'Flarum\Api\Serializers\PostSerializer';
/**
* @inheritdoc
*/
public static $include = [
public $include = [
'user' => true,
'user.groups' => true,
'editUser' => true,
@ -32,27 +32,27 @@ class ShowAction extends SerializeResourceAction
/**
* @inheritdoc
*/
public static $link = [];
public $link = [];
/**
* @inheritdoc
*/
public static $limitMax = 50;
public $limitMax = 50;
/**
* @inheritdoc
*/
public static $limit = 20;
public $limit = 20;
/**
* @inheritdoc
*/
public static $sortFields = [];
public $sortFields = [];
/**
* @inheritdoc
*/
public static $sort;
public $sort;
/**
* @param PostRepository $posts

14
framework/core/src/Api/Actions/Posts/UpdateAction.php
View File

@ -16,37 +16,37 @@ class UpdateAction extends SerializeResourceAction
/**
* @inheritdoc
*/
public static $serializer = 'Flarum\Api\Serializers\PostSerializer';
public $serializer = 'Flarum\Api\Serializers\PostSerializer';
/**
* @inheritdoc
*/
public static $include = [];
public $include = [];
/**
* @inheritdoc
*/
public static $link = [];
public $link = [];
/**
* @inheritdoc
*/
public static $limitMax = 50;
public $limitMax = 50;
/**
* @inheritdoc
*/
public static $limit = 20;
public $limit = 20;
/**
* @inheritdoc
*/
public static $sortFields = [];
public $sortFields = [];
/**
* @inheritdoc
*/
public static $sort;
public $sort;
/**
* @param Dispatcher $bus

49
framework/core/src/Api/Actions/SerializeAction.php
View File

@ -1,6 +1,7 @@
<?php namespace Flarum\Api\Actions;
use Flarum\Api\Events\WillSerializeData;
use Flarum\Events\BuildApiAction;
use Flarum\Events\WillSerializeData;
use Flarum\Api\Request;
use Flarum\Api\JsonApiRequest;
use Tobscure\JsonApi\Criteria;
@ -15,7 +16,7 @@ abstract class SerializeAction extends JsonApiAction
*
* @var string
*/
public static $serializer;
public $serializer;
/**
* The relationships that are available to be included (keys), and which
@ -23,42 +24,42 @@ abstract class SerializeAction extends JsonApiAction
*
* @var array
*/
public static $include = [];
public $include = [];
/**
* The relationships that are linked by default.
*
* @var array
*/
public static $link = [];
public $link = [];
/**
* The maximum number of records that can be requested.
*
* @var integer
*/
public static $limitMax = 50;
public $limitMax = 50;
/**
* The number of records included by default.
*
* @var integer
*/
public static $limit = 20;
public $limit = 20;
/**
* The fields that are available to be sorted by.
*
* @var array
*/
public static $sortFields = [];
public $sortFields = [];
/**
* The default sort field and order to user.
*
* @var string
*/
public static $sort;
public $sort;
/**
* Handle an API request and return an API response.
@ -68,14 +69,14 @@ abstract class SerializeAction extends JsonApiAction
*/
public function respond(Request $request)
{
$request = static::buildJsonApiRequest($request);
$request = $this->buildJsonApiRequest($request);
$document = new Document();
$data = $this->data($request, $document);
event(new WillSerializeData($this, $data, $request));
$serializer = new static::$serializer($request->actor, $request->include, $request->link);
$serializer = new $this->serializer($request->actor, $request->include, $request->link);
$document->setData($this->serialize($serializer, $data));
@ -107,17 +108,19 @@ abstract class SerializeAction extends JsonApiAction
* @param Request $request
* @return JsonApiRequest
*/
protected static function buildJsonApiRequest(Request $request)
protected function buildJsonApiRequest(Request $request)
{
$request = new JsonApiRequest($request->input, $request->actor, $request->http);
$criteria = new Criteria($request->input);
$request->include = static::sanitizeInclude($criteria->getInclude());
$request->sort = static::sanitizeSort($criteria->getSort());
event(new BuildApiAction($this));
$request->include = $this->sanitizeInclude($criteria->getInclude());
$request->sort = $this->sanitizeSort($criteria->getSort());
$request->offset = $criteria->getOffset();
$request->limit = static::sanitizeLimit($criteria->getLimit());
$request->link = static::$link;
$request->limit = $this->sanitizeLimit($criteria->getLimit());
$request->link = $this->link;
return $request;
}
@ -129,9 +132,9 @@ abstract class SerializeAction extends JsonApiAction
* @param array $include
* @return array
*/
protected static function sanitizeInclude(array $include)
protected function sanitizeInclude(array $include)
{
return array_intersect($include, array_keys(static::$include)) ?: array_keys(array_filter(static::$include));
return array_intersect($include, array_keys($this->include)) ?: array_keys(array_filter($this->include));
}
/**
@ -141,9 +144,9 @@ abstract class SerializeAction extends JsonApiAction
* @param array $sort
* @return array
*/
protected static function sanitizeSort(array $sort)
protected function sanitizeSort(array $sort)
{
return array_intersect_key($sort, array_flip(static::$sortFields)) ?: static::$sort;
return array_intersect_key($sort, array_flip($this->sortFields)) ?: $this->sort;
}
/**
@ -152,9 +155,9 @@ abstract class SerializeAction extends JsonApiAction
* @param int $limit
* @return int
*/
protected static function sanitizeLimit($limit)
protected function sanitizeLimit($limit)
{
return min($limit, static::$limitMax) ?: static::$limit;
return min($limit, $this->limitMax) ?: $this->limit;
}
/**
@ -169,10 +172,10 @@ abstract class SerializeAction extends JsonApiAction
* is unknown ('last' link is ommitted).
* @return void
*/
protected static function addPaginationLinks(Document $document, JsonApiRequest $request, $url, $total = true)
protected function addPaginationLinks(Document $document, JsonApiRequest $request, $url, $total = true)
{
$input = [];
if ($request->limit != static::$limit) {
if ($request->limit != $this->limit) {
array_set($input, 'page.limit', $request->limit);
}

2
framework/core/src/Api/Actions/TokenAction.php
View File

@ -4,7 +4,7 @@ use Flarum\Api\Commands\GenerateAccessToken;
use Flarum\Api\Request;
use Flarum\Core\Users\UserRepository;
use Flarum\Core\Exceptions\PermissionDeniedException;
use Flarum\Core\Users\Events\UserEmailChangeWasRequested;
use Flarum\Events\UserEmailChangeWasRequested;
use Illuminate\Contracts\Bus\Dispatcher;
use Zend\Diactoros\Response\JsonResponse;

14
framework/core/src/Api/Actions/Users/CreateAction.php
View File

@ -15,37 +15,37 @@ class CreateAction extends BaseCreateAction
/**
* @inheritdoc
*/
public static $serializer = 'Flarum\Api\Serializers\UserSerializer';
public $serializer = 'Flarum\Api\Serializers\UserSerializer';
/**
* @inheritdoc
*/
public static $include = [];
public $include = [];
/**
* @inheritdoc
*/
public static $link = [];
public $link = [];
/**
* @inheritdoc
*/
public static $limitMax = 50;
public $limitMax = 50;
/**
* @inheritdoc
*/
public static $limit = 20;
public $limit = 20;
/**
* @inheritdoc
*/
public static $sortFields = [];
public $sortFields = [];
/**
* @inheritdoc
*/
public static $sort;
public $sort;
/**
* @param Dispatcher $bus

2
framework/core/src/Api/Actions/Users/DeleteAvatarAction.php
View File

@ -16,7 +16,7 @@ class DeleteAvatarAction extends SerializeResourceAction
/**
* @inheritdoc
*/
public static $serializer = 'Flarum\Api\Serializers\UserSerializer';
public $serializer = 'Flarum\Api\Serializers\UserSerializer';
/**
* @param Dispatcher $bus

16
framework/core/src/Api/Actions/Users/IndexAction.php
View File

@ -22,39 +22,39 @@ class IndexAction extends SerializeCollectionAction
/**
* @inheritdoc
*/
public static $serializer = 'Flarum\Api\Serializers\UserSerializer';
public $serializer = 'Flarum\Api\Serializers\UserSerializer';
/**
* @inheritdoc
*/
public static $include = [
public $include = [
'groups' => true
];
/**
* @inheritdoc
*/
public static $link = [];
public $link = [];
/**
* @inheritdoc
*/
public static $limitMax = 50;
public $limitMax = 50;
/**
* @inheritdoc
*/
public static $limit = 20;
public $limit = 20;
/**
* @inheritdoc
*/
public static $sortFields = ['username', 'postsCount', 'discussionsCount', 'lastSeenTime', 'joinTime'];
public $sortFields = ['username', 'postsCount', 'discussionsCount', 'lastSeenTime', 'joinTime'];
/**
* @inheritdoc
*/
public static $sort;
public $sort;
/**
* @param UserSearcher $searcher
@ -84,7 +84,7 @@ class IndexAction extends SerializeCollectionAction
$results = $this->searcher->search($criteria, $request->limit, $request->offset, $request->include);
static::addPaginationLinks(
$this->addPaginationLinks(
$document,
$request,
$this->url->toRoute('flarum.api.users.index'),

14
framework/core/src/Api/Actions/Users/ShowAction.php
View File

@ -15,39 +15,39 @@ class ShowAction extends SerializeResourceAction
/**
* @inheritdoc
*/
public static $serializer = 'Flarum\Api\Serializers\CurrentUserSerializer';
public $serializer = 'Flarum\Api\Serializers\CurrentUserSerializer';
/**
* @inheritdoc
*/
public static $include = [
public $include = [
'groups' => true
];
/**
* @inheritdoc
*/
public static $link = [];
public $link = [];
/**
* @inheritdoc
*/
public static $limitMax = 50;
public $limitMax = 50;
/**
* @inheritdoc
*/
public static $limit = 20;
public $limit = 20;
/**
* @inheritdoc
*/
public static $sortFields = [];
public $sortFields = [];
/**
* @inheritdoc
*/
public static $sort;
public $sort;
/**
* @param UserRepository $users

14
framework/core/src/Api/Actions/Users/UpdateAction.php
View File

@ -16,37 +16,37 @@ class UpdateAction extends SerializeResourceAction
/**
* @inheritdoc
*/
public static $serializer = 'Flarum\Api\Serializers\CurrentUserSerializer';
public $serializer = 'Flarum\Api\Serializers\CurrentUserSerializer';
/**
* @inheritdoc
*/
public static $include = [];
public $include = [];
/**
* @inheritdoc
*/
public static $link = [];
public $link = [];
/**
* @inheritdoc
*/
public static $limitMax = 50;
public $limitMax = 50;
/**
* @inheritdoc
*/
public static $limit = 20;
public $limit = 20;
/**
* @inheritdoc
*/
public static $sortFields = [];
public $sortFields = [];
/**
* @inheritdoc
*/
public static $sort;
public $sort;
/**
* @param Dispatcher $bus

14
framework/core/src/Api/Actions/Users/UploadAvatarAction.php
View File

@ -16,37 +16,37 @@ class UploadAvatarAction extends SerializeResourceAction
/**
* @inheritdoc
*/
public static $serializer = 'Flarum\Api\Serializers\UserSerializer';
public $serializer = 'Flarum\Api\Serializers\UserSerializer';
/**
* @inheritdoc
*/
public static $include = [];
public $include = [];
/**
* @inheritdoc
*/
public static $link = [];
public $link = [];
/**
* @inheritdoc
*/
public static $limitMax = 50;
public $limitMax = 50;
/**
* @inheritdoc
*/
public static $limit = 20;
public $limit = 20;
/**
* @inheritdoc
*/
public static $sortFields = [];
public $sortFields = [];
/**
* @inheritdoc
*/
public static $sort;
public $sort;
/**
* @param Dispatcher $bus

46
framework/core/src/Api/ApiServiceProvider.php
View File

@ -1,6 +1,11 @@
<?php namespace Flarum\Api;
use Flarum\Api\Serializers\ActivitySerializer;
use Flarum\Api\Serializers\NotificationSerializer;
use Flarum\Core\Users\Guest;
use Flarum\Events\RegisterApiRoutes;
use Flarum\Events\RegisterActivityTypes;
use Flarum\Events\RegisterNotificationTypes;
use Flarum\Http\RouteCollection;
use Flarum\Http\UrlGenerator;
use Illuminate\Support\ServiceProvider;
@ -37,6 +42,45 @@ class ApiServiceProvider extends ServiceProvider
public function boot()
{
$this->routes();
$this->registerActivitySerializers();
$this->registerNotificationSerializers();
}
/**
* Register activity serializers.
*/
protected function registerActivitySerializers()
{
$blueprints = [];
$serializers = [
'posted' => 'Flarum\Api\Serializers\PostBasicSerializer',
'startedDiscussion' => 'Flarum\Api\Serializers\PostBasicSerializer',
'joined' => 'Flarum\Api\Serializers\UserSerializer'
];
event(new RegisterActivityTypes($blueprints, $serializers));
foreach ($serializers as $type => $serializer) {
ActivitySerializer::setSubjectSerializer($type, $serializer);
}
}
/**
* Register notification serializers.
*/
protected function registerNotificationSerializers()
{
$blueprints = [];
$serializers = [
'discussionRenamed' => 'Flarum\Api\Serializers\DiscussionBasicSerializer'
];
event(new RegisterNotificationTypes($blueprints, $serializers));
foreach ($serializers as $type => $serializer) {
NotificationSerializer::setSubjectSerializer($type, $serializer);
}
}
protected function routes()
@ -268,6 +312,8 @@ class ApiServiceProvider extends ServiceProvider
'flarum.api.groups.delete',
$this->action('Flarum\Api\Actions\Groups\DeleteAction')
);
event(new RegisterApiRoutes($routes));
}
protected function action($class)

42
framework/core/src/Api/Serializers/Serializer.php
View File

@ -1,10 +1,10 @@
<?php namespace Flarum\Api\Serializers;
use BadMethodCallException;
use Closure;
use Flarum\Core\Users\User;
use Flarum\Events\ApiAttributes;
use Flarum\Events\ApiRelationship;
use Tobscure\JsonApi\SerializerAbstract;
use Flarum\Api\Events\SerializeAttributes;
abstract class Serializer extends SerializerAbstract
{
@ -13,13 +13,6 @@ abstract class Serializer extends SerializerAbstract
*/
public $actor;
/**
* An array of custom relation methods, grouped by subclass.
*
* @var array
*/
protected static $relationMethods = [];
/**
* @param User $actor
* @param array|null $include
@ -39,7 +32,7 @@ abstract class Serializer extends SerializerAbstract
{
$attributes = $this->getDefaultAttributes($model);
event(new SerializeAttributes($this, $model, $attributes));
event(new ApiAttributes($this, $model, $attributes));
return $attributes;
}
@ -57,13 +50,26 @@ abstract class Serializer extends SerializerAbstract
*/
protected function getRelationshipFromMethod($name)
{
if (isset(static::$relationMethods[$name])) {
return call_user_func(static::$relationMethods[$name], $this);
if ($relationship = $this->getCustomRelationship($name)) {
return $relationship;
}
return parent::getRelationshipFromMethod($name);
}
/**
* Get a custom relationship.
*
* @param string $name
* @return mixed
*/
protected function getCustomRelationship($name)
{
return app('events')->until(
new ApiRelationship($this, $name)
);
}
/**
* Get a closure that returns a Collection/Resource representing a relation.
*
@ -154,16 +160,4 @@ abstract class Serializer extends SerializerAbstract
{
return $this->getRelationship($serializer, $relation, true);
}
/**
* Add a custom relation to the model.
*
* @param string $name The name of the relation.
* @param callable $callback The callback to execute. This should return a
* relation closure {@see Serializer::getRelationship()}
*/
public static function setRelationMethod($name, callable $callback)
{
static::$relationMethods[get_called_class()][$name] = $callback;
}
}

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

@ -9,7 +9,7 @@ use Flarum\Core\Discussions\Discussion;
use Flarum\Core\Discussions\DiscussionState;
use Flarum\Core\Posts\CommentPost;
use Flarum\Tags\Tag;
use Flarum\Core\Posts\Events\PostWasPosted;
use Flarum\Events\PostWasPosted;
use Symfony\Component\Console\Helper\ProgressBar;
class ImportCommand extends Command

2
framework/core/src/Core/Activity/Activity.php
View File

@ -27,7 +27,7 @@ class Activity extends Model
/**
* {@inheritdoc}
*/
protected static $dateAttributes = ['time'];
protected $dates = ['time'];
/**
* A map of activity types and the model classes to use for their subjects.

35
framework/core/src/Core/Activity/ActivityServiceProvider.php
View File

@ -1,5 +1,7 @@
<?php namespace Flarum\Core\Activity;
use Flarum\Core\Users\User;
use Flarum\Events\RegisterActivityTypes;
use Flarum\Support\ServiceProvider;
use Flarum\Extend;
@ -12,18 +14,33 @@ class ActivityServiceProvider extends ServiceProvider
*/
public function boot()
{
$this->extend([
(new Extend\EventSubscriber('Flarum\Core\Activity\Listeners\UserActivitySyncer')),
$this->registerActivityTypes();
(new Extend\ActivityType('Flarum\Core\Activity\PostedBlueprint'))
->subjectSerializer('Flarum\Api\Serializers\PostBasicSerializer'),
$events = $this->app->make('events');
$events->subscribe('Flarum\Core\Activity\Listeners\UserActivitySyncer');
}
(new Extend\ActivityType('Flarum\Core\Activity\StartedDiscussionBlueprint'))
->subjectSerializer('Flarum\Api\Serializers\PostBasicSerializer'),
/**
* Register activity types.
*
* @return void
*/
public function registerActivityTypes()
{
$blueprints = [
'Flarum\Core\Activity\PostedBlueprint',
'Flarum\Core\Activity\StartedDiscussionBlueprint',
'Flarum\Core\Activity\JoinedBlueprint'
];
(new Extend\ActivityType('Flarum\Core\Activity\JoinedBlueprint'))
->subjectSerializer('Flarum\Api\Serializers\UserBasicSerializer')
]);
event(new RegisterActivityTypes($blueprints));
foreach ($blueprints as $blueprint) {
Activity::setSubjectModel(
$blueprint::getType(),
$blueprint::getSubjectModel()
);
}
}
/**

30
framework/core/src/Core/Activity/Listeners/UserActivitySyncer.php
View File

@ -5,11 +5,11 @@ use Flarum\Core\Activity\PostedBlueprint;
use Flarum\Core\Activity\StartedDiscussionBlueprint;
use Flarum\Core\Activity\JoinedBlueprint;
use Flarum\Core\Posts\Post;
use Flarum\Core\Posts\Events\PostWasPosted;
use Flarum\Core\Posts\Events\PostWasDeleted;
use Flarum\Core\Posts\Events\PostWasHidden;
use Flarum\Core\Posts\Events\PostWasRestored;
use Flarum\Core\Users\Events\UserWasRegistered;
use Flarum\Events\PostWasPosted;
use Flarum\Events\PostWasDeleted;
use Flarum\Events\PostWasHidden;
use Flarum\Events\PostWasRestored;
use Flarum\Events\UserWasRegistered;
use Illuminate\Contracts\Events\Dispatcher;
class UserActivitySyncer
@ -33,15 +33,15 @@ class UserActivitySyncer
*/
public function subscribe(Dispatcher $events)
{
$events->listen('Flarum\Core\Posts\Events\PostWasPosted', __CLASS__.'@whenPostWasPosted');
$events->listen('Flarum\Core\Posts\Events\PostWasHidden', __CLASS__.'@whenPostWasHidden');
$events->listen('Flarum\Core\Posts\Events\PostWasRestored', __CLASS__.'@whenPostWasRestored');
$events->listen('Flarum\Core\Posts\Events\PostWasDeleted', __CLASS__.'@whenPostWasDeleted');
$events->listen('Flarum\Core\Users\Events\UserWasRegistered', __CLASS__.'@whenUserWasRegistered');
$events->listen('Flarum\Events\PostWasPosted', __CLASS__.'@whenPostWasPosted');
$events->listen('Flarum\Events\PostWasHidden', __CLASS__.'@whenPostWasHidden');
$events->listen('Flarum\Events\PostWasRestored', __CLASS__.'@whenPostWasRestored');
$events->listen('Flarum\Events\PostWasDeleted', __CLASS__.'@whenPostWasDeleted');
$events->listen('Flarum\Events\UserWasRegistered', __CLASS__.'@whenUserWasRegistered');
}
/**
* @param \Flarum\Core\Posts\Events\PostWasPosted $event
* @param \Flarum\Events\PostWasPosted $event
* @return void
*/
public function whenPostWasPosted(PostWasPosted $event)
@ -50,7 +50,7 @@ class UserActivitySyncer
}
/**
* @param \Flarum\Core\Posts\Events\PostWasHidden $event
* @param \Flarum\Events\PostWasHidden $event
* @return void
*/
public function whenPostWasHidden(PostWasHidden $event)
@ -59,7 +59,7 @@ class UserActivitySyncer
}
/**
* @param \Flarum\Core\Posts\Events\PostWasRestored $event
* @param \Flarum\Events\PostWasRestored $event
* @return void
*/
public function whenPostWasRestored(PostWasRestored $event)
@ -68,7 +68,7 @@ class UserActivitySyncer
}
/**
* @param \Flarum\Core\Posts\Events\PostWasDeleted $event
* @param \Flarum\Events\PostWasDeleted $event
* @return void
*/
public function whenPostWasDeleted(PostWasDeleted $event)
@ -77,7 +77,7 @@ class UserActivitySyncer
}
/**
* @param \Flarum\Core\Users\Events\UserWasRegistered $event
* @param \Flarum\Events\UserWasRegistered $event
* @return void
*/
public function whenUserWasRegistered(UserWasRegistered $event)

12
framework/core/src/Core/CoreServiceProvider.php
View File

@ -3,6 +3,7 @@
use Flarum\Core\Settings\MemoryCacheSettingsRepository;
use Flarum\Core\Settings\DatabaseSettingsRepository;
use Flarum\Core\Users\User;
use Flarum\Events\ModelAllow;
use Flarum\Support\ServiceProvider;
use Flarum\Extend;
@ -21,8 +22,13 @@ class CoreServiceProvider extends ServiceProvider
return get_class($command).'Handler@handle';
});
Forum::allow('*', function (Forum $forum, User $user, $action) {
return $user->hasPermission('forum.'.$action) ?: null;
$events = $this->app->make('events');
$events->listen(ModelAllow::class, function (ModelAllow $event) {
if ($event->model instanceof Forum &&
$event->actor->hasPermission('forum.'.$event->action)) {
return true;
}
});
}
@ -33,7 +39,7 @@ class CoreServiceProvider extends ServiceProvider
*/
public function register()
{
$this->app->singleton('Flarum\Core\Settings\SettingsRepository', function() {
$this->app->singleton('Flarum\Core\Settings\SettingsRepository', function () {
return new MemoryCacheSettingsRepository(
new DatabaseSettingsRepository(
$this->app->make('Illuminate\Database\ConnectionInterface')

2
framework/core/src/Core/Discussions/Commands/DeleteDiscussionHandler.php
View File

@ -1,7 +1,7 @@
<?php namespace Flarum\Core\Discussions\Commands;
use Flarum\Core\Discussions\DiscussionRepository;
use Flarum\Core\Discussions\Events\DiscussionWillBeDeleted;
use Flarum\Events\DiscussionWillBeDeleted;
use Flarum\Core\Support\DispatchesEvents;
class DeleteDiscussionHandler

2
framework/core/src/Core/Discussions/Commands/EditDiscussionHandler.php
View File

@ -1,7 +1,7 @@
<?php namespace Flarum\Core\Discussions\Commands;
use Flarum\Core\Discussions\DiscussionRepository;
use Flarum\Core\Discussions\Events\DiscussionWillBeSaved;
use Flarum\Events\DiscussionWillBeSaved;
use Flarum\Core\Support\DispatchesEvents;
class EditDiscussionHandler

2
framework/core/src/Core/Discussions/Commands/ReadDiscussionHandler.php
View File

@ -1,7 +1,7 @@
<?php namespace Flarum\Core\Discussions\Commands;
use Flarum\Core\Discussions\DiscussionRepository;
use Flarum\Core\Discussions\Events\DiscussionStateWillBeSaved;
use Flarum\Events\DiscussionStateWillBeSaved;
use Flarum\Core\Exceptions\PermissionDeniedException;
use Flarum\Core\Support\DispatchesEvents;

2
framework/core/src/Core/Discussions/Commands/StartDiscussionHandler.php
View File

@ -1,6 +1,6 @@
<?php namespace Flarum\Core\Discussions\Commands;
use Flarum\Core\Discussions\Events\DiscussionWillBeSaved;
use Flarum\Events\DiscussionWillBeSaved;
use Flarum\Core\Forum;
use Illuminate\Contracts\Bus\Dispatcher;
use Flarum\Core\Discussions\Discussion;

19
framework/core/src/Core/Discussions/Discussion.php
View File

@ -1,10 +1,10 @@
<?php namespace Flarum\Core\Discussions;
use Flarum\Core\Model;
use Flarum\Core\Discussions\Events\DiscussionWasDeleted;
use Flarum\Core\Discussions\Events\DiscussionWasStarted;
use Flarum\Core\Discussions\Events\DiscussionWasRenamed;
use Flarum\Core\Posts\Events\PostWasDeleted;
use Flarum\Events\DiscussionWasDeleted;
use Flarum\Events\DiscussionWasStarted;
use Flarum\Events\DiscussionWasRenamed;
use Flarum\Events\PostWasDeleted;
use Flarum\Core\Posts\Post;
use Flarum\Core\Posts\MergeablePost;
use Flarum\Core\Users\Guest;
@ -21,13 +21,10 @@ class Discussion extends Model
{
use EventGenerator;
use Locked;
use VisibleScope;
use ValidatesBeforeSave;
/**
* The table associated with the model.
*
* @var string
* {@inheritdoc}
*/
protected $table = 'discussions';
@ -57,11 +54,9 @@ class Discussion extends Model
protected $modifiedPosts = [];
/**
* The attributes that should be mutated to dates.
*
* @var array
* {@inheritdoc}
*/
protected static $dateAttributes = ['start_time', 'last_time'];
protected $dates = ['start_time', 'last_time'];
/**
* The user for which the state relationship should be loaded.

4
framework/core/src/Core/Discussions/DiscussionState.php
View File

@ -1,6 +1,6 @@
<?php namespace Flarum\Core\Discussions;
use Flarum\Core\Discussions\Events\DiscussionWasRead;
use Flarum\Events\DiscussionWasRead;
use Flarum\Core\Model;
use Flarum\Core\Support\EventGenerator;
use Illuminate\Database\Eloquent\Builder;
@ -26,7 +26,7 @@ class DiscussionState extends Model
/**
* {@inheritdoc}
*/
protected static $dateAttributes = ['read_time'];
protected $dates = ['read_time'];
/**
* Mark the discussion as being read up to a certain point. Raises the

50
framework/core/src/Core/Discussions/DiscussionsServiceProvider.php
View File

@ -2,6 +2,8 @@
use Flarum\Core\Search\GambitManager;
use Flarum\Core\Users\User;
use Flarum\Events\ModelAllow;
use Flarum\Events\RegisterDiscussionGambits;
use Flarum\Support\ServiceProvider;
use Flarum\Extend;
use Illuminate\Contracts\Container\Container;
@ -15,25 +17,29 @@ class DiscussionsServiceProvider extends ServiceProvider
*/
public function boot()
{
$this->extend([
new Extend\EventSubscriber('Flarum\Core\Discussions\Listeners\DiscussionMetadataUpdater')
]);
Discussion::setValidator($this->app->make('validator'));
Discussion::allow('*', function (Discussion $discussion, User $user, $action) {
return $user->hasPermission('discussion.'.$action) ?: null;
});
$events = $this->app->make('events');
// Allow a user to rename their own discussion.
Discussion::allow('rename', function (Discussion $discussion, User $user) {
return $discussion->start_user_id == $user->id ?: null;
// TODO: add limitations to time etc. according to a config setting
});
$events->subscribe('Flarum\Core\Discussions\Listeners\DiscussionMetadataUpdater');
Discussion::allow('delete', function (Discussion $discussion, User $user) {
return $discussion->start_user_id == $user->id && $discussion->participants_count == 1 ?: null;
// TODO: add limitations to time etc. according to a config setting
$events->listen(ModelAllow::class, function (ModelAllow $event) {
if ($event->model instanceof Discussion) {
if ($event->action === 'rename' &&
$event->model->start_user_id == $event->actor->id) {
return true;
}
if ($event->action === 'delete' &&
$event->model->start_user_id == $event->actor->id &&
$event->model->participants_count == 1) {
return true;
}
if ($event->actor->hasPermission('discussion.'.$event->action)) {
return true;
}
}
});
}
@ -49,21 +55,15 @@ class DiscussionsServiceProvider extends ServiceProvider
'Flarum\Core\Discussions\Search\Fulltext\MySqlFulltextDriver'
);
$this->app->instance('flarum.discussionGambits', [
'Flarum\Core\Discussions\Search\Gambits\AuthorGambit',
'Flarum\Core\Discussions\Search\Gambits\UnreadGambit'
]);
$this->app->when('Flarum\Core\Discussions\Search\DiscussionSearcher')
->needs('Flarum\Core\Search\GambitManager')
->give(function (Container $app) {
$gambits = new GambitManager($app);
foreach ($app->make('flarum.discussionGambits') as $gambit) {
$gambits->add($gambit);
}
$gambits->setFulltextGambit('Flarum\Core\Discussions\Search\Gambits\FulltextGambit');
$gambits->add('Flarum\Core\Discussions\Search\Gambits\AuthorGambit');
$gambits->add('Flarum\Core\Discussions\Search\Gambits\UnreadGambit');
event(new RegisterDiscussionGambits($gambits));
return $gambits;
});

10
framework/core/src/Core/Discussions/Listeners/DiscussionMetadataUpdater.php
View File

@ -1,10 +1,10 @@
<?php namespace Flarum\Core\Discussions\Listeners;
use Flarum\Core\Posts\Post;
use Flarum\Core\Posts\Events\PostWasPosted;
use Flarum\Core\Posts\Events\PostWasDeleted;
use Flarum\Core\Posts\Events\PostWasHidden;
use Flarum\Core\Posts\Events\PostWasRestored;
use Flarum\Events\PostWasPosted;
use Flarum\Events\PostWasDeleted;
use Flarum\Events\PostWasHidden;
use Flarum\Events\PostWasRestored;
use Illuminate\Contracts\Events\Dispatcher;
class DiscussionMetadataUpdater
@ -34,7 +34,7 @@ class DiscussionMetadataUpdater
}
/**
* @param PostWasDeleted $event
* @param \Flarum\Events\PostWasDeleted $event
*/
public function whenPostWasDeleted(PostWasDeleted $event)
{

2
framework/core/src/Core/Discussions/Search/DiscussionSearcher.php
View File

@ -7,7 +7,7 @@ use Flarum\Core\Search\SearcherInterface;
use Flarum\Core\Search\GambitManager;
use Flarum\Core\Discussions\DiscussionRepository;
use Flarum\Core\Posts\PostRepository;
use Flarum\Core\Discussions\Events\DiscussionSearchWillBePerformed;
use Flarum\Events\DiscussionSearchWillBePerformed;
use Flarum\Core\Search\SearchResults;
use Illuminate\Database\Eloquent\Collection;

3
framework/core/src/Core/Formatter/FormatterServiceProvider.php
View File

@ -12,9 +12,6 @@ class FormatterServiceProvider extends ServiceProvider
*/
public function boot()
{
$this->extend([
new Extend\PostFormatter('Flarum\Core\Formatter\LinkifyFormatter')
]);
}
/**

113
framework/core/src/Core/Model.php
View File

@ -1,6 +1,13 @@
<?php namespace Flarum\Core;
use Flarum\Core\Exceptions\PermissionDeniedException;
use Flarum\Core\Users\User;
use Flarum\Events\ModelAllow;
use Flarum\Events\ModelDates;
use Flarum\Events\ModelRelationship;
use Flarum\Events\ScopeModelVisibility;
use Illuminate\Contracts\Validation\Factory;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model as Eloquent;
use Illuminate\Database\Eloquent\Relations\Relation;
use LogicException;
@ -11,6 +18,9 @@ use LogicException;
* Adds the ability for custom relations to be added to a model during runtime.
* These relations behave in the same way that you would expect; they can be
* queried, eager loaded, and accessed as an attribute.
*
* Also has a scope method `whereVisibleTo` that scopes a query to only include
* records that the user has permission to see.
*/
abstract class Model extends Eloquent
{
@ -21,20 +31,6 @@ abstract class Model extends Eloquent
*/
public $timestamps = false;
/**
* The attributes that should be mutated to dates.
*
* @var array
*/
protected static $dateAttributes = [];
/**
* An array of custom relation methods, grouped by subclass.
*
* @var array
*/
protected static $relationMethods = [];
/**
* Get the attributes that should be converted to dates.
*
@ -42,17 +38,56 @@ abstract class Model extends Eloquent
*/
public function getDates()
{
return array_merge(static::$dateAttributes, $this->dates);
$dates = $this->dates;
event(new ModelDates($this, $dates));
return $dates;
}
/**
* Add an attribute to be converted to a date.
* Check whether or not a user has permission to perform an action,
* according to the collected conditions.
*
* @param string $attribute
* @param User $actor
* @param string $action
* @return bool
*/
public static function addDateAttribute($attribute)
public function can(User $actor, $action)
{
static::$dateAttributes[] = $attribute;
$can = static::$dispatcher->until(new ModelAllow($this, $actor, $action));
if ($can !== null) {
return $can;
}
return false;
}
/**
* Assert that the user has a certain permission for this model, throwing
* an exception if they don't.
*
* @param User $actor
* @param string $action
* @throws PermissionDeniedException
*/
public function assertCan(User $actor, $action)
{
if (! $this->can($actor, $action)) {
throw new PermissionDeniedException;
}
}
/**
* Scope a query to only include records that are visible to a user.
*
* @param Builder $query
* @param User $actor
*/
public function scopeWhereVisibleTo(Builder $query, User $actor)
{
event(new ScopeModelVisibility($this, $query, $actor));
}
/**
@ -71,40 +106,38 @@ abstract class Model extends Eloquent
// If a custom relation with this key has been set up, then we will load
// and return results from the query and hydrate the relationship's
// value on the "relationships" array.
if (isset(static::$relationMethods[get_called_class()][$key])) {
return $this->getCustomRelationship($key);
if ($relation = $this->getCustomRelation($key)) {
if (! $relation instanceof Relation) {
throw new LogicException('Relationship method must return an object of type '
. 'Illuminate\Database\Eloquent\Relations\Relation');
}
return $this->relations[$key] = $relation->getResults();
}
}
/**
* Get a relationship value from a custom relationship method.
* Get a custom relation object.
*
* @param string $name
* @return mixed
*
* @throws \LogicException
*/
protected function getCustomRelationship($name)
protected function getCustomRelation($name)
{
$relation = static::$relationMethods[get_called_class()][$name]($this);
if (! $relation instanceof Relation) {
throw new LogicException('Relationship method must return an object of type '
. 'Illuminate\Database\Eloquent\Relations\Relation');
}
return $this->relations[$name] = $relation->getResults();
return static::$dispatcher->until(
new ModelRelationship($this, $name)
);
}
/**
* Add a custom relation to the model.
*
* @param string $name The name of the relation.
* @param callable $callback The callback to execute. This should return an
* object of type Illuminate\Database\Eloquent\Relations\Relation.
* @inheritdoc
*/
public static function setRelationMethod($name, callable $callback)
public function __call($method, $arguments)
{
static::$relationMethods[get_called_class()][$name] = $callback;
if ($relation = $this->getCustomRelation($method)) {
return $relation;
}
return parent::__call($method, $arguments);
}
}

4
framework/core/src/Core/Notifications/Listeners/DiscussionRenamedNotifier.php
View File

@ -1,6 +1,6 @@
<?php namespace Flarum\Core\Notifications\Listeners;
use Flarum\Core\Discussions\Events\DiscussionWasRenamed;
use Flarum\Events\DiscussionWasRenamed;
use Flarum\Core\Posts\DiscussionRenamedPost;
use Flarum\Core\Notifications\DiscussionRenamedBlueprint;
use Flarum\Core\Notifications\NotificationSyncer;
@ -30,7 +30,7 @@ class DiscussionRenamedNotifier
}
/**
* @param DiscussionWasRenamed $event
* @param \Flarum\Events\DiscussionWasRenamed $event
*/
public function whenDiscussionWasRenamed(DiscussionWasRenamed $event)
{

2
framework/core/src/Core/Notifications/Notification.php
View File

@ -31,7 +31,7 @@ class Notification extends Model
/**
* {@inheritdoc}
*/
protected static $dateAttributes = ['time'];
protected $dates = ['time'];
/**
* A map of notification types and the model classes to use for their

2
framework/core/src/Core/Notifications/NotificationSyncer.php
View File

@ -1,6 +1,6 @@
<?php namespace Flarum\Core\Notifications;
use Flarum\Core\Notifications\Events\NotificationWillBeSent;
use Flarum\Events\NotificationWillBeSent;
use Flarum\Core\Users\User;
use Carbon\Carbon;

48
framework/core/src/Core/Notifications/NotificationsServiceProvider.php
View File

@ -1,7 +1,10 @@
<?php namespace Flarum\Core\Notifications;
use Flarum\Core\Users\User;
use Flarum\Events\RegisterNotificationTypes;
use Flarum\Support\ServiceProvider;
use Flarum\Extend;
use ReflectionClass;
class NotificationsServiceProvider extends ServiceProvider
{
@ -12,13 +15,46 @@ class NotificationsServiceProvider extends ServiceProvider
*/
public function boot()
{
$this->extend([
(new Extend\EventSubscriber('Flarum\Core\Notifications\Listeners\DiscussionRenamedNotifier')),
$events = $this->app->make('events');
(new Extend\NotificationType('Flarum\Core\Notifications\DiscussionRenamedBlueprint'))
->subjectSerializer('Flarum\Api\Serializers\DiscussionBasicSerializer')
->enableByDefault('alert')
]);
$events->subscribe('Flarum\Core\Notifications\Listeners\DiscussionRenamedNotifier');
$this->registerNotificationTypes();
}
/**
* Register notification types.
*
* @return void
*/
public function registerNotificationTypes()
{
$blueprints = [
'Flarum\Core\Notifications\DiscussionRenamedBlueprint' => ['alert']
];
event(new RegisterNotificationTypes($blueprints));
foreach ($blueprints as $blueprint => $enabled) {
Notification::setSubjectModel(
$type = $blueprint::getType(),
$blueprint::getSubjectModel()
);
User::addPreference(
User::getNotificationPreferenceKey($type, 'alert'),
'boolval',
in_array('alert', $enabled)
);
if ((new ReflectionClass($blueprint))->implementsInterface('Flarum\Core\Notifications\MailableBlueprint')) {
User::addPreference(
User::getNotificationPreferenceKey($type, 'email'),
'boolval',
in_array('email', $enabled)
);
}
}
}
/**

2
framework/core/src/Core/Posts/Commands/DeletePostHandler.php
View File

@ -1,7 +1,7 @@
<?php namespace Flarum\Core\Posts\Commands;
use Flarum\Core\Posts\PostRepository;
use Flarum\Core\Posts\Events\PostWillBeDeleted;
use Flarum\Events\PostWillBeDeleted;
use Flarum\Core\Support\DispatchesEvents;
class DeletePostHandler

2
framework/core/src/Core/Posts/Commands/EditPostHandler.php
View File

@ -1,7 +1,7 @@
<?php namespace Flarum\Core\Posts\Commands;
use Flarum\Core\Posts\PostRepository;
use Flarum\Core\Posts\Events\PostWillBeSaved;
use Flarum\Events\PostWillBeSaved;
use Flarum\Core\Support\DispatchesEvents;
use Flarum\Core\Posts\CommentPost;

2
framework/core/src/Core/Posts/Commands/PostReplyHandler.php
View File

@ -1,6 +1,6 @@
<?php namespace Flarum\Core\Posts\Commands;
use Flarum\Core\Posts\Events\PostWillBeSaved;
use Flarum\Events\PostWillBeSaved;
use Flarum\Core\Discussions\DiscussionRepository;
use Flarum\Core\Posts\CommentPost;
use Flarum\Core\Support\DispatchesEvents;

8
framework/core/src/Core/Posts/CommentPost.php
View File

@ -2,10 +2,10 @@
use DomainException;
use Flarum\Core\Formatter\FormatterManager;
use Flarum\Core\Posts\Events\PostWasPosted;
use Flarum\Core\Posts\Events\PostWasRevised;
use Flarum\Core\Posts\Events\PostWasHidden;
use Flarum\Core\Posts\Events\PostWasRestored;
use Flarum\Events\PostWasPosted;
use Flarum\Events\PostWasRevised;
use Flarum\Events\PostWasHidden;
use Flarum\Events\PostWasRestored;
use Flarum\Core\Users\User;
/**

5
framework/core/src/Core/Posts/Post.php
View File

@ -1,7 +1,7 @@
<?php namespace Flarum\Core\Posts;
use DomainException;
use Flarum\Core\Posts\Events\PostWasDeleted;
use Flarum\Events\PostWasDeleted;
use Flarum\Core\Model;
use Flarum\Core\Support\Locked;
use Flarum\Core\Support\EventGenerator;
@ -42,7 +42,7 @@ class Post extends Model
/**
* {@inheritdoc}
*/
protected static $dateAttributes = ['time', 'edit_time', 'hide_time'];
protected $dates = ['time', 'edit_time', 'hide_time'];
/**
* A map of post types, as specified in the `type` column, to their
@ -161,6 +161,7 @@ class Post extends Model
&& isset(static::$models[$attributes['type']])
&& class_exists($class = static::$models[$attributes['type']])
) {
/** @var Post $instance */
$instance = new $class;
$instance->exists = true;
$instance->setRawAttributes($attributes, true);

79
framework/core/src/Core/Posts/PostsServiceProvider.php
View File

@ -2,6 +2,9 @@
use Flarum\Core\Discussions\Discussion;
use Flarum\Core\Users\User;
use Flarum\Events\ModelAllow;
use Flarum\Events\RegisterPostTypes;
use Flarum\Events\ScopePostVisibility;
use Flarum\Support\ServiceProvider;
use Flarum\Extend;
@ -14,45 +17,73 @@ class PostsServiceProvider extends ServiceProvider
*/
public function boot()
{
$this->extend([
new Extend\PostType('Flarum\Core\Posts\CommentPost'),
new Extend\PostType('Flarum\Core\Posts\DiscussionRenamedPost')
]);
Post::setValidator($this->app->make('validator'));
CommentPost::setFormatter($this->app->make('flarum.formatter'));
Post::allow('*', function ($post, $user, $action) {
return $post->discussion->can($user, $action.'Posts') ?: null;
$this->registerPostTypes();
$events = $this->app->make('events');
$events->listen(ModelAllow::class, function (ModelAllow $event) {
if ($event->model instanceof Post) {
$post = $event->model;
$action = $event->action;
$actor = $event->actor;
if ($action === 'view' &&
(! $post->hide_user_id || $post->can($actor, 'edit'))) {
return true;
}
// A post is allowed to be edited if the user has permission to moderate
// the discussion which it's in, or if they are the author and the post
// hasn't been deleted by someone else.
if ($action === 'edit' &&
($post->discussion->can($actor, 'editPosts') ||
($post->user_id == $actor->id &&
(! $post->hide_user_id || $post->hide_user_id == $actor->id)))) {
return true;
}
if ($post->discussion->can($actor, $action.'Posts')) {
return true;
}
}
});
// When fetching a discussion's posts: if the user doesn't have permission
// to moderate the discussion, then they can't see posts that have been
// hidden by someone other than themself.
Discussion::addPostVisibilityScope(function ($query, User $user, Discussion $discussion) {
if (! $discussion->can($user, 'editPosts')) {
$query->where(function ($query) use ($user) {
$events->listen(ScopePostVisibility::class, function (ScopePostVisibility $event) {
$user = $event->actor;
if (! $event->discussion->can($user, 'editPosts')) {
$event->query->where(function ($query) use ($user) {
$query->whereNull('hide_user_id')
->orWhere('hide_user_id', $user->id);
->orWhere('hide_user_id', $user->id);
});
}
});
}
Post::allow('view', function ($post, $user) {
return ! $post->hide_user_id || $post->can($user, 'edit') ?: null;
});
/**
* Register post types.
*
* @return void
*/
public function registerPostTypes()
{
$models = [
'Flarum\Core\Posts\CommentPost',
'Flarum\Core\Posts\DiscussionRenamedPost'
];
// A post is allowed to be edited if the user has permission to moderate
// the discussion which it's in, or if they are the author and the post
// hasn't been deleted by someone else.
Post::allow('edit', function ($post, $user) {
if ($post->discussion->can($user, 'editPosts') ||
($post->user_id == $user->id && (! $post->hide_user_id || $post->hide_user_id == $user->id))
) {
return true;
}
});
event(new RegisterPostTypes($models));
foreach ($models as $model) {
Post::setModel($model::$type, $model);
}
}
/**

72
framework/core/src/Core/Support/Locked.php
View File

@ -2,6 +2,8 @@
use Flarum\Core\Exceptions\PermissionDeniedException;
use Flarum\Core\Users\User;
use Flarum\Events\ModelAllow;
use Illuminate\Contracts\Events\Dispatcher;
/**
* 'Lock' an object, allowing the permission of a user to perform an action to
@ -9,75 +11,5 @@ use Flarum\Core\Users\User;
*/
trait Locked
{
/**
* @var callable[]
*/
protected static $conditions = [];
/**
* Get the condition callbacks for the specified action.
*
* @param string $action
* @return callable[]
*/
protected static function getConditions($action)
{
$conditions = array_get(static::$conditions, $action, []);
$all = array_get(static::$conditions, '*', []);
return array_merge($conditions, $all);
}
/**
* Allow the specified action if the given condition is satisfied.
*
* @param string $action
* @param callable $condition The condition callback. Parameters are the
* object that is locked, the user performing the action,
* and the name of the action. This condition will be ignored if it
* returns null; otherwise, the return value will determine whether or
* not the action is allowed.
*/
public static function allow($action, callable $condition)
{
foreach ((array)$action as $action) {
static::$conditions[$action][] = $condition;
}
}
/**
* Check whether or not a user has permission to perform an action,
* according to the collected conditions.
*
* @param User $actor
* @param string $action
* @return bool
*/
public function can(User $actor, $action)
{
foreach ($this->getConditions($action) as $condition) {
$can = $condition($this, $actor, $action);
if ($can !== null) {
return $can;
}
}
return false;
}
/**
* Assert that the user has a certain permission for this model, throwing
* an exception if they don't.
*
* @param User $actor
* @param string $action
* @throws PermissionDeniedException
*/
public function assertCan(User $actor, $action)
{
if (! $this->can($actor, $action)) {
throw new PermissionDeniedException;
}
}
}

11
framework/core/src/Core/Support/ValidatesBeforeSave.php
View File

@ -1,6 +1,7 @@
<?php namespace Flarum\Core\Support;
use Illuminate\Contracts\Validation\Factory;
use Flarum\Events\ModelValidator;
use Illuminate\Validation\Factory;
use Illuminate\Contracts\Validation\ValidationException;
use Illuminate\Validation\Validator;
@ -79,13 +80,11 @@ trait ValidatesBeforeSave
*/
protected function makeValidator()
{
$dirty = $this->getDirty();
$rules = $this->expandUniqueRules($this->rules);
$rules = $this->expandUniqueRules(array_only($this->rules, array_keys($dirty)));
$validator = static::$validator->make($this->getAttributes(), $rules);
$validator = static::$validator->make($dirty, $rules);
// TODO: event
event(new ModelValidator($this, $validator));
return $validator;
}

40
framework/core/src/Core/Support/VisibleScope.php
View File

@ -1,40 +0,0 @@
<?php namespace Flarum\Core\Support;
use Flarum\Core\Users\User;
use Illuminate\Database\Eloquent\Builder;
/**
* Add a query scope to an Eloquent model that filters out records that a user
* is not allowed to view.
*/
trait VisibleScope
{
/**
* @var callable[]
*/
protected static $visibleScopes = [];
/**
* Add a callback to scope a query to only include records that are visible
* to a user.
*
* @param callable $scope
*/
public static function addVisibleScope(callable $scope)
{
static::$visibleScopes[] = $scope;
}
/**
* Scope a query to only include records that are visible to a user.
*
* @param Builder $query
* @param User $user
*/
public function scopeWhereVisibleTo(Builder $query, User $user)
{
foreach (static::$visibleScopes as $scope) {
$scope($query, $user);
}
}
}

2
framework/core/src/Core/Users/Commands/ConfirmEmailHandler.php
View File

@ -1,7 +1,7 @@
<?php namespace Flarum\Core\Users\Commands;
use Flarum\Core\Users\UserRepository;
use Flarum\Core\Users\Events\UserWillBeSaved;
use Flarum\Events\UserWillBeSaved;
use Flarum\Core\Support\DispatchesEvents;
use Flarum\Core\Exceptions\InvalidConfirmationTokenException;
use Flarum\Core\Users\EmailToken;

2
framework/core/src/Core/Users/Commands/DeleteAvatarHandler.php
View File

@ -1,6 +1,6 @@
<?php namespace Flarum\Core\Users\Commands;
use Flarum\Core\Users\Events\AvatarWillBeDeleted;
use Flarum\Events\AvatarWillBeDeleted;
use Flarum\Core\Users\UserRepository;
use Flarum\Core\Support\DispatchesEvents;
use League\Flysystem\FilesystemInterface;

2
framework/core/src/Core/Users/Commands/DeleteUserHandler.php
View File

@ -2,7 +2,7 @@
use Flarum\Core\Users\User;
use Flarum\Core\Users\UserRepository;
use Flarum\Core\Users\Events\UserWillBeDeleted;
use Flarum\Events\UserWillBeDeleted;
use Flarum\Core\Support\DispatchesEvents;
class DeleteUserHandler

2
framework/core/src/Core/Users/Commands/EditUserHandler.php
View File

@ -2,7 +2,7 @@
use Flarum\Core\Users\User;
use Flarum\Core\Users\UserRepository;
use Flarum\Core\Users\Events\UserWillBeSaved;
use Flarum\Events\UserWillBeSaved;
use Flarum\Core\Support\DispatchesEvents;
class EditUserHandler

2
framework/core/src/Core/Users/Commands/RegisterUserHandler.php
View File

@ -1,7 +1,7 @@
<?php namespace Flarum\Core\Users\Commands;
use Flarum\Core\Users\User;
use Flarum\Core\Users\Events\UserWillBeSaved;
use Flarum\Events\UserWillBeSaved;
use Flarum\Core\Support\DispatchesEvents;
class RegisterUserHandler

2
framework/core/src/Core/Users/Commands/UploadAvatarHandler.php
View File

@ -1,6 +1,6 @@
<?php namespace Flarum\Core\Users\Commands;
use Flarum\Core\Users\Events\AvatarWillBeSaved;
use Flarum\Events\AvatarWillBeSaved;
use Flarum\Core\Users\UserRepository;
use Flarum\Core\Support\DispatchesEvents;
use Illuminate\Support\Str;

8
framework/core/src/Core/Users/Listeners/EmailConfirmationMailer.php
View File

@ -1,8 +1,8 @@
<?php namespace Flarum\Core\Users\Listeners;
use Flarum\Core\Settings\SettingsRepository;
use Flarum\Core\Users\Events\UserWasRegistered;
use Flarum\Core\Users\Events\UserEmailChangeWasRequested;
use Flarum\Events\UserWasRegistered;
use Flarum\Events\UserEmailChangeWasRequested;
use Flarum\Core;
use Flarum\Core\Users\EmailToken;
use Flarum\Core\Users\User;
@ -42,7 +42,7 @@ class EmailConfirmationMailer
}
/**
* @param UserWasRegistered $event
* @param \Flarum\Events\UserWasRegistered $event
*/
public function whenUserWasRegistered(UserWasRegistered $event)
{
@ -56,7 +56,7 @@ class EmailConfirmationMailer
}
/**
* @param UserEmailChangeWasRequested $event
* @param \Flarum\Events\UserEmailChangeWasRequested $event
*/
public function whenUserEmailChangeWasRequested(UserEmailChangeWasRequested $event)
{

18
framework/core/src/Core/Users/Listeners/UserMetadataUpdater.php
View File

@ -1,12 +1,12 @@
<?php namespace Flarum\Core\Users\Listeners;
use Flarum\Core\Users\User;
use Flarum\Core\Posts\Events\PostWasPosted;
use Flarum\Core\Posts\Events\PostWasDeleted;
use Flarum\Core\Posts\Events\PostWasHidden;
use Flarum\Core\Posts\Events\PostWasRestored;
use Flarum\Core\Discussions\Events\DiscussionWasStarted;
use Flarum\Core\Discussions\Events\DiscussionWasDeleted;
use Flarum\Events\PostWasPosted;
use Flarum\Events\PostWasDeleted;
use Flarum\Events\PostWasHidden;
use Flarum\Events\PostWasRestored;
use Flarum\Events\DiscussionWasStarted;
use Flarum\Events\DiscussionWasDeleted;
use Illuminate\Contracts\Events\Dispatcher;
class UserMetadataUpdater
@ -49,7 +49,7 @@ class UserMetadataUpdater
}
/**
* @param PostWasRestored $event
* @param \Flarum\Events\PostWasRestored $event
*/
public function whenPostWasRestored(PostWasRestored $event)
{
@ -57,7 +57,7 @@ class UserMetadataUpdater
}
/**
* @param DiscussionWasStarted $event
* @param \Flarum\Events\DiscussionWasStarted $event
*/
public function whenDiscussionWasStarted(DiscussionWasStarted $event)
{
@ -65,7 +65,7 @@ class UserMetadataUpdater
}
/**
* @param DiscussionWasDeleted $event
* @param \Flarum\Events\DiscussionWasDeleted $event
*/
public function whenDiscussionWasDeleted(DiscussionWasDeleted $event)
{

2
framework/core/src/Core/Users/Search/UserSearcher.php
View File

@ -5,7 +5,7 @@ use Flarum\Core\Search\GambitManager;
use Flarum\Core\Search\SearchCriteria;
use Flarum\Core\Search\SearchResults;
use Flarum\Core\Users\UserRepository;
use Flarum\Core\Users\Events\UserSearchWillBePerformed;
use Flarum\Events\UserSearchWillBePerformed;
/**
* Takes a UserSearchCriteria object, performs a search using gambits,

24
framework/core/src/Core/Users/User.php
View File

@ -4,17 +4,18 @@ use Flarum\Core;
use Flarum\Core\Groups\Group;
use Flarum\Core\Model;
use Flarum\Core\Notifications\Notification;
use Flarum\Events\RegisterUserPreferences;
use Illuminate\Contracts\Hashing\Hasher;
use Flarum\Core\Formatter\FormatterManager;
use Flarum\Core\Users\Events\UserWasDeleted;
use Flarum\Core\Users\Events\UserWasRegistered;
use Flarum\Core\Users\Events\UserWasRenamed;
use Flarum\Core\Users\Events\UserEmailWasChanged;
use Flarum\Core\Users\Events\UserPasswordWasChanged;
use Flarum\Core\Users\Events\UserBioWasChanged;
use Flarum\Core\Users\Events\UserAvatarWasChanged;
use Flarum\Core\Users\Events\UserWasActivated;
use Flarum\Core\Users\Events\UserEmailChangeWasRequested;
use Flarum\Events\UserWasDeleted;
use Flarum\Events\UserWasRegistered;
use Flarum\Events\UserWasRenamed;
use Flarum\Events\UserEmailWasChanged;
use Flarum\Events\UserPasswordWasChanged;
use Flarum\Events\UserBioWasChanged;
use Flarum\Events\UserAvatarWasChanged;
use Flarum\Events\UserWasActivated;
use Flarum\Events\UserEmailChangeWasRequested;
use Flarum\Core\Support\Locked;
use Flarum\Core\Support\VisibleScope;
use Flarum\Core\Support\EventGenerator;
@ -27,7 +28,6 @@ class User extends Model
{
use EventGenerator;
use Locked;
use VisibleScope;
use ValidatesBeforeSave;
/**
@ -53,7 +53,7 @@ class User extends Model
/**
* {@inheritdoc}
*/
protected static $dateAttributes = [
protected $dates = [
'join_time',
'last_seen_time',
'read_time',
@ -97,6 +97,8 @@ class User extends Model
static::deleted(function ($user) {
$user->raise(new UserWasDeleted($user));
});
event(new RegisterUserPreferences);
}
/**

41
framework/core/src/Core/Users/UsersServiceProvider.php
View File

@ -1,6 +1,9 @@
<?php namespace Flarum\Core\Users;
use Flarum\Core\Search\GambitManager;
use Flarum\Events\ModelAllow;
use Flarum\Events\RegisterUserGambits;
use Flarum\Events\RegisterUserPreferences;
use Flarum\Support\ServiceProvider;
use Flarum\Extend;
use Illuminate\Contracts\Container\Container;
@ -14,25 +17,32 @@ class UsersServiceProvider extends ServiceProvider
*/
public function boot()
{
$this->extend([
new Extend\EventSubscriber('Flarum\Core\Users\Listeners\UserMetadataUpdater'),
new Extend\EventSubscriber('Flarum\Core\Users\Listeners\EmailConfirmationMailer')
]);
User::setHasher($this->app->make('hash'));
User::setFormatter($this->app->make('flarum.formatter'));
User::setValidator($this->app->make('validator'));
User::addPreference('discloseOnline', 'boolval', true);
User::addPreference('indexProfile', 'boolval', true);
$events = $this->app->make('events');
User::allow('*', function (User $user, User $actor, $action) {
return $actor->hasPermission('user.'.$action) ?: null;
$events->listen(RegisterUserPreferences::class, function (RegisterUserPreferences $event) {
$event->register('discloseOnline', 'boolval', true);
$event->register('indexProfile', 'boolval', true);
});
User::allow(['edit', 'delete'], function (User $user, User $actor) {
return $user->id == $actor->id ?: null;
$events->listen(ModelAllow::class, function (ModelAllow $event) {
if ($event->model instanceof User) {
if (in_array($event->action, ['edit', 'delete']) &&
$event->model->id == $event->actor->id) {
return true;
}
if ($event->actor->hasPermission('user.'.$event->action)) {
return true;
}
}
});
$events->subscribe('Flarum\Core\Users\Listeners\UserMetadataUpdater');
$events->subscribe('Flarum\Core\Users\Listeners\EmailConfirmationMailer');
}
/**
@ -63,19 +73,14 @@ class UsersServiceProvider extends ServiceProvider
public function registerGambits()
{
$this->app->instance('flarum.userGambits', []);
$this->app->when('Flarum\Core\Users\Search\UserSearcher')
->needs('Flarum\Core\Search\GambitManager')
->give(function (Container $app) {
$gambits = new GambitManager($app);
foreach ($app->make('flarum.userGambits') as $gambit) {
$gambits->add($gambit);
}
$gambits->setFulltextGambit('Flarum\Core\Users\Search\Gambits\FulltextGambit');
event(new RegisterUserGambits($gambits));
return $gambits;
});
}

10
framework/core/src/Api/Events/SerializeAttributes.php → framework/core/src/Events/ApiAttributes.php
View File

@ -1,8 +1,8 @@
<?php namespace Flarum\Api\Events;
<?php namespace Flarum\Events;
use Flarum\Api\Serializers\Serializer;
class SerializeAttributes
class ApiAttributes
{
/**
* The class doing the serializing.
@ -25,6 +25,11 @@ class SerializeAttributes
*/
public $attributes;
/**
* @var \Flarum\Core\Users\User
*/
public $actor;
/**
* @param Serializer $serializer The class doing the serializing.
* @param object $model The model being serialized.
@ -35,5 +40,6 @@ class SerializeAttributes
$this->serializer = $serializer;
$this->model = $model;
$this->attributes = &$attributes;
$this->actor = $serializer->actor;
}
}

26
framework/core/src/Events/ApiRelationship.php Normal file
View File

@ -0,0 +1,26 @@
<?php namespace Flarum\Events;
use Flarum\Api\Serializers\Serializer;
class ApiRelationship
{
/**
* @var Serializer
*/
public $serializer;
/**
* @var string
*/
public $relationship;
/**
* @param Serializer $serializer
* @param string $relationship
*/
public function __construct(Serializer $serializer, $relationship)
{
$this->serializer = $serializer;
$this->relationship = $relationship;
}
}

2
framework/core/src/Core/Users/Events/AvatarWillBeDeleted.php → framework/core/src/Events/AvatarWillBeDeleted.php
View File

@ -1,4 +1,4 @@
<?php namespace Flarum\Core\Users\Events;
<?php namespace Flarum\Events;
use Flarum\Core\Users\User;

2
framework/core/src/Core/Users/Events/AvatarWillBeSaved.php → framework/core/src/Events/AvatarWillBeSaved.php
View File

@ -1,4 +1,4 @@
<?php namespace Flarum\Core\Users\Events;
<?php namespace Flarum\Events;
use Flarum\Core\Users\User;

70
framework/core/src/Events/BuildApiAction.php Normal file
View File

@ -0,0 +1,70 @@
<?php namespace Flarum\Events;
use Flarum\Api\Actions\SerializeAction;
class BuildApiAction
{
protected $action;
/**
* @param SerializeAction $action
*/
public function __construct($action)
{
$this->action = $action;
}
public function serializer($serializer)
{
$this->action->serializer = $serializer;
}
public function addInclude($relation, $default = true)
{
$this->action->include[$relation] = $default;
}
public function removeInclude($relation)
{
unset($this->action->include[$relation]);
}
public function addLink($relation)
{
$this->action->link[] = $relation;
}
public function removeLink($relation)
{
if (($k = array_search($relation, $this->action->link)) !== false) {
unset($this->action->link[$k]);
}
}
public function limitMax($limitMax)
{
$this->action->limitMax = $limitMax;
}
public function limit($limit)
{
$this->action->limit = $limit;
}
public function addSortField($field)
{
$this->action->sortFields[] = $field;
}
public function removeSortField($field)
{
if (($k = array_search($field, $this->action->sortFields)) !== false) {
unset($this->action->sortFields[$k]);
}
}
public function sort($sort)
{
$this->action->sort = $sort;
}
}

34
framework/core/src/Events/BuildClientView.php Normal file
View File

@ -0,0 +1,34 @@
<?php namespace Flarum\Events;
use Flarum\Support\ClientAction;
use Flarum\Support\ClientView;
class BuildClientView
{
/**
* @var ClientAction
*/
protected $action;
/**
* @var ClientView
*/
protected $view;
/**
* @var array
*/
protected $keys;
/**
* @param ClientAction $action
* @param ClientView $view
* @param array $keys
*/
public function __construct($action, $view, &$keys)
{
$this->action = $action;
$this->view = $view;
$this->keys = &$keys;
}
}

2
framework/core/src/Core/Discussions/Events/DiscussionSearchWillBePerformed.php → framework/core/src/Events/DiscussionSearchWillBePerformed.php
View File

@ -1,4 +1,4 @@
<?php namespace Flarum\Core\Discussions\Events;
<?php namespace Flarum\Events;
use Flarum\Core\Discussions\Search\DiscussionSearch;
use Flarum\Core\Search\SearchCriteria;

2
framework/core/src/Core/Discussions/Events/DiscussionStateWillBeSaved.php → framework/core/src/Events/DiscussionStateWillBeSaved.php
View File

@ -1,4 +1,4 @@
<?php namespace Flarum\Core\Discussions\Events;
<?php namespace Flarum\Events;
use Flarum\Core\Discussions\DiscussionState;

2
framework/core/src/Core/Discussions/Events/DiscussionWasDeleted.php → framework/core/src/Events/DiscussionWasDeleted.php
View File

@ -1,4 +1,4 @@
<?php namespace Flarum\Core\Discussions\Events;
<?php namespace Flarum\Events;
use Flarum\Core\Discussions\Discussion;
use Flarum\Core\Users\User;

2
framework/core/src/Core/Discussions/Events/DiscussionWasRead.php → framework/core/src/Events/DiscussionWasRead.php
View File

@ -1,4 +1,4 @@
<?php namespace Flarum\Core\Discussions\Events;
<?php namespace Flarum\Events;
use Flarum\Core\Discussions\DiscussionState;

2
framework/core/src/Core/Discussions/Events/DiscussionWasRenamed.php → framework/core/src/Events/DiscussionWasRenamed.php
View File

@ -1,4 +1,4 @@
<?php namespace Flarum\Core\Discussions\Events;
<?php namespace Flarum\Events;
use Flarum\Core\Discussions\Discussion;
use Flarum\Core\Users\User;

2
framework/core/src/Core/Discussions/Events/DiscussionWasStarted.php → framework/core/src/Events/DiscussionWasStarted.php
View File

@ -1,4 +1,4 @@
<?php namespace Flarum\Core\Discussions\Events;
<?php namespace Flarum\Events;
use Flarum\Core\Discussions\Discussion;

2
framework/core/src/Core/Discussions/Events/DiscussionWillBeDeleted.php → framework/core/src/Events/DiscussionWillBeDeleted.php
View File

@ -1,4 +1,4 @@
<?php namespace Flarum\Core\Discussions\Events;
<?php namespace Flarum\Events;
use Flarum\Core\Discussions\Discussion;
use Flarum\Core\Users\User;

2
framework/core/src/Core/Discussions/Events/DiscussionWillBeSaved.php → framework/core/src/Events/DiscussionWillBeSaved.php
View File

@ -1,4 +1,4 @@
<?php namespace Flarum\Core\Discussions\Events;
<?php namespace Flarum\Events;
use Flarum\Core\Discussions\Discussion;
use Flarum\Core\Users\User;

37
framework/core/src/Events/ModelAllow.php Normal file
View File

@ -0,0 +1,37 @@
<?php namespace Flarum\Events;
use Flarum\Core\Model;
use Flarum\Core\Users\User;
/**
* The `ModelAllow` event
*/
class ModelAllow
{
/**
* @var Model
*/
public $model;
/**
* @var array
*/
public $actor;
/**
* @var string
*/
public $action;
/**
* @param Model $model
* @param User $actor
* @param $action
*/
public function __construct(Model $model, User $actor, $action)
{
$this->model = $model;
$this->actor = $actor;
$this->action = $action;
}
}

30
framework/core/src/Events/ModelDates.php Normal file
View File

@ -0,0 +1,30 @@
<?php namespace Flarum\Events;
use Flarum\Core\Model;
/**
* The `ModelDates` event is called to retrieve a list of fields for a model
* that should be converted into date objects.
*/
class ModelDates
{
/**
* @var Model
*/
public $model;
/**
* @var array
*/
public $dates;
/**
* @param Model $model
* @param array $dates
*/
public function __construct(Model $model, array &$dates)
{
$this->model = $model;
$this->dates = &$dates;
}
}

30
framework/core/src/Events/ModelRelationship.php Normal file
View File

@ -0,0 +1,30 @@
<?php namespace Flarum\Events;
use Flarum\Core\Model;
/**
* The `ModelRelationship` event is called to retrieve Relation object for a
* model. Listeners should return an Eloquent Relation object.
*/
class ModelRelationship
{
/**
* @var Model
*/
public $model;
/**
* @var string
*/
public $relationship;
/**
* @param Model $model
* @param string $relationship
*/
public function __construct(Model $model, $relationship)
{
$this->model = $model;
$this->relationship = $relationship;
}
}

32
framework/core/src/Events/ModelValidator.php Normal file
View File

@ -0,0 +1,32 @@
<?php namespace Flarum\Events;
use Flarum\Core\Model;
use Illuminate\Validation\Validator;
/**
* The `ModelValidator` event is called when a validator instance for a
* model is being built. This event can be used to add custom rules/extensions
* to the validator for when validation takes place.
*/
class ModelValidator
{
/**
* @var Model
*/
public $model;
/**
* @var Validator
*/
public $validator;
/**
* @param Model $model
* @param Validator $validator
*/
public function __construct(Model $model, Validator $validator)
{
$this->model = $model;
$this->validator = $validator;
}
}

2
framework/core/src/Core/Notifications/Events/NotificationWillBeSent.php → framework/core/src/Events/NotificationWillBeSent.php
View File

@ -1,4 +1,4 @@
<?php namespace Flarum\Core\Notifications\Events;
<?php namespace Flarum\Events;
use Flarum\Core\Notifications\Blueprint;

2
framework/core/src/Core/Posts/Events/PostWasDeleted.php → framework/core/src/Events/PostWasDeleted.php
View File

@ -1,4 +1,4 @@
<?php namespace Flarum\Core\Posts\Events;
<?php namespace Flarum\Events;
use Flarum\Core\Posts\Post;

2
framework/core/src/Core/Posts/Events/PostWasHidden.php → framework/core/src/Events/PostWasHidden.php
View File

@ -1,4 +1,4 @@
<?php namespace Flarum\Core\Posts\Events;
<?php namespace Flarum\Events;
use Flarum\Core\Posts\CommentPost;

2
framework/core/src/Core/Posts/Events/PostWasPosted.php → framework/core/src/Events/PostWasPosted.php
View File

@ -1,4 +1,4 @@
<?php namespace Flarum\Core\Posts\Events;
<?php namespace Flarum\Events;
use Flarum\Core\Posts\Post;

2
framework/core/src/Core/Posts/Events/PostWasRestored.php → framework/core/src/Events/PostWasRestored.php
View File

@ -1,4 +1,4 @@
<?php namespace Flarum\Core\Posts\Events;
<?php namespace Flarum\Events;
use Flarum\Core\Posts\CommentPost;

2
framework/core/src/Core/Posts/Events/PostWasRevised.php → framework/core/src/Events/PostWasRevised.php
View File

@ -1,4 +1,4 @@
<?php namespace Flarum\Core\Posts\Events;
<?php namespace Flarum\Events;
use Flarum\Core\Posts\CommentPost;

2
framework/core/src/Core/Posts/Events/PostWillBeDeleted.php → framework/core/src/Events/PostWillBeDeleted.php
View File

@ -1,4 +1,4 @@
<?php namespace Flarum\Core\Posts\Events;
<?php namespace Flarum\Events;
use Flarum\Core\Posts\Post;
use Flarum\Core\Users\User;

2
framework/core/src/Core/Posts/Events/PostWillBeSaved.php → framework/core/src/Events/PostWillBeSaved.php
View File

@ -1,4 +1,4 @@
<?php namespace Flarum\Core\Posts\Events;
<?php namespace Flarum\Events;
use Flarum\Core\Posts\Post;
use Flarum\Core\Users\User;

35
framework/core/src/Events/RegisterActivityTypes.php Normal file
View File

@ -0,0 +1,35 @@
<?php namespace Flarum\Events;
use InvalidArgumentException;
use ReflectionClass;
class RegisterActivityTypes
{
/**
* @var array
*/
protected $blueprints;
/**
* @var array
*/
protected $serializers;
public function __construct(array &$blueprints, array &$serializers = [])
{
$this->blueprints = &$blueprints;
$this->serializers = &$serializers;
}
public function register($blueprint, $serializer)
{
if (! (new ReflectionClass($blueprint))->implementsInterface('Flarum\Core\Activity\Blueprint')) {
throw new InvalidArgumentException('Activity blueprint ' . $blueprint
. ' must implement Flarum\Core\Activity\Blueprint');
}
$this->blueprints[] = $blueprint;
$this->serializers[$blueprint::getType()] = $serializer;
}
}

19
framework/core/src/Events/RegisterApiRoutes.php Normal file
View File

@ -0,0 +1,19 @@
<?php namespace Flarum\Events;
use Flarum\Http\RouteCollection;
class RegisterApiRoutes
{
/**
* @var RouteCollection
*/
public $routes;
/**
* @param RouteCollection $routes
*/
public function __construct(RouteCollection $routes)
{
$this->routes = $routes;
}
}

19
framework/core/src/Events/RegisterDiscussionGambits.php Normal file
View File

@ -0,0 +1,19 @@
<?php namespace Flarum\Events;
use Flarum\Core\Search\GambitManager;
class RegisterDiscussionGambits
{
/**
* @var GambitManager
*/
public $gambits;
/**
* @param GambitManager $gambits
*/
public function __construct(GambitManager $gambits)
{
$this->gambits = $gambits;
}
}

19
framework/core/src/Events/RegisterForumRoutes.php Normal file
View File

@ -0,0 +1,19 @@
<?php namespace Flarum\Events;
use Flarum\Http\RouteCollection;
class RegisterForumRoutes
{
/**
* @var RouteCollection
*/
public $routes;
/**
* @param RouteCollection $routes
*/
public function __construct(RouteCollection $routes)
{
$this->routes = $routes;
}
}

19
framework/core/src/Events/RegisterLocales.php Normal file
View File

@ -0,0 +1,19 @@
<?php namespace Flarum\Events;
use Flarum\Locale\LocaleManager;
class RegisterLocales
{
/**
* @var LocaleManager
*/
public $manager;
/**
* @param LocaleManager $manager
*/
public function __construct(LocaleManager $manager)
{
$this->manager = $manager;
}
}

35
framework/core/src/Events/RegisterNotificationTypes.php Normal file
View File

@ -0,0 +1,35 @@
<?php namespace Flarum\Events;
use InvalidArgumentException;
use ReflectionClass;
class RegisterNotificationTypes
{
/**
* @var array
*/
protected $blueprints;
/**
* @var array
*/
protected $serializers;
public function __construct(array &$blueprints, array &$serializers = [])
{
$this->blueprints = &$blueprints;
$this->serializers = &$serializers;
}
public function register($blueprint, $serializer, $enabledByDefault = [])
{
if (! (new ReflectionClass($blueprint))->implementsInterface('Flarum\Core\Notifications\Blueprint')) {
throw new InvalidArgumentException('Notification blueprint ' . $blueprint
. ' must implement Flarum\Core\Notifications\Blueprint');
}
$this->blueprints[$blueprint] = $enabledByDefault;
$this->serializers[$blueprint::getType()] = $serializer;
}
}

16
framework/core/src/Events/RegisterPostTypes.php Normal file
View File

@ -0,0 +1,16 @@
<?php namespace Flarum\Events;
class RegisterPostTypes
{
protected $models;
public function __construct(array &$models)
{
$this->models = &$models;
}
public function register($class)
{
$this->models[] = $class;
}
}

27
framework/core/src/Events/RegisterUserGambits.php Normal file
View File

@ -0,0 +1,27 @@
<?php namespace Flarum\Events;
use Flarum\Core\Search\GambitManager;
class RegisterUserGambits
{
/**
* @var GambitManager
*/
protected $gambits;
/**
* @param GambitManager $gambits
*/
public function __construct(GambitManager $gambits)
{
$this->gambits = $gambits;
}
/**
* @param string $gambit
*/
public function register($gambit)
{
$this->gambits->add($gambit);
}
}

11
framework/core/src/Events/RegisterUserPreferences.php Normal file
View File

@ -0,0 +1,11 @@
<?php namespace Flarum\Events;
use Flarum\Core\Users\User;
class RegisterUserPreferences
{
public function register($key, callable $transformer = null, $default = null)
{
User::addPreference($key, $transformer, $default);
}
}

39
framework/core/src/Events/ScopeModelVisibility.php Normal file
View File

@ -0,0 +1,39 @@
<?php namespace Flarum\Events;
use Flarum\Core\Model;
use Flarum\Core\Users\User;
use Illuminate\Database\Eloquent\Builder;
/**
* The `ScopeModelVisibility` event allows constraints to be applied in a query
* to fetch a model, effectively scoping that model's visibility to the user.
*/
class ScopeModelVisibility
{
/**
* @var Model
*/
public $model;
/**
* @var Builder
*/
public $query;
/**
* @var User
*/
public $actor;
/**
* @param Model $model
* @param Builder $query
* @param User $actor
*/
public function __construct(Model $model, Builder $query, User $actor)
{
$this->model = $model;
$this->query = $query;
$this->actor = $actor;
}
}

38
framework/core/src/Events/ScopePostVisibility.php Normal file
View File

@ -0,0 +1,38 @@
<?php namespace Flarum\Events;
use Flarum\Core\Discussions\Discussion;
use Flarum\Core\Users\User;
use Illuminate\Database\Eloquent\Builder;
/**
* The `ScopePostVisibility` event
*/
class ScopePostVisibility
{
/**
* @var Discussion
*/
public $discussion;
/**
* @var Builder
*/
public $query;
/**
* @var User
*/
public $actor;
/**
* @param Discussion $discussion
* @param Builder $query
* @param User $actor
*/
public function __construct(Discussion $discussion, Builder $query, User $actor)
{
$this->discussion = $discussion;
$this->query = $query;
$this->actor = $actor;
}
}

Some files were not shown because too many files have changed in this diff Show More