DateInputWidget.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Widget;
 
use DateTime;
use OOUI\TextInputWidget;
 
class DateInputWidget extends TextInputWidget {
 
    protected $inputFormat = null;
    protected $displayFormat = null;
    protected $longDisplayFormat = null;
    protected $placeholderLabel = null;
    protected $placeholderDateFormat = null;
    protected $precision = null;
    protected $mustBeAfter = null;
    protected $mustBeBefore = null;
 
    public function __construct( array $config = [] ) {
        $config = array_merge( [
            // Default config values
            'precision' => 'day',
            'longDisplayFormat' => false,
        ], $config );
 
        // Properties
        if ( isset( $config['inputFormat'] ) ) {
            $this->inputFormat = $config['inputFormat'];
        }
        if ( isset( $config['placeholderDateFormat'] ) ) {
            $this->placeholderDateFormat = $config['placeholderDateFormat'];
        }
        $this->precision = $config['precision'];
        if ( isset( $config['mustBeAfter'] ) ) {
            $this->mustBeAfter = $config['mustBeAfter'];
        } elseif ( isset( $config['min'] ) ) {
            $this->mustBeAfter = $this->modifyDate( $config['min'], '-1 day' );
        }
        if ( isset( $config['mustBeBefore'] ) ) {
            $this->mustBeBefore = $config['mustBeBefore'];
        } elseif ( isset( $config['max'] ) ) {
            $this->mustBeBefore = $this->modifyDate( $config['max'], '+1 day' );
        }
 
        // Properties stored for the infused JS widget
        if ( isset( $config['displayFormat'] ) ) {
            $this->displayFormat = $config['displayFormat'];
        }
        if ( isset( $config['longDisplayFormat'] ) ) {
            $this->longDisplayFormat = $config['longDisplayFormat'];
        }
        if ( isset( $config['placeholderLabel'] ) ) {
            $this->placeholderLabel = $config['placeholderLabel'];
        }
 
        // Set up placeholder text visible if the browser doesn't override it (logic taken from JS)
        if ( $this->placeholderDateFormat !== null ) {
            $placeholder = $this->placeholderDateFormat;
        } elseif ( $this->inputFormat !== null ) {
            // We have no way to display a translated placeholder for custom formats
            $placeholder = '';
        } else {
            $placeholder = wfMessage( "mw-widgets-dateinput-placeholder-$this->precision" )->text();
        }
 
        $config = array_merge( [
            // Processed config values
            'placeholder' => $placeholder,
        ], $config );
 
        parent::__construct( $config );
 
        // Calculate min/max attributes (which are skipped by TextInputWidget) and add to <input>
        // min/max attributes are inclusive, but mustBeAfter/Before are exclusive
        if ( $this->mustBeAfter !== null ) {
            $this->input->setAttributes( [ 'min' => $this->modifyDate( $this->mustBeAfter, '+1 day' ) ] );
        }
        if ( $this->mustBeBefore !== null ) {
            $this->input->setAttributes( [ 'max' => $this->modifyDate( $this->mustBeBefore, '-1 day' ) ] );
        }
 
        // Initialization
        $this->addClasses( [ 'mw-widget-dateInputWidget' ] );
        $this->appendContent( new PendingTextInputWidget() );
    }
 
    protected function getJavaScriptClassName() {
        return 'mw.widgets.DateInputWidget';
    }
 
    public function getConfig( &$config ) {
        if ( $this->inputFormat !== null ) {
            $config['inputFormat'] = $this->inputFormat;
        }
        if ( $this->displayFormat !== null ) {
            $config['displayFormat'] = $this->displayFormat;
        }
        if ( $this->longDisplayFormat !== null ) {
            $config['longDisplayFormat'] = $this->longDisplayFormat;
        }
        if ( $this->placeholderLabel !== null ) {
            $config['placeholderLabel'] = $this->placeholderLabel;
        }
        if ( $this->placeholderDateFormat !== null ) {
            $config['placeholderDateFormat'] = $this->placeholderDateFormat;
        }
        if ( $this->precision !== null ) {
            $config['precision'] = $this->precision;
        }
        if ( $this->mustBeAfter !== null ) {
            $config['mustBeAfter'] = $this->mustBeAfter;
        }
        if ( $this->mustBeBefore !== null ) {
            $config['mustBeBefore'] = $this->mustBeBefore;
        }
        $config['$overlay'] = true;
        return parent::getConfig( $config );
    }
 
    public function getInputElement( $config ) {
        // Inserts date/month type attribute
        return parent::getInputElement( $config )
            ->setAttributes( [
                'type' => ( $config['precision'] === 'month' ) ? 'month' : 'date'
            ] );
    }
 
    private function modifyDate( string $date, string $modifier ): string {
        $datetime = new DateTime( $date );
        $datetime->modify( $modifier );
        return $datetime->format( 'Y-m-d' );
    }
}