<?php
/**
* @package Pods\Fields
*/
class PodsField_Text extends PodsField {
/**
* Field Type Group
*
* @var string
* @since 2.0
*/
public static $group = 'Text';
/**
* Field Type Identifier
*
* @var string
* @since 2.0
*/
public static $type = 'text';
/**
* Field Type Label
*
* @var string
* @since 2.0
*/
public static $label = 'Plain Text';
/**
* Field Type Preparation
*
* @var string
* @since 2.0
*/
public static $prepare = '%s';
/**
* Do things like register/enqueue scripts and stylesheets
*
* @since 2.0
*/
public function __construct () {
}
/**
* Add options and set defaults to
*
*
* @return array
* @since 2.0
*/
public function options () {
$options = array(
self::$type . '_repeatable' => array(
'label' => __( 'Repeatable Field', 'pods' ),
'default' => 0,
'type' => 'boolean',
'help' => __( 'Making a field repeatable will add controls next to the field which allows users to Add/Remove/Reorder additional values. These values are saved in the database as an array, so searching and filtering by them may require further adjustments".', 'pods' ),
'boolean_yes_label' => '',
'dependency' => true,
'developer_mode' => true
),
'output_options' => array(
'label' => __( 'Output Options', 'pods' ),
'group' => array(
self::$type . '_allow_shortcode' => array(
'label' => __( 'Allow Shortcodes?', 'pods' ),
'default' => 0,
'type' => 'boolean',
'dependency' => true
),
self::$type . '_allow_html' => array(
'label' => __( 'Allow HTML?', 'pods' ),
'default' => 0,
'type' => 'boolean',
'dependency' => true
)
)
),
self::$type . '_allowed_html_tags' => array(
'label' => __( 'Allowed HTML Tags', 'pods' ),
'depends-on' => array( self::$type . '_allow_html' => true ),
'default' => 'strong em a ul ol li b i',
'type' => 'text'
),
self::$type . '_max_length' => array(
'label' => __( 'Maximum Length', 'pods' ),
'default' => 255,
'type' => 'number',
'help' => __( 'Set to 0 for no limit', 'pods' )
)/*,
self::$type . '_size' => array(
'label' => __( 'Field Size', 'pods' ),
'default' => 'medium',
'type' => 'pick',
'data' => array(
'small' => __( 'Small', 'pods' ),
'medium' => __( 'Medium', 'pods' ),
'large' => __( 'Large', 'pods' )
)
)*/
);
return $options;
}
/**
* Define the current field's schema for DB table storage
*
* @param array $options
*
* @return array
* @since 2.0
*/
public function schema ( $options = null ) {
$length = (int) pods_var( self::$type . '_max_length', $options, 255, null, true );
$schema = 'VARCHAR(' . $length . ')';
if ( 255 < $length || $length < 1 )
$schema = 'LONGTEXT';
return $schema;
}
/**
* Change the way the value of the field is displayed with Pods::get
*
* @param mixed $value
* @param string $name
* @param array $options
* @param array $pod
* @param int $id
*
* @return mixed|null|string
* @since 2.0
*/
public function display ( $value = null, $name = null, $options = null, $pod = null, $id = null ) {
$value = $this->strip_html( $value, $options );
if ( 1 == pods_var( self::$type . '_allow_shortcode', $options ) )
$value = do_shortcode( $value );
return $value;
}
/**
* Customize output of the form field
*
* @param string $name
* @param mixed $value
* @param array $options
* @param array $pod
* @param int $id
*
* @since 2.0
*/
public function input ( $name, $value = null, $options = null, $pod = null, $id = null ) {
$options = (array) $options;
$form_field_type = PodsForm::$field_type;
if ( is_array( $value ) )
$value = implode( ' ', $value );
pods_view( PODS_DIR . 'ui/fields/text.php', compact( array_keys( get_defined_vars() ) ) );
}
/**
* Validate a value before it's saved
*
* @param mixed $value
* @param string $name
* @param array $options
* @param array $fields
* @param array $pod
* @param int $id
*
* @param null $params
* @return array|bool
* @since 2.0
*/
public function validate ( &$value, $name = null, $options = null, $fields = null, $pod = null, $id = null, $params = null ) {
$errors = array();
$check = $this->pre_save( $value, $id, $name, $options, $fields, $pod, $params );
if ( is_array( $check ) )
$errors = $check;
else {
if ( 0 < strlen( $value ) && strlen( $check ) < 1 ) {
if ( 1 == pods_var( 'required', $options ) )
$errors[] = __( 'This field is required.', 'pods' );
}
}
if ( !empty( $errors ) )
return $errors;
return true;
}
/**
* Change the value or perform actions after validation but before saving to the DB
*
* @param mixed $value
* @param int $id
* @param string $name
* @param array $options
* @param array $fields
* @param array $pod
* @param object $params
*
* @return mixed|string
* @since 2.0
*/
public function pre_save ( $value, $id = null, $name = null, $options = null, $fields = null, $pod = null, $params = null ) {
$value = $this->strip_html( $value, $options );
return $value;
}
/**
* Customize the Pods UI manage table column output
*
* @param int $id
* @param mixed $value
* @param string $name
* @param array $options
* @param array $fields
* @param array $pod
*
* @return mixed|string
* @since 2.0
*/
public function ui ( $id, $value, $name = null, $options = null, $fields = null, $pod = null ) {
$value = $this->strip_html( $value, $options );
if ( 0 == pods_var( self::$type . '_allow_html', $options, 0, null, true ) )
$value = wp_trim_words( $value );
return $value;
}
/**
* Strip HTML based on options
*
* @param string $value
* @param array $options
*
* @return string
*/
public function strip_html ( $value, $options = null ) {
if ( is_array( $value ) )
$value = @implode( ' ', $value );
$value = trim( $value );
if ( empty( $value ) )
return $value;
$options = (array) $options;
if ( 1 == pods_var( self::$type . '_allow_html', $options, 0, null, true ) ) {
$allowed_html_tags = '';
if ( 0 < strlen( pods_var( self::$type . '_allowed_html_tags', $options ) ) ) {
$allowed_html_tags = explode( ' ', trim( pods_var( self::$type . '_allowed_html_tags', $options ) ) );
$allowed_html_tags = '<' . implode( '><', $allowed_html_tags ) . '>';
}
if ( !empty( $allowed_html_tags ) && '<>' != $allowed_html_tags )
$value = strip_tags( $value, $allowed_html_tags );
}
else
$value = strip_tags( $value );
return $value;
}
}