Merge branch 'release2.17.0'

Author: RicLeP

.idea/laravel-storyblok.iml

@@ -34,7 +34,8 @@
     "require-dev": {
         "mockery/mockery": "^1.2",
         "orchestra/testbench": "7.0.*",
-        "phpunit/phpunit": "^9.0"
+        "phpunit/phpunit": "^9.0",
+	    "spatie/laravel-ignition": "^1.6"
     },
     "autoload": {
         "psr-4": {

.idea/php.xml

@@ -28,37 +28,37 @@ class Block implements \IteratorAggregate, \JsonSerializable
 	/**
 	 * @var bool resolve UUID relations automatically
 	 */
-	public $_autoResolveRelations = false;
+	public bool $_autoResolveRelations = false;
 
 	/**
 	 * @var array list of field names containing relations to resolve
 	 */
-	public $_resolveRelations = [];
+	public array $_resolveRelations = [];
 
 	/**
 	 * @var bool Remove unresolved relations such as those that 404
 	 */
-	public $_filterRelations = true;
+	public bool $_filterRelations = true;
 
 	/**
 	 * @var array the path of nested components
 	 */
-	public $_componentPath = [];
+	public array $_componentPath = [];
 
 	/**
 	 * @var array the path of nested components
 	 */
-	protected $_casts = [];
+	protected array $_casts = [];
 
 	/**
 	 * @var Collection all the fields for the Block
 	 */
-	private $_fields;
+	private Collection $_fields;
 
 	/**
 	 * @var Page|Block reference to the parent Block or Page
 	 */
-	private $_parent;
+	private mixed $_parent;
 
 	/**
 	 * Takes the Block’s content and a reference to the parent
@@ -93,7 +93,8 @@ public function __construct($content, $parent = null)
 	 *
 	 * @return Collection
 	 */
-	public function content() {
+	public function content(): Collection
+	{
 		return $this->_fields;
 	}
 
@@ -103,7 +104,8 @@ public function content() {
 	 * @param $key
 	 * @return bool
 	 */
-	public function has($key) {
+	public function has($key): bool
+	{
 		return $this->_fields->has($key);
 	}
 
@@ -115,7 +117,8 @@ public function has($key) {
 	 * @param $component
 	 * @return boolean
 	 */
-	public function hasChildBlock($field, $component) {
+	public function hasChildBlock($field, $component): bool
+	{
 		return $this->content()[$field]->contains(function($item) use ($component) {
 			return $item->meta('component') === $component;
 		});
@@ -126,7 +129,8 @@ public function hasChildBlock($field, $component) {
 	 *
 	 * @return Block
 	 */
-	public function parent() {
+	public function parent(): Block|Page|null
+	{
 		return $this->_parent;
 	}
 
@@ -135,7 +139,8 @@ public function parent() {
 	 *
 	 * @return Block
 	 */
-	public function page() {
+	public function page(): Block|Page|null
+	{
 		if ($this->parent() instanceof Page) {
 			return $this->parent();
 		}
@@ -150,12 +155,9 @@ public function page() {
 	 * @return View
 	 * @throws UnableToRenderException
 	 */
-	public function render($with = []) {
-		try {
-			return view()->first($this->views(), array_merge(['block' => $this], $with));
-		} catch (\Exception $exception) {
-			throw new UnableToRenderException('None of the views in the given array exist.', $this);
-		}
+	public function render(array $with = []): View
+	{
+		return $this->renderUsing($this->views(), $with);
 	}
 
 	/**
@@ -166,7 +168,8 @@ public function render($with = []) {
 	 * @return View
 	 * @throws UnableToRenderException
 	 */
-	public function renderUsing($views, $with = []) {
+	public function renderUsing(array|string $views, array $with = []): View
+	{
 		try {
 			return view()->first(Arr::wrap($views), array_merge(['block' => $this], $with));
 		} catch (\Exception $exception) {
@@ -189,13 +192,14 @@ public function renderUsing($views, $with = []) {
 	 *
 	 * @return array
 	 */
-	public function views() {
-		$compontentPath = $this->_componentPath;
-		array_pop($compontentPath);
+	public function views(): array
+	{
+		$componentPath = $this->_componentPath;
+		array_pop($componentPath);
 
 		$views = array_map(function($path) {
 			return config('storyblok.view_path') . 'blocks.' . $path . '.' . $this->component();
-		}, $compontentPath);
+		}, $componentPath);
 
 		$views = array_reverse($views);
 
@@ -210,7 +214,7 @@ public function views() {
 	 * @param $generation int
 	 * @return mixed
 	 */
-	public function ancestorComponentName($generation)
+	public function ancestorComponentName(int $generation): mixed
 	{
 		return $this->_componentPath[count($this->_componentPath) - ($generation + 1)];
 	}
@@ -221,7 +225,7 @@ public function ancestorComponentName($generation)
 	 * @param $parent string
 	 * @return bool
 	 */
-	public function isChildOf($parent)
+	public function isChildOf(string $parent): bool
 	{
 		return $this->_componentPath[count($this->_componentPath) - 2] === $parent;
 	}
@@ -232,17 +236,18 @@ public function isChildOf($parent)
 	 * @param $parent string
 	 * @return bool
 	 */
-	public function isAncestorOf($parent)
+	public function isAncestorOf(string $parent): bool
 	{
-		return in_array($parent, $this->parent()->_componentPath);
+		return in_array($parent, $this->parent()->_componentPath, true);
 	}
 
 	/**
 	 * Returns the current Block’s component name from Storyblok
 	 *
 	 * @return string
 	 */
-	public function component() {
+	public function component(): string
+	{
 		return $this->_meta['component'];
 	}
 
@@ -254,7 +259,8 @@ public function component() {
 	 *
 	 * @return string
 	 */
-	public function editorLink() {
+	public function editorLink(): string
+	{
 		if (array_key_exists('_editable', $this->_meta) && config('storyblok.edit_mode')) {
 			return $this->_meta['_editable'];
 		}
@@ -290,17 +296,17 @@ public function __get($key) {
 	 *
 	 * @return string
 	 */
-	public function __toString() {
+	public function __toString(): string
+	{
 		return (string) $this->jsonSerialize();
 	}
 
 	/**
 	 * Loops over every field to get the ball rolling
 	 */
-	private function processFields() {
-		$this->_fields->transform(function ($field, $key) {
-			return $this->getFieldType($field, $key);
-		});
+	private function processFields(): void
+	{
+		$this->_fields->transform(fn($field, $key) => $this->getFieldType($field, $key));
 	}
 
 	/**
@@ -311,7 +317,8 @@ private function processFields() {
 	 * @return array|Collection|mixed|Asset|Image|MultiAsset|RichText|Table
 	 * @throws \Storyblok\ApiException
 	 */
-	private function getFieldType($field, $key) {
+	private function getFieldType($field, $key): mixed
+	{
 		return (new FieldFactory())->build($this, $field, $key);
 	}
 
@@ -321,7 +328,8 @@ private function getFieldType($field, $key) {
 	 *
 	 * @param $content
 	 */
-	private function preprocess($content) {
+	private function preprocess($content): void
+	{
 		// run pre-process traits - methods matching preprocessTraitClassName()
 		foreach (class_uses_recursive($this) as $trait) {
 			if (method_exists($this, $method = 'preprocess' . class_basename($trait))) {
@@ -357,11 +365,23 @@ public function getIterator(): \Traversable {
 		return $this->_fields;
 	}
 
-	public function getRelation(RequestStory $request, $relation) {
+	/**
+	 * @param RequestStory $requestStory
+	 * @param $relation
+	 * @param $className
+	 * @return mixed|null
+	 */
+	public function getRelation(RequestStory $requestStory, $relation, $className = null): mixed
+	{
 		try {
-			$response = $request->get($relation);
+			$response = $requestStory->get($relation);
+
+			if (!$className) {
+				$class = $this->getChildClassName('Block', $response['content']['component']);
+			} else {
+				$class = $className;
+			}
 
-			$class = $this->getChildClassName('Block', $response['content']['component']);
 			$relationClass = new $class($response['content'], $this);
 
 			$relationClass->addMeta([
@@ -381,13 +401,14 @@ public function getRelation(RequestStory $request, $relation) {
 	 * Returns an inverse relationship to the current Block. For example if Service has a Multi-Option field
 	 * relationship to People, on People you can request all the Services it has been related to
 	 *
-	 * @param $foreignRelationshipField
-	 * @param $foreignRelationshipType
-	 * @param $components
-	 * @param $options
+	 * @param string $foreignRelationshipField
+	 * @param string $foreignRelationshipType
+	 * @param array|null $components
+	 * @param array|null $options
 	 * @return array
 	 */
-	public function inverseRelation($foreignRelationshipField, $foreignRelationshipType = 'multi', $components = null, $options = null) {
+	public function inverseRelation(string $foreignRelationshipField, string $foreignRelationshipType = 'multi', array $components = null, array $options = null): array
+	{
 		$storyblokClient = resolve('Storyblok\Client');
 
 		$type = 'any_in_array';
@@ -422,7 +443,13 @@ public function inverseRelation($foreignRelationshipField, $foreignRelationshipT
 		];
 	}
 
-	public function getCasts() {
+	/**
+	 * Returns the casts on this Block
+	 *
+	 * @return array
+	 */
+	public function getCasts(): array
+	{
 		return $this->_casts;
 	}
 }