add support for DatabaseSource new binding parsing and select expressions

src/Charcoal/Property/PropertyField.php

@@ -40,11 +40,21 @@ class PropertyField
      */
     private $extra;
 
+    /**
+     * @var mixed
+     */
+    private $selectExpressions;
+
     /**
      * @var mixed
      */
     private $val;
 
+    /**
+     * @var \Closure
+     */
+    private $parseBinding;
+
     /**
      * @var mixed
      */
@@ -86,9 +96,15 @@ public function setData(array $data)
         if (isset($data['extra'])) {
             $this->setExtra($data['extra']);
         }
+        if (isset($data['selectExpressions'])) {
+            $this->setSelectExpressions($data['selectExpressions']);
+        }
         if (isset($data['val'])) {
             $this->setVal($data['val']);
         }
+        if (isset($data['parseBinding'])) {
+            $this->setParseBinding($data['parseBinding']);
+        }
         if (isset($data['defaultVal'])) {
             $this->setDefaultVal($data['defaultVal']);
         }
@@ -247,6 +263,25 @@ public function sqlEncoding()
         return $this->sqlEncoding;
     }
 
+    /**
+     * @return array
+     */
+    public function selectExpressions()
+    {
+        return $this->selectExpressions;
+    }
+
+    /**
+     * @param mixed $selectExpressions SqlSelectExpressions for PropertyField.
+     * @return self
+     */
+    public function setSelectExpressions($selectExpressions)
+    {
+        $this->selectExpressions = $selectExpressions;
+
+        return $this;
+    }
+
     /**
      * @param  mixed $val The field value.
      * @return PropertyField Chainable
@@ -265,6 +300,25 @@ public function val()
         return $this->val;
     }
 
+    /**
+     * @return \Closure
+     */
+    public function parseBinding()
+    {
+        return $this->parseBinding;
+    }
+
+    /**
+     * @param \Closure $parseBinding ParseBinding for PropertyField.
+     * @return self
+     */
+    public function setParseBinding($parseBinding)
+    {
+        $this->parseBinding = $parseBinding;
+
+        return $this;
+    }
+
     /**
      * @param  mixed $defaultVal The default field value.
      * @return PropertyField Chainable

src/Charcoal/Property/StorablePropertyTrait.php

@@ -121,6 +121,23 @@ public function fieldNames()
         return $this->fieldNames;
     }
 
+    /**
+     * Overridable to allow for custom Field Name parsing.
+     *
+     * This allows to add additional functions to a select statement that looks like this :
+     *  'MySQL_FUNCTION(select)'
+     *
+     * @param string $key       The property field key.
+     * @param mixed  $fieldName The raw filed name.
+     * @return mixed
+     */
+    protected function fieldExpression($key, $fieldName)
+    {
+        unset($key);
+
+        return $fieldName;
+    }
+
     /**
      * Retrieve the property's value in a format suitable for the given field key.
      *
@@ -190,6 +207,24 @@ public function storageVal($val)
         return $val;
     }
 
+    /**
+     * Overridable by property controller to add a custom parsing for the binding identifier.
+     *
+     * This allows to add additional functions to an expression to generate a binding statement that looks like this :
+     *  'MySQL_FUNCTION(:bind)'
+     *
+     * @return \Closure
+     */
+    protected function parseBinding()
+    {
+        /**
+         * @param string $bind The PDO bind string.
+         */
+        return function ($bind) {
+            return $bind;
+        };
+    }
+
     /**
      * Parse the property's value (from a flattened structure)
      * in a format suitable for models.
@@ -254,14 +289,16 @@ protected function generateFields($val = null)
         $fieldNames = $this->fieldNames();
         foreach ($fieldNames as $fieldKey => $fieldName) {
             $field = $this->createPropertyField([
-                'ident'       => $fieldName,
-                'sqlType'     => $this->sqlType(),
-                'sqlPdoType'  => $this->sqlPdoType(),
-                'sqlEncoding' => $this->sqlEncoding(),
-                'extra'       => $this->sqlExtra(),
-                'val'         => $this->fieldValue($fieldKey, $val),
-                'defaultVal'  => $this->sqlDefaultVal(),
-                'allowNull'   => $this['allowNull'],
+                'ident'                => $fieldName,
+                'sqlType'              => $this->sqlType(),
+                'sqlPdoType'           => $this->sqlPdoType(),
+                'sqlEncoding'          => $this->sqlEncoding(),
+                'extra'                => $this->sqlExtra(),
+                'selectExpressions'    => $this->fieldExpression($fieldKey, $fieldName),
+                'val'                  => $this->fieldValue($fieldKey, $val),
+                'parseBinding'         => $this->parseBinding(),
+                'defaultVal'           => $this->sqlDefaultVal(),
+                'allowNull'            => $this['allowNull'],
             ]);
 
             $fields[$fieldKey] = $field;