InputfieldTime.module

<?php

/**
 * An Inputfield for handling time inputs.
 */

class InputfieldTime extends Inputfield
{
    public static function getModuleInfo()
    {
        return array(
            'title'     => __('Time', __FILE__),
            'summary'   => __('Allows entry of times in various formats', __FILE__),
            'version'   => '0.2.2',
            'permanent' => false,
            'autoload'  => false,
            'singular'  => false,
            'requires'  => array('FieldtypeTime'),
            'installs'  => array('FieldtypeTime'),
            'author'    => 'netcarver',
            'href'      => 'https://processwire.com/talk/topic/7857-module-fieldtypetime-inputfieldtime/',
        );
    }


    public function __construct()
    {
        parent::__construct();
        $this->setAttribute('inhibitClockPicker', 0); // Set to zero if clock picker not wanted
        $this->setAttribute('htmlInput', 0);
    }


    public function init()
    {
        $this->attr('type', 'text');
        $this->attr('size', 10);
        $this->attr('maxlength', 10);
        $this->attr('placeholder', '');
        $this->attr('pattern', '');
        parent::init();
    }


    public function ___renderValue()
    {
        return htmlspecialchars($this->value, ENT_QUOTES, "UTF-8");
    }



    public function renderReady(Inputfield $parent = null, $renderValueMode = false) {
        $c = $this->config;
        $c->scripts->add($c->urls->InputfieldTime . 'InputfieldTime.trigger.js');
        $r = parent::renderReady($parent, $renderValueMode);
        return $r;
    }


    public function ___render()
    {
        $out = '';
        $format = $this->hasField->format;
        $htmlCompatibleFormat = in_array($format, ['HH24MM', 'HH24MMSS']);

        if ($this->htmlInput && $htmlCompatibleFormat) {
          $this->setAttribute('type', 'time');
          if($format == "HH24MMSS"){
            $this->setAttribute('step', 1);
          }
          if($this->wire()->adminTheme->className() == "AdminThemeUikit") {
            $this->class('uk-input');
          }
          $out .= "\n<input " . $this->getAttributesString() . "/>";
        } else {
          if (!$this->getAttribute('inhibitClockPicker') && 'HH24MM' == $this->format) {
            $id = $this->id;
            $out .= "\n<div class=\"input-group clockpicker\" data-autoclose=\"true\">";
            $out .= "\n<input " . $this->getAttributesString() . " onclick=\"InputFieldTimePickerTrigger('#$id')\"/>";
            $out .= "\n<span class=\"input-group-addon\">\n\t<span class=\"fa fa-clock-o\"></span>\n</span>";
            $out .= "\n</div>";
          } else {
            $out .= "\n<input " . $this->getAttributesString() . " />";
          }
        }
        return $out;
    }



    public function getAttributes()
    {
        $attrs = parent::getAttributes();
        if (empty($attrs['size'])) {
            unset($attrs['size']);
            $attrs['class'] = (empty($attrs['class']) ? '' : $attrs['class'] . ' ') . 'InputfieldMaxWidth';
        }
        $attrs['placeholder'] = "00:00";
        return $attrs;
    }



    public function setAttribute($key, $value)
    {
        if ($key == 'value') {
            $value = $this->sanitizeValue($value);
        }
        return parent::setAttribute($key, $value);
    }



    protected function sanitizeValue($value)
    {
        $value    = trim((string)$value);
        $format   = $this->format;
        $colons   = $this->useColons;

        if (!isset($value) || !strlen("$value")) {
            return $value;
        }

        $negative = substr($value, 0, 1) === '-';
        if($negative) {
            $value = substr($value, 1);
        }

        $neg_ok = '-' === substr($format, -1);
        if (!$neg_ok) {
            $negative = false;
        } else {
            $format = substr($format, 0, -1);
        }

        $value = str_replace('-', ':', $value);
        $value = preg_replace('/[^\d:]/', '', $value);

        if ($negative) {
            $value = '-' . $value;
        }

        return $value;
    }



    public function ___processInput(WireInputData $input)
    {
        parent::___processInput($input);

        $value = (string) $this->attr('value');
        if (strlen($value)) {
            /**
             * General time string regex - only allows '-', ':' or digits.
             */
            $regex = '#^[\d:-]+$#';
            if (!preg_match($regex, $value)) {
                $this->error($this->_('Only digits and colons (with or without a leading -) are allowed.'));
            }
        }

        return $this;
    }


    public function ___getConfigInputfields()
    {
        $inputfields = parent::___getConfigInputfields();

        $field = $this->modules->get('InputfieldCheckbox');
        $field->label = $this->_('Inhibit display of clock-picker for HH24MM time fields?');
        $field->attr('name', 'inhibitClockPicker');
        $field->attr('value', 1);
        $field->attr('checked', $this->getAttribute('inhibitClockPicker') ? 'checked' : '');
        $inputfields->append($field);

        $field = $this->modules->get('InputfieldCheckbox');
        $field->label = $this->_('Use browser native input?');
        $field->attr('name', 'htmlInput');
        $field->attr('value', 1);
        $field->attr('checked', $this->getAttribute('htmlInput') ? 'checked' : '');
        $inputfields->append($field);

        return $inputfields;
    }
}