12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268 |
- <?php
- namespace Dcat\Admin\Form;
- use Dcat\Admin\Admin;
- use Dcat\Admin\Form;
- use Illuminate\Contracts\Support\Arrayable;
- use Illuminate\Contracts\Support\Renderable;
- use Illuminate\Support\Arr;
- use Illuminate\Support\Facades\Validator;
- use Illuminate\Support\Fluent;
- use Illuminate\Support\Traits\Macroable;
- /**
- * Class Field.
- */
- class Field implements Renderable
- {
- use Macroable;
- const FILE_DELETE_FLAG = '_file_del_';
- /**
- * Element id.
- *
- * @var array|string
- */
- protected $id;
- /**
- * Element value.
- *
- * @var mixed
- */
- protected $value;
- /**
- * Data of all original columns of value.
- *
- * @var mixed
- */
- protected $data;
- /**
- * Field original value.
- *
- * @var mixed
- */
- protected $original;
- /**
- * Field default value.
- *
- * @var mixed
- */
- protected $default;
- /**
- * Element label.
- *
- * @var string
- */
- protected $label = '';
- /**
- * Column name.
- *
- * @var string|array
- */
- protected $column = '';
- /**
- * Form element name.
- *
- * @var string
- */
- protected $elementName = [];
- /**
- * Form element classes.
- *
- * @var array
- */
- protected $elementClass = [];
- /**
- * Variables of elements.
- *
- * @var array
- */
- protected $variables = [];
- /**
- * Options for specify elements.
- *
- * @var array
- */
- protected $options = [];
- /**
- * Checked for specify elements.
- *
- * @var array
- */
- protected $checked = [];
- /**
- * Validation rules.
- *
- * @var string|\Closure
- */
- protected $rules = '';
- /**
- * @var callable
- */
- protected $validator;
- /**
- * Validation messages.
- *
- * @var array
- */
- protected $validationMessages = [];
- /**
- * Css required by this field.
- *
- * @var array
- */
- protected static $css = [];
- /**
- * Js required by this field.
- *
- * @var array
- */
- protected static $js = [];
- /**
- * Script for field.
- *
- * @var string
- */
- protected $script = '';
- /**
- * Element attributes.
- *
- * @var array
- */
- protected $attributes = [];
- /**
- * Parent form.
- *
- * @var Form
- */
- protected $form = null;
- /**
- * View for field to render.
- *
- * @var string
- */
- protected $view = '';
- /**
- * Help block.
- *
- * @var array
- */
- protected $help = [];
- /**
- * Key for errors.
- *
- * @var mixed
- */
- protected $errorKey;
- /**
- * Placeholder for this field.
- *
- * @var string|array
- */
- protected $placeholder;
- /**
- * Width for label and field.
- *
- * @var array
- */
- protected $width = [
- 'label' => 2,
- 'field' => 8,
- ];
- /**
- * If the form horizontal layout.
- *
- * @var bool
- */
- protected $horizontal = true;
- /**
- * column data format.
- *
- * @var \Closure
- */
- protected $customFormat = null;
- /**
- * @var bool
- */
- protected $display = true;
- /**
- * @var array
- */
- protected $labelClass = [];
- /**
- * @var \Closure
- */
- protected $customPrepare;
- /**
- * Field constructor.
- *
- * @param $column
- * @param array $arguments
- */
- public function __construct($column, $arguments = [])
- {
- $this->column = $column;
- $this->label = $this->formatLabel($arguments);
- $this->id = $this->formatId($column);
- }
- /**
- * Get the field element id.
- *
- * @return string
- */
- public function getElementId()
- {
- return $this->id;
- }
- /**
- * Format the field element id.
- *
- * @param string|array $column
- *
- * @return string|array
- */
- protected function formatId($column)
- {
- if (is_array($column)) {
- return str_replace('.', '-', $column);
- }
- return 'form-field-'.str_replace('.', '-', $column);
- }
- /**
- * Format the label value.
- *
- * @param array $arguments
- *
- * @return string
- */
- protected function formatLabel($arguments = [])
- {
- $column = is_array($this->column) ? current($this->column) : $this->column;
- $label = isset($arguments[0]) ? $arguments[0] : ucfirst(admin_trans_field($column));
- return str_replace(['.', '_'], ' ', $label);
- }
- /**
- * Format the name of the field.
- *
- * @param string $column
- *
- * @return array|mixed|string
- */
- protected function formatName($column)
- {
- if (is_string($column)) {
- $name = explode('.', $column);
- if (count($name) == 1) {
- return $name[0];
- }
- $html = array_shift($name);
- foreach ($name as $piece) {
- $html .= "[$piece]";
- }
- return $html;
- }
- if (is_array($this->column)) {
- $names = [];
- foreach ($this->column as $key => $name) {
- $names[$key] = $this->formatName($name);
- }
- return $names;
- }
- return '';
- }
- /**
- * Set form element name.
- *
- * @param string $name
- *
- * @return $this
- *
- * @author Edwin Hui
- */
- public function setElementName($name)
- {
- $this->elementName = $name;
- return $this;
- }
- /**
- * Fill data to the field.
- *
- * @param array $data
- *
- * @return void
- */
- final public function fill($data)
- {
- $this->data($data);
- $this->value = $this->formatAttributeFromQuery($data);
- $this->callCustomFormatter();
- }
- /**
- * Format attribute.
- *
- * @param array $data
- * @return mixed
- */
- protected function formatAttributeFromQuery($data)
- {
- if (is_array($this->column)) {
- $value = [];
- foreach ($this->column as $key => $column) {
- $value[$key] = Arr::get($data, $column);
- }
- return $value;
- }
- return Arr::get($data, $this->column);
- }
- /**
- * custom format form column data when edit.
- *
- * @param \Closure $call
- *
- * @return $this
- */
- public function customFormat(\Closure $call)
- {
- $this->customFormat = $call;
- return $this;
- }
- /**
- * Set original value to the field.
- *
- * @param array $data
- * @return void
- */
- final public function setOriginal($data)
- {
- $this->original = $this->formatAttributeFromQuery($data);
- $this->callCustomFormatter('original', new Fluent($data));
- }
- /**
- * @param string $key
- * @param Fluent|null $dataremoveField
- */
- protected function callCustomFormatter($key = 'value', Fluent $data = null)
- {
- if ($this->customFormat) {
- $this->{$key} = $this->customFormat
- ->call(
- $data ?: $this->data(),
- $this->{$key},
- $this->column,
- $this
- );
- }
- }
- /**
- * @param Form $form
- *
- * @return $this
- */
- public function setForm(Form $form = null)
- {
- $this->form = $form;
- return $this;
- }
- /**
- * @return Fluent
- */
- public function getFormModel()
- {
- return $this->form ? $this->form->model() : new Fluent;
- }
- /**
- * Set width for field and label.
- *
- * @param int $field
- * @param int $label
- *
- * @return $this
- */
- public function setWidth($field = 8, $label = 2)
- {
- $this->width = [
- 'label' => $label,
- 'field' => $field,
- ];
- return $this;
- }
- /**
- * Set the field options.
- *
- * @param array $options
- *
- * @return $this
- */
- public function options($options = [])
- {
- if ($options instanceof Arrayable) {
- $options = $options->toArray();
- }
- $this->options = array_merge($this->options, $options);
- return $this;
- }
- /**
- * Set the field option checked.
- *
- * @param array $checked
- *
- * @return $this
- */
- public function checked($checked = [])
- {
- if ($checked instanceof Arrayable) {
- $checked = $checked->toArray();
- }
- $this->checked = array_merge($this->checked, (array)$checked);
- return $this;
- }
- /**
- * Get or set rules.
- *
- * @param null $rules
- * @param array $messages
- *
- * @return $this
- */
- public function rules($rules = null, $messages = [])
- {
- if ($rules instanceof \Closure) {
- $this->rules = $rules;
- }
- if (is_array($rules)) {
- $thisRuleArr = array_filter(explode('|', $this->rules));
- $this->rules = array_merge($thisRuleArr, $rules);
- } elseif (is_string($rules)) {
- $rules = array_filter(explode('|', "{$this->rules}|$rules"));
- $this->rules = implode('|', $rules);
- }
- $this->validationMessages = $messages;
- return $this;
- }
- /**
- * Get field validation rules.
- *
- * @return string
- */
- public function getRules()
- {
- if ($this->rules instanceof \Closure) {
- return $this->rules->call($this, $this->form);
- }
- return $this->rules;
- }
- /**
- * Remove a specific rule by keyword.
- *
- * @param string $rule
- *
- * @return void
- */
- public function removeRule($rule)
- {
- if (!$this->rules || !is_string($this->rules)) {
- return;
- }
- $pattern = "/{$rule}[^\|]?(\||$)/";
- $this->rules = preg_replace($pattern, '', $this->rules, -1);
- }
- /**
- * @param string $rule
- *
- * @return bool
- */
- public function hasRule($rule)
- {
- if (!$this->rules || !is_string($this->rules)) {
- return false;
- }
- $pattern = "/{$rule}[^\|]?(\||$)/";
- return preg_match($pattern, $this->rules);
- }
- /**
- * Set field validator.
- *
- * @param callable $validator
- *
- * @return $this
- */
- public function validator(callable $validator)
- {
- $this->validator = $validator;
- return $this;
- }
- /**
- * Get key for error message.
- *
- * @return string
- */
- public function getErrorKey()
- {
- return $this->errorKey ?: $this->column;
- }
- /**
- * Set key for error message.
- *
- * @param string $key
- *
- * @return $this
- */
- public function setErrorKey($key)
- {
- $this->errorKey = $key;
- return $this;
- }
- /**
- * Set or get value of the field.
- *
- * @param null $value
- *
- * @return mixed
- */
- public function value($value = null)
- {
- if (is_null($value)) {
- return is_null($this->value) ? $this->getDefault() : $this->value;
- }
- $this->value = $value;
- return $this;
- }
- /**
- * Set or get data.
- *
- * @param array $data
- *
- * @return $this
- */
- public function data(array $data = null)
- {
- if (is_null($data)) {
- return $this->data ?: ($this->data = new Fluent);
- }
- $this->data = new Fluent($data);
- return $this;
- }
- /**
- * Set default value for field.
- *
- * @param $default
- *
- * @return $this
- */
- public function default($default)
- {
- $this->default = $default;
- return $this;
- }
- /**
- * Get default value.
- *
- * @return mixed
- */
- public function getDefault()
- {
- if ($this->default instanceof \Closure) {
- return call_user_func($this->default, $this->form);
- }
- return $this->default;
- }
- /**
- * Set help block for current field.
- *
- * @param string $text
- * @param string $icon
- *
- * @return $this
- */
- public function help($text = '', $icon = 'fa-info-circle')
- {
- $this->help = compact('text', 'icon');
- return $this;
- }
- /**
- * Get column of the field.
- *
- * @return string|array
- */
- public function column()
- {
- return $this->column;
- }
- /**
- * Get or set label of the field.
- *
- * @param null $label
- * @return $this|string
- */
- public function label($label = null)
- {
- if ($label == null) {
- return $this->label;
- }
- if ($label instanceof \Closure) {
- $label = $label($this->label);
- }
- $this->label = $label;
- return $this;
- }
- /**
- * Get original value of the field.
- *
- * @return mixed
- */
- public function original()
- {
- return $this->original;
- }
- /**
- * Get validator for this field.
- *
- * @param array $input
- *
- * @return bool|Validator
- */
- public function getValidator(array $input)
- {
- if ($this->validator) {
- return $this->validator->call($this, $input);
- }
- $rules = $attributes = [];
- if (!$fieldRules = $this->getRules()) {
- return false;
- }
- if (is_string($this->column)) {
- if (!Arr::has($input, $this->column)) {
- return false;
- }
- $input = $this->sanitizeInput($input, $this->column);
- $rules[$this->column] = $fieldRules;
- $attributes[$this->column] = $this->label;
- }
- if (is_array($this->column)) {
- foreach ($this->column as $key => $column) {
- if (!array_key_exists($column, $input)) {
- continue;
- }
- $input[$column.$key] = Arr::get($input, $column);
- $rules[$column.$key] = $fieldRules;
- $attributes[$column.$key] = $this->label."[$column]";
- }
- }
- return Validator::make($input, $rules, $this->validationMessages, $attributes);
- }
- /**
- * Sanitize input data.
- *
- * @param array $input
- * @param string $column
- *
- * @return array
- */
- protected function sanitizeInput($input, $column)
- {
- if ($this instanceof Field\MultipleSelect) {
- $value = Arr::get($input, $column);
- Arr::set($input, $column, array_filter($value));
- }
- return $input;
- }
- /**
- * Add html attributes to elements.
- *
- * @param array|string $attribute
- * @param mixed $value
- *
- * @return $this
- */
- public function attribute($attribute, $value = null)
- {
- if (is_array($attribute)) {
- $this->attributes = array_merge($this->attributes, $attribute);
- } else {
- $this->attributes[$attribute] = (string) $value;
- }
- return $this;
- }
- /**
- * Specifies a regular expression against which to validate the value of the input.
- *
- * @param string $regexp
- *
- * @return $this
- */
- public function pattern($regexp)
- {
- return $this->attribute('pattern', $regexp);
- }
- /**
- * set the input filed required.
- *
- * @param bool $isLabelAsterisked
- *
- * @return $this
- */
- public function required($isLabelAsterisked = true)
- {
- if ($isLabelAsterisked) {
- $this->setLabelClass(['asterisk']);
- }
- $this->rules('required');
- return $this->attribute('required', true);
- }
- /**
- * Set the field automatically get focus.
- *
- * @return $this
- */
- public function autofocus()
- {
- return $this->attribute('autofocus', true);
- }
- /**
- * Set the field as readonly mode.
- *
- * @return $this
- */
- public function readOnly()
- {
- return $this->attribute('readonly', true);
- }
- /**
- * Set field as disabled.
- *
- * @return $this
- */
- public function disable()
- {
- return $this->attribute('disabled', true);
- }
- /**
- * Set field placeholder.
- *
- * @param string $placeholder
- *
- * @return $this
- */
- public function placeholder($placeholder = '')
- {
- $this->placeholder = $placeholder;
- return $this;
- }
- /**
- * Get placeholder.
- *
- * @return string
- */
- public function getPlaceholder()
- {
- return $this->placeholder ?: trans('admin.input').' '.$this->label;
- }
- /**
- * Prepare for a field value before update or insert.
- *
- * @param mixed $value
- * @return mixed
- */
- public function prepare($value)
- {
- return $value;
- }
- /**
- * @param \Closure $closure
- * @return $this
- */
- public function customPrepare(\Closure $closure)
- {
- $this->customPrepare = $closure;
- return $this;
- }
- /**
- * Prepare for a field value before update or insert.
- *
- * @param mixed $value
- * @return mixed
- */
- final public function prepareInputValue($value)
- {
- $value = $this->prepare($value);
- if ($handler = $this->customPrepare) {
- $handler->bindTo($this->data);
- return $handler($value);
- }
- return $value;
- }
- /**
- * Format the field attributes.
- *
- * @return string
- */
- protected function formatAttributes()
- {
- $html = [];
- foreach ($this->attributes as $name => $value) {
- $html[] = $name.'="'.e($value).'"';
- }
- return implode(' ', $html);
- }
- /**
- * @return $this
- */
- public function disableHorizontal()
- {
- $this->horizontal = false;
- return $this;
- }
- /**
- * @return array
- */
- public function getViewElementClasses()
- {
- if ($this->horizontal) {
- return [
- 'label' => "col-sm-{$this->width['label']} {$this->getLabelClass()}",
- 'field' => "col-sm-{$this->width['field']}",
- 'form-group' => 'form-group ',
- ];
- }
- return ['label' => $this->getLabelClass(), 'field' => '', 'form-group' => ''];
- }
- /**
- * Set form element class.
- *
- * @param string|array $class
- *
- * @return $this
- */
- public function setElementClass($class)
- {
- $this->elementClass = array_merge($this->elementClass, (array) $class);
- return $this;
- }
- /**
- * Get element class.
- *
- * @return array
- */
- protected function getElementClass()
- {
- if (!$this->elementClass) {
- $name = $this->elementName ?: $this->formatName($this->column);
- $this->elementClass = (array) str_replace(['[', ']'], '_', $name);
- }
- return $this->elementClass;
- }
- /**
- * Get element class string.
- *
- * @return mixed
- */
- protected function getElementClassString()
- {
- $elementClass = $this->getElementClass();
- if (Arr::isAssoc($elementClass)) {
- $classes = [];
- foreach ($elementClass as $index => $class) {
- $classes[$index] = is_array($class) ? implode(' ', $class) : $class;
- }
- return $classes;
- }
- return implode(' ', $elementClass);
- }
- /**
- * Get element class selector.
- *
- * @return string|array
- */
- protected function getElementClassSelector()
- {
- $elementClass = $this->getElementClass();
- $formId = $this->getFormId();
- $formId = $formId ? '#'.$formId : '';
- if (Arr::isAssoc($elementClass)) {
- $classes = [];
- foreach ($elementClass as $index => $class) {
- $classes[$index] = $formId . ' .'.(is_array($class) ? implode('.', $class) : $class);
- }
- return $classes;
- }
- return $formId . ' .'.implode('.', $elementClass);
- }
- /**
- * @return string|null
- */
- protected function getFormId()
- {
- return $this->form ? $this->form->getFormId() : null;
- }
- /**
- * Add the element class.
- *
- * @param $class
- *
- * @return $this
- */
- public function addElementClass($class)
- {
- if (is_array($class) || is_string($class)) {
- $this->elementClass = array_merge($this->elementClass, (array) $class);
- $this->elementClass = array_unique($this->elementClass);
- }
- return $this;
- }
- /**
- * Remove element class.
- *
- * @param $class
- *
- * @return $this
- */
- public function removeElementClass($class)
- {
- $delClass = [];
- if (is_string($class) || is_array($class)) {
- $delClass = (array) $class;
- }
- foreach ($delClass as $del) {
- if (($key = array_search($del, $this->elementClass))) {
- unset($this->elementClass[$key]);
- }
- }
- return $this;
- }
- /**
- * Add variables to field view.
- *
- * @param array $variables
- *
- * @return $this
- */
- protected function addVariables(array $variables = [])
- {
- $this->variables = array_merge($this->variables, $variables);
- return $this;
- }
- /**
- * @return string
- */
- public function getLabelClass(): string
- {
- return implode(' ', $this->labelClass);
- }
- /**
- * @param array $labelClass
- *
- * @return $this
- */
- public function setLabelClass(array $labelClass)
- {
- $this->labelClass = $labelClass;
- return $this;
- }
- /**
- * @return string
- */
- public function getElementName()
- {
- return $this->elementName ?: $this->formatName($this->column);
- }
- /**
- * Get the view variables of this field.
- *
- * @return array
- */
- public function variables()
- {
- return array_merge($this->variables, [
- 'id' => $this->id,
- 'name' => $this->getElementName(),
- 'help' => $this->help,
- 'class' => $this->getElementClassString(),
- 'value' => $this->value(),
- 'label' => $this->label,
- 'viewClass' => $this->getViewElementClasses(),
- 'column' => $this->column,
- 'errorKey' => $this->getErrorKey(),
- 'attributes' => $this->formatAttributes(),
- 'placeholder' => $this->getPlaceholder(),
- 'disabled' => $this->attributes['disabled'] ?? false,
- 'formId' => $this->getFormId(),
- ]);
- }
- /**
- * Get view of this field.
- *
- * @return string
- */
- public function getView()
- {
- return $this->view ?: 'admin::form.'.strtolower(class_basename(static::class));
- }
- /**
- * Set view of current field.
- *
- * @return string
- */
- public function setView($view)
- {
- $this->view = $view;
- return $this;
- }
- /**
- * Get script of current field.
- *
- * @return string
- */
- public function getScript()
- {
- return $this->script;
- }
- /**
- * Set script of current field.
- *
- * @return self
- */
- public function setScript($script)
- {
- $this->script = $script;
- return $this;
- }
- /**
- * To set this field should render or not.
- *
- * @return self
- */
- public function setDisplay(bool $display)
- {
- $this->display = $display;
- return $this;
- }
- /**
- * If this field should render.
- *
- * @return bool
- */
- protected function shouldRender()
- {
- if (!$this->display) {
- return false;
- }
- return true;
- }
- /**
- * Collect assets required by this field.
- */
- public static function collectAssets()
- {
- static::$js && Admin::js(static::$js);
- static::$css && Admin::css(static::$css);
- }
- /**
- * Render this filed.
- *
- * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View|string
- */
- public function render()
- {
- if (!$this->shouldRender()) {
- return '';
- }
- Admin::script($this->script);
- return view($this->getView(), $this->variables());
- }
- /**
- * @return string
- */
- public function __toString()
- {
- return $this->render()->render();
- }
- }
|