hokusfocus/hocusfokus-web
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Upgrade to 4.0.0

Browse Source
This commit is contained in:
Bastian Allgeier
2023-11-28 09:33:56 +01:00
parent f96b96af76
commit 3b0b6546ca
480 changed files with 21371 additions and 13327 deletions
Download Patch File Download Diff File Expand all files Collapse all files

255
kirby/src/Api/Api.php
View File

@@ -14,7 +14,6 @@ use Kirby\Http\Router;
use Kirby\Toolkit\Collection as BaseCollection;
use Kirby\Toolkit\I18n;
use Kirby\Toolkit\Pagination;
use Kirby\Toolkit\Properties;
use Kirby\Toolkit\Str;
use Throwable;
@@ -32,8 +31,6 @@ use Throwable;
*/
class Api
{
use Properties;
/**
* Authentication callback
*/
@@ -86,6 +83,28 @@ class Api
*/
protected string|null $requestMethod = null;
/**
* Creates a new API instance
*/
public function __construct(array $props)
{
$this->authentication = $props['authentication'] ?? null;
$this->data = $props['data'] ?? [];
$this->routes = $props['routes'] ?? [];
$this->debug = $props['debug'] ?? false;
if ($collections = $props['collections'] ?? null) {
$this->collections = array_change_key_case($collections);
}
if ($models = $props['models'] ?? null) {
$this->models = array_change_key_case($models);
}
$this->setRequestData($props['requestData'] ?? null);
$this->setRequestMethod($props['requestMethod'] ?? null);
}
/**
* Magic accessor for any given data
*
@@ -96,14 +115,6 @@ class Api
return $this->data($method, ...$args);
}
/**
* Creates a new API instance
*/
public function __construct(array $props)
{
$this->setProperties($props);
}
/**
* Runs the authentication method
* if set
@@ -115,8 +126,6 @@ class Api
/**
* Returns the authentication callback
*
* @return \Closure|null
*/
public function authentication(): Closure|null
{
@@ -130,8 +139,11 @@ class Api
* @throws \Kirby\Exception\NotFoundException
* @throws \Exception
*/
public function call(string|null $path = null, string $method = 'GET', array $requestData = [])
{
public function call(
string|null $path = null,
string $method = 'GET',
array $requestData = []
): mixed {
$path = rtrim($path ?? '', '/');
$this->setRequestMethod($method);
@@ -194,14 +206,34 @@ class Api
return $output;
}
/**
* Creates a new instance while
* merging initial and new properties
*/
public function clone(array $props = []): static
{
return new static(array_merge([
'autentication' => $this->authentication,
'data' => $this->data,
'routes' => $this->routes,
'debug' => $this->debug,
'collections' => $this->collections,
'models' => $this->models,
'requestData' => $this->requestData,
'requestMethod' => $this->requestMethod
], $props));
}
/**
* Setter and getter for an API collection
*
* @throws \Kirby\Exception\NotFoundException If no collection for `$name` exists
* @throws \Exception
*/
public function collection(string $name, array|BaseCollection|null $collection = null): Collection
{
public function collection(
string $name,
array|BaseCollection|null $collection = null
): Collection {
if (isset($this->collections[$name]) === false) {
throw new NotFoundException(sprintf('The collection "%s" does not exist', $name));
}
@@ -223,7 +255,7 @@ class Api
*
* @throws \Kirby\Exception\NotFoundException If no data for `$key` exists
*/
public function data(string|null $key = null, ...$args)
public function data(string|null $key = null, ...$args): mixed
{
if ($key === null) {
return $this->data;
@@ -264,8 +296,10 @@ class Api
* @param array models or collections
* @return string|null key of match
*/
protected function match(array $array, $object = null): string|null
{
protected function match(
array $array,
$object = null
): string|null {
foreach ($array as $definition => $model) {
if ($object instanceof $model['type']) {
return $definition;
@@ -280,8 +314,10 @@ class Api
*
* @throws \Kirby\Exception\NotFoundException If no model for `$name` exists
*/
public function model(string|null $name = null, $object = null): Model
{
public function model(
string|null $name = null,
$object = null
): Model {
// Try to auto-match object with API models
$name ??= $this->match($this->models, $object);
@@ -304,17 +340,12 @@ class Api
* Getter for request data
* Can either get all the data
* or certain parts of it.
*
* @param string|null $type
* @param string|null $key
* @param mixed $default
* @return mixed
*/
public function requestData(
string|null $type = null,
string|null $key = null,
$default = null
) {
mixed $default = null
): mixed {
if ($type === null) {
return $this->requestData;
}
@@ -332,24 +363,30 @@ class Api
/**
* Returns the request body if available
*/
public function requestBody(string|null $key = null, $default = null)
{
public function requestBody(
string|null $key = null,
mixed $default = null
): mixed {
return $this->requestData('body', $key, $default);
}
/**
* Returns the files from the request if available
*/
public function requestFiles(string|null $key = null, $default = null)
{
public function requestFiles(
string|null $key = null,
mixed $default = null
): mixed {
return $this->requestData('files', $key, $default);
}
/**
* Returns all headers from the request if available
*/
public function requestHeaders(string|null $key = null, $default = null)
{
public function requestHeaders(
string|null $key = null,
mixed $default = null
): mixed {
return $this->requestData('headers', $key, $default);
}
@@ -364,8 +401,10 @@ class Api
/**
* Returns the request query if available
*/
public function requestQuery(string|null $key = null, $default = null)
{
public function requestQuery(
string|null $key = null,
mixed $default = null
): mixed {
return $this->requestData('query', $key, $default);
}
@@ -403,102 +442,14 @@ class Api
return $this->routes;
}
/**
* Setter for the authentication callback
* @return $this
*/
protected function setAuthentication(Closure|null $authentication = null): static
{
$this->authentication = $authentication;
return $this;
}
/**
* Setter for the collections definition
* @return $this
*/
protected function setCollections(array|null $collections = null): static
{
if ($collections !== null) {
$this->collections = array_change_key_case($collections);
}
return $this;
}
/**
* Setter for the injected data
* @return $this
*/
protected function setData(array|null $data = null): static
{
$this->data = $data ?? [];
return $this;
}
/**
* Setter for the debug flag
* @return $this
*/
protected function setDebug(bool $debug = false): static
{
$this->debug = $debug;
return $this;
}
/**
* Setter for the model definitions
* @return $this
*/
protected function setModels(array|null $models = null): static
{
if ($models !== null) {
$this->models = array_change_key_case($models);
}
return $this;
}
/**
* Setter for the request data
* @return $this
*/
protected function setRequestData(array|null $requestData = null): static
{
$defaults = [
'query' => [],
'body' => [],
'files' => []
];
$this->requestData = array_merge($defaults, (array)$requestData);
return $this;
}
/**
* Setter for the request method
* @return $this
*/
protected function setRequestMethod(string|null $requestMethod = null): static
{
$this->requestMethod = $requestMethod ?? 'GET';
return $this;
}
/**
* Setter for the route definitions
* @return $this
*/
protected function setRoutes(array|null $routes = null): static
{
$this->routes = $routes ?? [];
return $this;
}
/**
* Renders the API call
*/
public function render(string $path, string $method = 'GET', array $requestData = [])
{
public function render(
string $path,
string $method = 'GET',
array $requestData = []
): mixed {
try {
$result = $this->call($path, $method, $requestData);
} catch (Throwable $e) {
@@ -619,6 +570,34 @@ class Api
return $result;
}
/**
* Setter for the request data
* @return $this
*/
protected function setRequestData(
array|null $requestData = []
): static {
$defaults = [
'query' => [],
'body' => [],
'files' => []
];
$this->requestData = array_merge($defaults, (array)$requestData);
return $this;
}
/**
* Setter for the request method
* @return $this
*/
protected function setRequestMethod(
string $requestMethod = null
): static {
$this->requestMethod = $requestMethod ?? 'GET';
return $this;
}
/**
* Upload helper method
*
@@ -627,8 +606,11 @@ class Api
*
* @throws \Exception If request has no files or there was an error with the upload
*/
public function upload(Closure $callback, bool $single = false, bool $debug = false): array
{
public function upload(
Closure $callback,
bool $single = false,
bool $debug = false
): array {
$trials = 0;
$uploads = [];
$errors = [];
@@ -668,8 +650,9 @@ class Api
try {
if ($upload['error'] !== 0) {
$errorMessage = $errorMessages[$upload['error']] ?? I18n::translate('upload.error.default');
throw new Exception($errorMessage);
throw new Exception(
$errorMessages[$upload['error']] ?? I18n::translate('upload.error.default')
);
}
// get the extension of the uploaded file
@@ -696,7 +679,9 @@ class Api
$debug === false &&
move_uploaded_file($upload['tmp_name'], $source) === false
) {
throw new Exception(I18n::translate('upload.error.cantMove'));
throw new Exception(
I18n::translate('upload.error.cantMove')
);
}
$data = $callback($source, $filename);

22
kirby/src/Api/Collection.php
View File

@@ -4,6 +4,7 @@ namespace Kirby\Api;
use Closure;
use Exception;
use Kirby\Toolkit\Collection as BaseCollection;
use Kirby\Toolkit\Str;
/**
@@ -20,23 +21,22 @@ use Kirby\Toolkit\Str;
*/
class Collection
{
protected Api $api;
protected $data;
protected $model;
protected $select = null;
protected $view;
protected string|null $model;
protected array|null $select = null;
protected string|null $view;
/**
* Collection constructor
*
* @throws \Exception
*/
public function __construct(Api $api, $data, array $schema)
{
$this->api = $api;
$this->data = $data;
$this->model = $schema['model'] ?? null;
$this->view = $schema['view'] ?? null;
public function __construct(
protected Api $api,
protected BaseCollection|array|null $data,
array $schema
) {
$this->model = $schema['model'] ?? null;
$this->view = $schema['view'] ?? null;
if ($data === null) {
if (($schema['default'] ?? null) instanceof Closure === false) {

17
kirby/src/Api/Model.php
View File

@@ -22,21 +22,20 @@ use Kirby\Toolkit\Str;
*/
class Model
{
protected Api $api;
protected $data;
protected $fields;
protected $select;
protected $views;
protected array $fields;
protected array|null $select;
protected array $views;
/**
* Model constructor
*
* @throws \Exception
*/
public function __construct(Api $api, $data, array $schema)
{
$this->api = $api;
$this->data = $data;
public function __construct(
protected Api $api,
protected object|array|string|null $data,
array $schema
) {
$this->fields = $schema['fields'] ?? [];
$this->select = $schema['select'] ?? null;
$this->views = $schema['views'] ?? [];