Merge branch 'release2.11.0'

Author: RicLeP

src/Block.php

@@ -124,14 +124,15 @@ public function page() {
 	}
 
 	/**
-	 * Returns the first matching view, passing it the fields
+	 * Returns the first matching view, passing it the Block and optional data
 	 *
+	 * @param array $with
 	 * @return View
 	 * @throws UnableToRenderException
 	 */
-	public function render() {
+	public function render($with = []) {
 		try {
-			return view()->first($this->views(), ['block' => $this]);
+			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);
 		}
@@ -266,8 +267,7 @@ private function processFields() {
 	 * @throws \Storyblok\ApiException
 	 */
 	private function getFieldType($field, $key) {
-		$factory = new FieldFactory();
-		return $factory->build($this, $field, $key);
+		return (new FieldFactory())->build($this, $field, $key);
 	}
 
 	/**

src/Field.php

@@ -21,6 +21,15 @@ abstract class Field
 	 */
 	protected $block;
 
+
+	/**
+	 * Key/value pairs of additional content you want the
+	 * field to have access to. Pass anything you like
+	 *
+	 * @var array
+	 */
+	public $with;
+
 	/**
 	 * Creates the new field taking it’s content and a reference
 	 * to the parent Block
@@ -38,18 +47,56 @@ public function __construct($content, $block)
 		}
 	}
 
+	/**
+	 * Returns the content of the Field
+	 *
+	 * @return array|string
+	 */
 	public function content() {
 		return $this->content;
 	}
 
+	/**
+	 * Returns the Block this Field belongs to
+	 *
+	 * @return Block
+	 */
 	public function block() {
 		return $this->block;
 	}
 
+	/**
+	 * Checks if the requested key is in the Field’s content
+	 *
+	 * @param $key
+	 * @return bool
+	 */
 	public function has($key) {
 		return array_key_exists($key, $this->content);
 	}
 
+
+	/**
+	 * Allows key/value pairs to be passed into the Field such as CSS
+	 * classes when rendering __toString or another content.
+	 * Example: {{ $field->with(['classes' => 'my-class']) }}
+	 *
+	 * @param $with
+	 * @return Field
+	 */
+	public function with($with) {
+		$this->with = $with;
+
+		return $this;
+	}
+
+	/**
+	 * Magic accessor to pull content from the content. Works just like
+	 * Laravel’s model accessors.
+	 *
+	 * @param $key
+	 * @return false|mixed|string
+	 */
 	public function __get($key) {
 		$accessor = 'get' . Str::studly($key) . 'Attribute';
 
@@ -68,5 +115,10 @@ public function __get($key) {
 		}
 	}
 
+	/**
+	 * Prints the Field as a string
+	 *
+	 * @return string
+	 */
 	abstract public function __toString();
 }

src/Folder.php

@@ -41,7 +41,7 @@ abstract class Folder
 	/**
 	 * @var int number of items to return
 	 */
-	protected $perPage = 10;
+	protected $perPage;
 
 
 	/**

tests/FieldTest.php

@@ -20,6 +20,7 @@
 use Riclep\Storyblok\Tests\Fixtures\Fields\AssetWithAccessor;
 use Riclep\Storyblok\Tests\Fixtures\Fields\HeroImage;
 use Riclep\Storyblok\Tests\Fixtures\Fields\Imgix;
+use Riclep\Storyblok\Tests\Fixtures\Fields\WithImage;
 
 class FieldTest extends TestCase
 {
@@ -764,4 +765,25 @@ public function can_set_focal_point()
 		$this->assertEquals('right bottom', $field4->focalPointAlignment('center', true));
 	}
 
+
+	/** @test */
+	public function can_add_with_content()
+	{
+		// default
+		$field = new WithImage(json_decode(
+			'{
+				"id": 1223942,
+				"alt": null,
+				"name": "",
+				"focus": "",
+				"title": null,
+				"filename": "https://a.storyblok.com/f/96945/100x100/c55f649622/2020-ar-fusionacusoft-letterbox-2.jpg",
+				"copyright": null,
+				"fieldtype": "asset"
+			}', true
+		), null);
+
+		$this->assertEquals('<img src="https://a.storyblok.com/f/96945/100x100/c55f649622/2020-ar-fusionacusoft-letterbox-2.jpg class="some-class">', (string) $field->with(['class' => 'some-class']));
+	}
+
 }

tests/Fixtures/Fields/WithImage.php

@@ -0,0 +1,19 @@
+<?php
+
+
+namespace Riclep\Storyblok\Tests\Fixtures\Fields;
+
+
+use Riclep\Storyblok\Fields\Image;
+
+class WithImage extends Image
+{
+	public function __toString()
+	{
+		if ($this->content['filename']) {
+			return '<img src="' . $this->content['filename'] . ' class="' . $this->with['class'] . '">';
+		}
+
+		return '';
+	}
+}