|
Server : Microsoft-IIS/10.0 System : Windows NT HMW9050 6.2 build 9200 (Unknow Windows version Standard Edition) i586 User : fatorc ( 0) PHP Version : 5.3.28 Disable Function : escapeshellarg, escapeshellcmd, exec, passthru, proc_close, proc_open, shell_exec, system, dl, popen, php_check_syntax, php_strip_whitespace, symlink, link, openlog, apache_child_terminate Directory : e:/home/fatorc/Web/wp-content/plugins/types/library/toolset/types/embedded/classes/field/renderer/preview/ |
Upload File : |
<?php
/**
* Base for preview renderer fields.
*
* Preview renderers are to be used mainly in admin, for example in post/user/term listings. Their task is to really
* render a simple preview for the value, nothing more. In some cases the output may not even contain the complete
* information (e.g. lots of images in a repetitive field).
*
* This class handles displaying repetitive fields, other preview renderers are supposed to inherit from it and
* implement only the render_single() method.
*
* @since 1.9.1
*/
abstract class WPCF_Field_Renderer_Preview_Base extends WPCF_Field_Renderer_Abstract {
protected $args;
/**
* WPCF_Field_Renderer_Preview_Base constructor.
*
* @param WPCF_Field_Instance_Abstract $field
* @param array $args Preview renderer settings:
* - maximum_item_count => Maximum count of field values that should be displayed.
* - maximum_item_length => Maximum length of single item.
* - maximum_total_length => Maximum length of output.
* - value_separator => Separator to be used between multiple field values.
* - ellipsis => Ellipsis to be added when some field values are omitted.
*
* Specialized renderers may interpret the settings in a different way or add their own.
*
* @since 1.9.1
*/
public function __construct( $field, $args = array() ) {
parent::__construct( $field );
$this->args = wpcf_ensarr( $args );
}
/**
* Render the field value. Handle both single and repetitive fields.
*
* Rendering of a single value is defined in render_single() and multiple values are concatenated by
* separator provided by get_value_separator().
*
* @param bool $echo Echo the output?
* @return string Rendered HTML.
* @since 1.9.1
*/
public function render( $echo = false ) {
$field_value = $this->field->get_value();
// Handle all fields as repetitive, we allways have array of individual field values.
$output_values = array();
// Optionally limit the number of rendered items
$max_item_count = $this->get_maximum_item_count();
$loop_limit = (
$max_item_count > 0
? min( $max_item_count, count( $field_value ) )
: count( $field_value )
);
$is_limited_by_max_count = ( $loop_limit < count( $field_value ) );
for( $i = 0; $i < $loop_limit; ++$i ) {
$value = array_shift( $field_value );
$output_values[] = $this->render_single( $value );
}
$output = implode( $this->get_value_separator(), $output_values );
$ellipsis = $this->get_ellipsis();
$is_limited_by_max_total_length = $this->limit_by_maximum_total_length( $output );
$needs_separator = $is_limited_by_max_count && ! $is_limited_by_max_total_length;
$needs_ellipsis = ( $is_limited_by_max_count || $is_limited_by_max_total_length );
if( $needs_separator ) {
$output .= $this->get_value_separator();
}
if( $needs_ellipsis ) {
$output .= $ellipsis;
}
if( $echo ) {
echo $output;
}
return $output;
}
/**
* Apply maximum total length limit on a value.
*
* @param string &$value Value to be shortened if needed.
* @return bool True if the limit was applied.
* @since 2.1
*/
protected function limit_by_maximum_total_length( &$value ) {
$ellipsis = $this->get_ellipsis();
$ellipsis_length = strlen( $ellipsis );
$maximum_total_length = $this->get_maximum_total_length();
$is_limited_by_max_total_length = ( 0 < $maximum_total_length && $maximum_total_length < strlen( $value ) );
if( $is_limited_by_max_total_length ) {
$value = substr( $value, 0, $maximum_total_length - $ellipsis_length );
}
return $is_limited_by_max_total_length;
}
/**
* @return string Separator to be used between multiple field values.
*/
protected function get_value_separator() {
return wpcf_getarr( $this->args, 'value_separator', ', ' );
}
/**
* @param mixed $value Single field value in the intermediate format (see data mappers for details)
* @return string Rendered HTML
*/
protected abstract function render_single( $value );
/**
* @return int Maximum count of field values that should be displayed. Zero means no limit.
* @since 1.9.1
*/
protected function get_maximum_item_count() {
return absint( wpcf_getarr( $this->args, 'maximum_item_count' ) );
}
/**
* @return int Maximum length of single item. Interpretation depends on specific renderer (on a field type); it
* may be completely ignored. Zero means no limit.
* @since 1.9.1
*/
protected function get_maximum_item_length() {
return absint( wpcf_getarr( $this->args, 'maximum_item_length' ) );
}
/**
* @return int Maximum length of the final output. Zero means no limit. When some HTML is rendered, this method
* needs to be overridden to allways return zero, otherwise the markup might be broken.
* @since 1.9.1
*/
protected function get_maximum_total_length() {
return absint( wpcf_getarr( $this->args, 'maximum_total_length' ) );
}
/**
* @return string Ellipsis to be added when some field values are omitted.
* @since 1.9.1
*/
protected function get_ellipsis() {
return wpcf_getarr( $this->args, 'ellipsis', '...' );
}
}