create interface for processor data #3463

cf2/Factories/Processor.php

@@ -22,7 +22,7 @@ class Processor implements ProcessorFactory
      * @param array $form Saved settings for this form
      * @param array $fields Processor settings field configuration
      *
-     * @return \Caldera_Forms_Processor_Get_Data
+     * @return \Caldera_Forms_Processor_Data
      */
     public function dataFactory(array $config,array $form,array $fields){
         return new \Caldera_Forms_Processor_Get_Data($config,$form,$fields);

processors/classes/data.php

@@ -0,0 +1,56 @@
+<?php
+
+/**
+ * Interface Caldera_Forms_Processor_Data
+ *
+ * Contract for Caldera_Forms_Processor_Get_Data
+ */
+interface Caldera_Forms_Processor_Data{
+    /**
+     * Add an error message to the errors property
+     *
+     * @param string $message Message for error
+     * @since 1.8.10
+     *
+     */
+    public function add_error($message);
+
+    /**
+     * Get the errors
+     *
+     * @return array|null
+     * @since 1.8.10
+     *
+     */
+    public function get_errors();
+
+    /**
+     * Get the values
+     *
+     * @return array|null
+     * @since 1.8.10
+     *
+     */
+    public function get_values();
+
+    /**
+     * Get prepared fields
+     *
+     * @return array|null
+     * @since 1.8.10
+     *
+     */
+    public function get_fields();
+
+    /**
+     * Get one value from the processor
+     *
+     * @param string $field Name of field
+     * @param mixed $default Optional. Default value to return if none set.
+     *
+     * @return mixed
+     * @since 1.8.10
+     *
+     */
+    public function get_value($field, $default = null);
+}

processors/classes/get_data.php

@@ -9,7 +9,7 @@
  * @copyright 2015 CalderaWP LLC
  */
 
-class Caldera_Forms_Processor_Get_Data {
+class Caldera_Forms_Processor_Get_Data implements Caldera_Forms_Processor_Data{
 
 	/**
 	 * The values from current submission