Initial commit

Author: hailwood

.gitignore

@@ -0,0 +1 @@
+.idea/

Readme.md

@@ -0,0 +1,96 @@
+# Laravel Forms
+
+By default the views are setup for beagle
+Javascript not included
+
+## Directives
+
+
+### Form Open
+```
+@form(['update' => route('some-model.store', [$model]), 'model' => $model, 'files' => true, 'extra' => [...]])
+@form(['store' => route('some-model.store'), 'files' => true, 'extra' => [...]])
+@form(['delete' => route('some-model.delete'), 'files' => true, 'extra' => [...]])
+@form(['get' => route('search.route'), 'extra' => [...]])
+```
+
+#### Notes
+* Using any of these methods will automatically append the **csrf \_token** and correct **route type \_method** fields.
+* If a model is passed via the `'model'` key, We will use it's data to populate the form fields value.
+* Anything passed via the `'extra'` array will be appended as attributes to the form.
+
+### Form Close
+```
+@endform
+```
+
+#### Notes
+* The form is actually a component, which means you need to close it after you're done.
+* This will also unbind the `'model'` so future forms on the same page are not affected.
+
+
+### Form Field
+Now we get into the fun stuff. The minimum required for a form field is a name
+```
+@formField(['name' => 'first_name'])
+```
+This will render a `type="text"` form field wrapped in a form group with the label of `First Name` and an appropriate value, Additionally this will handle displaying server validation errors.
+
+```
+@formField(['name' => 'name', 'label' => 'Your Name'])
+```
+This will render as above, however the label will be `Your Name`
+
+```
+@formField(['name' => 'name', 'label' => false])
+```
+This will render as above, however there will be no label
+
+```
+@formField(['name' => 'work_email', 'type' => 'email' ])
+```
+This will render a `type="email"` form field following the previous rules
+
+```
+@formField(['name' => 'role', 'options' => ['k' => 'v', 'k2' => 'v2']])
+```
+This will render a `select` with the given options.
+If no value is found for this field we will also prepend an empty `<option>` tag
+
+```
+@formField(['name' => 'roles', 'options' => ['k' => 'v', 'k2' => 'v2'], 'extra' => ['multiple']])
+```
+This will render a `select` with the given options, additionally the name on the select will be `roles[]`
+
+```
+@formField(['name' => 'first_name', 'extra' => ['required', 'data-boolean', 'data-something' => 'value']])
+```
+This will render a field with the following additional attributes `required data-boolean data-something="value"`
+
+## Calculating Values
+The following order of precedence is used for calculating values for a form
+0. Input matching the `name` via Laravels `old($fieldName)` helper.
+0. Attributes from the model provided to `@form`
+0. Values passed in directly e.g. `@formField(['name' => 'name', 'value' => 'John'])`.
+
+### Note on _old_ input and multiple forms...
+Unfortunately, there's no way to scope Laravels `old($fieldName)` helper, meaning that if one form on a page has old input, 
+all fields on the page with the same name will be populated with the old input. 
+This is not a limitation of this package, rather it is a limitation of Laravel's old input handling.
+
+## A note about templates, backward compatibility and support
+We've open sourced this package so you can use it too, however it is primarily designed for
+our inhouse usage, meaning some of the templates have specific rules that require javascript from our templates to run,
+additionally we'll be releasing often to add new features and fixes we need, but it may break your work.
+
+Rather than using this package directly, we suggest you fork it and maintain a copy for your organisation.
+
+## IDE Helper
+
+If you don't have them already, add the following to your projects `.idea/blade.xml` file so PHPstorm knows about the directives
+
+```xml
+<data directive="@endform" />
+<data directive="@form" injection="true" prefix="&lt;?php function x(array $options) {}; x(" suffix="); ?&gt;" />
+<data directive="@formField" injection="true" prefix="&lt;?php function x(array $options) {}; x(" suffix="); ?&gt;" />
+```

composer.json

@@ -0,0 +1,31 @@
+{
+  "name": "webfox/laravel-forms",
+  "description": "A Laravel form package",
+  "require": {
+    "php": "^7.2.0",
+    "laravel/framework": "~5.7"
+  },
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Matthew Hailwood",
+      "email": "[email protected]"
+    },
+    {
+      "name": "Derek Kaijser",
+      "email": "[email protected]"
+    }
+  ],
+  "autoload": {
+    "psr-4": {
+      "Webfox\\LaravelForms\\": "src/"
+    }
+  },
+  "extra": {
+    "laravel": {
+      "providers": [
+        "Webfox\\LaravelForms\\ServiceProvider"
+      ]
+    }
+  }
+}

config/config.php

@@ -0,0 +1,6 @@
+<?php
+
+return [
+    'container_path' => 'forms::container',
+    'field_path'     => 'forms::fields',
+];

src/AttributeManager.php

@@ -0,0 +1,153 @@
+<?php
+
+namespace Webfox\LaravelForms;
+
+use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Arr;
+use Illuminate\View\View;
+
+class AttributeManager
+{
+
+  /** @var \Illuminate\Database\Eloquent\Model|null */
+  protected $formModel;
+
+  public function __construct(FormModelStack $modelStack)
+  {
+    if ($modelStack->isNotEmpty()) {
+      $this->setModel($modelStack->last());
+    }
+  }
+
+  public function setModel(Model $model = null)
+  {
+    $this->formModel = $model;
+    return $this;
+  }
+
+  public function getFieldActualName(View $view)
+  {
+    $extra = $view->offsetExists('extra') ? $view->offsetGet('extra') : [];
+    $name  = $view->offsetGet('name');
+
+    foreach ($extra as $key => $value) {
+      if ($key === 'multiple' && $value === true) {
+        return "{$name}[]";
+      }
+
+      if ($value === 'multiple' && (is_int($key) || is_string($key) && ctype_digit($key))) {
+        return "{$name}[]";
+      }
+    }
+
+    return $name;
+  }
+
+  public function getExtraAttributes(View $view)
+  {
+
+    $extra = $view->offsetExists('extra') ? $view->offsetGet('extra') : [];
+    if (($extra['data-allow-clear'] ?? false) || in_array('data-allow-clear', $extra)) {
+      $view->offsetSet('allowClear', true);
+    }
+
+    if ($view->offsetExists('placeholder')) {
+      $extra['placeholder'] = $view->offsetGet('placeholder');
+    }
+
+    // Extra property mappings for textarea
+    if ($view->offsetExists('rows')) {
+      $extra['rows'] = $view->offsetGet('rows');
+    }
+
+    $valueRequiredBooleans = ['data-allow-clear'];
+
+    // Convert extra properties to key="value" string
+    $attributes = array_map(function ($key, $value) use ($valueRequiredBooleans) {
+      // ['required']
+      if (is_int($key) || is_string($key) && ctype_digit($key)) {
+        return in_array($value, $valueRequiredBooleans) ? "{$value}=\"1\"" : $value;
+      }
+
+      // ['required' => true]
+      if (is_bool($value) && $value) {
+        return in_array($key, $valueRequiredBooleans) ? "{$key}=\"1\"" : $key;
+      }
+
+      // ['required' => false]
+      if (is_bool($value) && !$value) {
+        return null;
+      }
+
+      return sprintf('%s="%s"', $key, htmlspecialchars($value));
+    }, array_keys($extra), $extra);
+
+    // Remove empty (boolean false) attributes
+    $attributes = array_filter($attributes);
+
+    return implode(' ', $attributes);
+  }
+
+  public function getFieldTemplate(View $view)
+  {
+    // Check the template
+    $fieldType = $this->getFieldType($view);
+
+    $templates = [
+      config('forms.field_path') . ".{$fieldType}",
+      config('forms.field_path') . ".simple",
+    ];
+
+    $template = Arr::first($templates, function ($view) {
+      return view()->exists($view);
+    });
+
+    if (!$template) {
+      throw new \Exception("Unable to locate formField " . implode(', ', $templates));
+    }
+
+
+    return $template;
+  }
+
+  public function getFieldType(View $view)
+  {
+    if ($view->offsetExists('type')) {
+      return $view->offsetGet('type');
+    }
+
+    if ($view->offsetExists('options')) {
+      return 'select';
+    }
+
+    return 'text';
+  }
+
+  public function getFieldValue(View $view)
+  {
+    $fieldName = $view->offsetGet('name');
+    $fieldType = $this->getFieldType($view);
+
+    // Find the expected value
+    if (in_array($fieldType, ['file', 'password'])) {
+      return $view->offsetExists('value') ? $view->offsetGet('value') : null;
+    }
+
+    $value = null;
+    if ($this->formModel && !in_array($fieldName, $this->formModel->getHidden())) {
+      $value = $this->formModel->getAttribute($fieldName);
+    }
+    if ($value === null && $view->offsetExists('value')) {
+      $value = $view->offsetGet('value');
+    }
+
+    $value = old($fieldName, $value);
+
+    if ($value instanceof Collection) {
+      $value = $value->modelKeys();
+    }
+
+    return is_bool($value) ? intval($value) : $value;
+  }
+}

src/FieldViewComposer.php

@@ -0,0 +1,42 @@
+<?php
+
+
+namespace Webfox\LaravelForms;
+
+use Illuminate\Http\Request;
+use Illuminate\View\View;
+
+class FieldViewComposer
+{
+
+    /**
+     * @var \Illuminate\Http\Request
+     */
+    protected $request;
+
+    /** @var \Webfox\LaravelForms\AttributeManager */
+    protected $attributeManager;
+
+    public function __construct(Request $request, AttributeManager $attributeManager)
+    {
+        $this->request          = $request;
+        $this->attributeManager = $attributeManager;
+    }
+
+    public function compose(View $view)
+    {
+        // Calculate the field type
+        $fieldType = $this->attributeManager->getFieldType($view);
+
+        // Repopulate the template
+        $view->offsetSet('extraAttributes', $this->attributeManager->getExtraAttributes($view));
+        $view->offsetSet('fieldTemplate', $this->attributeManager->getFieldTemplate($view));
+        $view->offsetSet('value', $this->attributeManager->getFieldValue($view));
+        $view->offsetSet('type', $this->attributeManager->getFieldType($view));
+        $view->offsetSet('actualName', $this->attributeManager->getFieldActualName($view));
+        $view->offsetSet('onlyTemplate', in_array($fieldType, ['checkbox']));
+        $view->offsetSet('model', app(FormModelStack::class)->current());
+    }
+
+
+}