class-gravityview-field-date-created.php

Go to the documentation of this file.

<?php
/**
 * @file class-gravityview-field-date-created.php
 * @package GravityView
 * @subpackage includes\fields
 */

class GravityView_Field_Date_Created extends GravityView_Field {

    var $name = 'date_created';

    var $is_searchable = true;

    var $search_operators = array( 'less_than', 'greater_than', 'is', 'isnot' );

    var $group = 'meta';

    var $contexts = array( 'single', 'multiple', 'export' );

    var $_custom_merge_tag = 'date_created';

    var $icon = 'dashicons-calendar-alt';

    /**
     * GravityView_Field_Date_Created constructor.
     */
    public function __construct() {

        $this->label = esc_html__( 'Date Created', 'gk-gravityview' );
        $this->default_search_label = $this->label;
        $this->description = esc_html__( 'The date the entry was created.', 'gk-gravityview' );

        add_filter( 'gravityview_field_entry_value_' . $this->name . '_pre_link', array( $this, 'get_content' ), 10, 4 );

        parent::__construct();
    }

    public function field_options( $field_options, $template_id, $field_id, $context, $input_type, $form_id ) {

        if( 'edit' === $context ) {
            return $field_options;
        }

        $this->add_field_support('date_display', $field_options );

        return $field_options;
    }

    /**
     * Filter the value of the field
     *
     * @todo Consider how to add to parent class
     *
     * @since 1.16
     *
     * @param string $output HTML value output
     * @param array  $entry The GF entry array
     * @param array  $field_settings Settings for the particular GV field
     * @param array  $field Current field being displayed
     *
     * @return string values for this field based on the numeric values used by Gravity Forms
     */
    public function get_content( $output = '', $entry = array(), $field_settings = array(), $field = array() ) {

        /** Overridden by a template. */
        if( ! empty( $field['field_path'] ) ) { return $output; }

        return GVCommon::format_date( $field['value'], 'format=' . \GV\Utils::get( $field_settings, 'date_display' ) );
    }

    /**
     * Add {date_created} merge tag and format the values using format_date
     *
     * @since 1.16
     *
     * @see https://docs.gravityview.co/article/331-date-created-merge-tag for usage information
     *
     * @param array $matches Array of Merge Tag matches found in text by preg_match_all
     * @param string $text Text to replace
     * @param array $form Gravity Forms form array
     * @param array $entry Entry array
     * @param bool $url_encode Whether to URL-encode output
     *
     * @return string Original text if {date_created} isn't found. Otherwise, replaced text.
     */
    public function replace_merge_tag( $matches = array(), $text = '', $form = array(), $entry = array(), $url_encode = false, $esc_html = false  ) {

        $return = $text;

        /** Use $this->name instead of date_created because Payment Date uses this as well*/
        $date_created = \GV\Utils::get( $entry, $this->name );

        foreach ( $matches as $match ) {

            $full_tag          = $match[0];
            $property          = $match[1];

            $formatted_date = GravityView_Merge_Tags::format_date( $date_created, $property );

            $return = str_replace( $full_tag, $formatted_date, $return );
        }

        return $return;
    }

}

new GravityView_Field_Date_Created;