Object setters now have a require flag

Author: harm-less

src/PE/Encoder.php

@@ -249,6 +249,9 @@ protected function _decodeNode($nodeName, $nodeData, EncoderOptions $options, En
 					}
 					$variableIsset = isset($nodeDataItem[$variableId]);
 					$objectSetter = $objectSetterVariable->getObjectSetter();
+					if ($objectSetter->required() && !$variableIsset) {
+						throw new EncoderException(sprintf('Decoding failed because variable "%s" for node "%s" is required but isn\'t present in the node data.', $variableId, $nodeName));
+					}
 					if ($variableIsset || $objectSetter->alwaysExecute()) {
 						$objectSetter->apply($nodeInstance, $variableIsset ? $nodeDataItem[$variableId] : null);
 					}

src/PE/Variables/Types/ObjectSetter.php

@@ -14,8 +14,23 @@
  */
 final class ObjectSetter extends ObjectAccessor {
 
-	function __construct($method = null) {
+	private $required;
+
+	function __construct($method = null, $required = false) {
 		parent::__construct($method);
+
+		$this->required($required);
+	}
+
+	/**
+	 * @param null|bool $bool
+	 * @return bool
+	 */
+	public function required($bool = null) {
+		if ($bool !== null && is_bool($bool)) {
+			$this->required = $bool;
+		}
+		return (bool) $this->required;
 	}
 
 	/**

tests/PE/Nodes/Specials/RequiredVariableNode.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace PE\Nodes\Specials;
+
+use PE\Nodes\EncoderNode;
+use PE\Nodes\EncoderNodeVariable;
+
+class RequiredVariableNode extends EncoderNode {
+
+	function __construct() {
+		parent::__construct('required-variables', 'required-variable', '\\PE\\Samples\\Specials');
+
+		$thing = $this->addVariable(new EncoderNodeVariable('required'));
+		$thing->getObjectSetter()->required(true);
+	}
+}

tests/PE/Samples/Specials/RequiredVariable.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace PE\Samples\Specials;
+
+class RequiredVariable {
+
+	protected $required;
+
+	function setRequired($value) {
+		$this->required = $value;
+	}
+	function getRequired() {
+		return $this->required;
+	}
+}

tests/PE/Tests/EncoderTest.php

@@ -103,6 +103,16 @@ public function testEncodeDecodedSingleChild() {
 	}
 
 
+	public function testRequiredVariable() {
+		$this->setExpectedException('\\PE\\Exceptions\\EncoderException', 'Decoding failed because variable "required" for node "required-variable" is required but isn\'t present in the node data.');
+
+		$this->addRequireVariableNode();
+
+		$this->encoder()->decode(array(
+			'required-variable' => array()
+		));
+	}
+
 
 	public function testDecode() {
 		$this->addFarmNodes();

tests/PE/Tests/Samples.php

@@ -30,6 +30,7 @@
 use PE\Nodes\Specials\NonArrayGetterMethodOnPurposeNode;
 use PE\Nodes\Specials\OptionalVariablesNode;
 use PE\Nodes\Specials\RequiredConstructorVariablesNode;
+use PE\Nodes\Specials\RequiredVariableNode;
 use PE\Nodes\Specials\SingleChildNode;
 use PE\Nodes\Specials\VariableTypesNode;
 use PE\Samples\Erroneous\EncoderNodeLoader;
@@ -52,6 +53,7 @@
 use PE\Samples\Specials\NonArrayGetterMethodOnPurpose;
 use PE\Samples\Specials\AccessorMethodActionTypeNode;
 use PE\Samples\Specials\OptionalVariables;
+use PE\Samples\Specials\RequiredVariable;
 use PE\Samples\Specials\SingleChild;
 use PE\Samples\Specials\VariableTypes;
 
@@ -252,6 +254,13 @@ public function addEncoderNodeLoaderNode($overrideObjectFileName = true) {
 	}
 
 
+	public function getRequiredVariable() {
+		return new RequiredVariable();
+	}
+	public function addRequireVariableNode() {
+		return EncoderNode::addNode(new RequiredVariableNode());
+	}
+
 	public function getSingleChild() {
 		return new SingleChild();
 	}

tests/PE/Tests/Variables/Types/ObjectSetterTest.php

@@ -45,6 +45,17 @@ public function testGetMethod() {
 		$this->assertEquals('setVariableId', $objectSetter->getMethod());
 	}
 
+	public function testRequired() {
+		$objectSetter = $this->objectSetter();
+
+		$this->assertFalse($objectSetter->required());
+
+		$this->assertFalse($objectSetter->required(false));
+		$this->assertFalse($objectSetter->required());
+		$this->assertTrue($objectSetter->required(true));
+		$this->assertTrue($objectSetter->required());
+	}
+
 	public function testEncodeWithoutVariableGetterMethod() {
 		$this->setExpectedException('\\PE\\Exceptions\\VariableTypeException', 'Method "setNonExistent" does not exist for class "PE\Tests\Variables\Types\ObjectSetterTestObject');