1
0

downgrade to kirby v3

This commit is contained in:
Philip Wagner
2024-09-01 10:47:15 +02:00
parent a4b2aece7b
commit af86acb7a1
1085 changed files with 54743 additions and 65042 deletions

View File

@@ -2,8 +2,6 @@
namespace Kirby\Cms;
use Kirby\Content\Content;
use Kirby\Content\Field;
use Kirby\Exception\InvalidArgumentException;
use Kirby\Toolkit\Str;
use Throwable;
@@ -24,21 +22,38 @@ class Block extends Item
{
use HasMethods;
public const ITEMS_CLASS = Blocks::class;
public const ITEMS_CLASS = '\Kirby\Cms\Blocks';
/**
* @var \Kirby\Cms\Content
*/
protected $content;
/**
* @var bool
*/
protected $isHidden;
/**
* Registry with all block models
*
* @var array
*/
public static array $models = [];
public static $models = [];
protected Content $content;
protected bool $isHidden;
protected string $type;
/**
* @var string
*/
protected $type;
/**
* Proxy for content fields
*
* @param string $method
* @param array $args
* @return \Kirby\Cms\Field
*/
public function __call(string $method, array $args = []): mixed
public function __call(string $method, array $args = [])
{
// block methods
if ($this->hasMethod($method)) {
@@ -51,19 +66,13 @@ class Block extends Item
/**
* Creates a new block object
*
* @param array $params
* @throws \Kirby\Exception\InvalidArgumentException
*/
public function __construct(array $params)
{
parent::__construct($params);
// @deprecated import old builder format
// @todo block.converter remove eventually
// @codeCoverageIgnoreStart
$params = BlockConverter::builderBlock($params);
$params = BlockConverter::editorBlock($params);
// @codeCoverageIgnoreEnd
if (isset($params['type']) === false) {
throw new InvalidArgumentException('The block type is missing');
}
@@ -74,15 +83,18 @@ class Block extends Item
$params['content'] = [];
}
$this->content = $params['content'];
$this->isHidden = $params['isHidden'] ?? false;
$this->type = $params['type'];
// create the content object
$this->content = new Content($params['content'], $this->parent);
$this->content = new Content($this->content, $this->parent);
}
/**
* Converts the object to a string
*
* @return string
*/
public function __toString(): string
{
@@ -91,14 +103,18 @@ class Block extends Item
/**
* Returns the content object
*
* @return \Kirby\Cms\Content
*/
public function content(): Content
public function content()
{
return $this->content;
}
/**
* Controller for the block snippet
*
* @return array
*/
public function controller(): array
{
@@ -117,38 +133,40 @@ class Block extends Item
* Converts the block to HTML and then
* uses the Str::excerpt method to create
* a non-formatted, shortened excerpt from it
*
* @param mixed ...$args
* @return string
*/
public function excerpt(mixed ...$args): string
public function excerpt(...$args)
{
return Str::excerpt($this->toHtml(), ...$args);
}
/**
* Constructs a block object with registering blocks models
* @internal
*
* @param array $params
* @return static
* @throws \Kirby\Exception\InvalidArgumentException
* @internal
*/
public static function factory(array $params): static
public static function factory(array $params)
{
$type = $params['type'] ?? null;
if (
empty($type) === false &&
$class = (static::$models[$type] ?? null)
) {
if (empty($type) === false && $class = (static::$models[$type] ?? null)) {
$object = new $class($params);
if ($object instanceof self) {
if (is_a($object, 'Kirby\Cms\Block') === true) {
return $object;
}
}
// default model for blocks
if ($class = (static::$models['default'] ?? null)) {
if ($class = (static::$models['Kirby\Cms\Block'] ?? null)) {
$object = new $class($params);
if ($object instanceof self) {
if (is_a($object, 'Kirby\Cms\Block') === true) {
return $object;
}
}
@@ -158,6 +176,8 @@ class Block extends Item
/**
* Checks if the block is empty
*
* @return bool
*/
public function isEmpty(): bool
{
@@ -167,6 +187,8 @@ class Block extends Item
/**
* Checks if the block is hidden
* from being rendered in the frontend
*
* @return bool
*/
public function isHidden(): bool
{
@@ -175,6 +197,8 @@ class Block extends Item
/**
* Checks if the block is not empty
*
* @return bool
*/
public function isNotEmpty(): bool
{
@@ -183,14 +207,18 @@ class Block extends Item
/**
* Returns the sibling collection that filtered by block status
*
* @return \Kirby\Cms\Collection
*/
protected function siblingsCollection(): Blocks
protected function siblingsCollection()
{
return $this->siblings->filter('isHidden', $this->isHidden());
}
/**
* Returns the block type
*
* @return string
*/
public function type(): string
{
@@ -200,6 +228,8 @@ class Block extends Item
/**
* The result is being sent to the editor
* via the API in the panel
*
* @return array
*/
public function toArray(): array
{
@@ -216,24 +246,24 @@ class Block extends Item
* and then places that inside a field
* object. This can be used further
* with all available field methods
*
* @return \Kirby\Cms\Field
*/
public function toField(): Field
public function toField()
{
return new Field($this->parent(), $this->id(), $this->toHtml());
}
/**
* Converts the block to HTML
*
* @return string
*/
public function toHtml(): string
{
try {
$kirby = $this->parent()->kirby();
return (string)$kirby->snippet(
'blocks/' . $this->type(),
$this->controller(),
true
);
return (string)$kirby->snippet('blocks/' . $this->type(), $this->controller(), true);
} catch (Throwable $e) {
if ($kirby->option('debug') === true) {
return '<p>Block error: "' . $e->getMessage() . '" in block type: "' . $this->type() . '"</p>';