class-attachment-upload.php
<?php
/**
* Attachment upload field.
*
* @package HivePress\Fields
*/
namespace HivePress\Fields;
use HivePress\Helpers as hp;
use HivePress\Models;
// Exit if accessed directly.
defined( 'ABSPATH' ) || exit;
/**
* Attachment upload.
*/
class Attachment_Upload extends Field {
/**
* Button caption.
*
* @var string
*/
protected $caption;
/**
* Allowed file formats.
*
* @var array
*/
protected $formats = [];
/**
* Allow multiple files?
*
* @var bool
*/
protected $multiple = false;
/**
* Maximum number of files.
*
* @var int
*/
protected $max_files = 1;
/**
* Prevent direct URL access?
*
* @var bool
*/
protected $protected = false;
/**
* Class initializer.
*
* @param array $meta Class meta values.
*/
public static function init( $meta = [] ) {
$meta = hp\merge_arrays(
[
'label' => esc_html__( 'Attachment', 'hivepress' ),
'settings' => [
'caption' => [
'label' => esc_html__( 'Caption', 'hivepress' ),
'type' => 'text',
'max_length' => 256,
'_order' => 100,
],
'formats' => [
'label' => esc_html__( 'File Types', 'hivepress' ),
'type' => 'select',
'options' => 'mime_types',
'multiple' => true,
'_order' => 110,
],
'protected' => [
'label' => esc_html_x( 'Protected', 'attachment', 'hivepress' ),
'caption' => esc_html__( 'Protect files from direct access', 'hivepress' ),
'type' => 'checkbox',
'_order' => 120,
],
],
],
$meta
);
parent::init( $meta );
}
/**
* Class constructor.
*
* @param array $args Field arguments.
*/
public function __construct( $args = [] ) {
$args = hp\merge_arrays(
$args,
[
'disabled' => true,
]
);
parent::__construct( $args );
}
/**
* Bootstraps field properties.
*/
protected function boot() {
// Set caption.
if ( is_null( $this->caption ) ) {
if ( $this->multiple ) {
$this->caption = esc_html__( 'Select Files', 'hivepress' );
} else {
$this->caption = esc_html__( 'Select File', 'hivepress' );
}
}
// Set required flag.
if ( $this->required ) {
// @todo remove when available for all fields.
$this->attributes['data-required'] = 'true';
}
parent::boot();
}
/**
* Gets field value for display.
*
* @return mixed
*/
public function get_display_value() {
if ( ! is_null( $this->value ) ) {
$urls = array_filter(
array_map(
function( $attachment_id ) {
return wp_get_attachment_url( $attachment_id );
},
(array) $this->value
)
);
if ( $urls ) {
$urls = implode( ', ', $urls );
if ( strpos( $this->display_template, '<a ' ) === false && strpos( $this->display_template, '<img ' ) === false && ! hp\has_shortcode( $this->display_template ) ) {
$urls = str_replace( '<a ', '<a target="_blank" ', make_clickable( $urls ) );
}
return $urls;
}
}
}
/**
* Sets allowed file formats.
*
* @param array $formats File formats.
*/
final protected function set_formats( $formats ) {
if ( is_array( $formats ) ) {
foreach ( $formats as $format ) {
$this->formats = array_merge( $this->formats, explode( '|', $format ) );
}
}
}
/**
* Gets allowed file formats.
*
* @return array
*/
final public function get_formats() {
return $this->formats;
}
/**
* Checks if multiple files are allowed.
*
* @return bool
*/
final public function is_multiple() {
return $this->multiple;
}
/**
* Gets the maximum allowed number of files.
*
* @return int
*/
final public function get_max_files() {
return $this->max_files;
}
/**
* Checks if attachment is protected.
*
* @return bool
*/
final public function is_protected() {
return $this->protected;
}
/**
* Normalizes field value.
*/
protected function normalize() {
parent::normalize();
if ( $this->multiple && ! is_null( $this->value ) ) {
if ( [] !== $this->value ) {
$this->value = (array) $this->value;
} else {
$this->value = null;
}
} elseif ( ! $this->multiple && is_array( $this->value ) ) {
if ( $this->value ) {
$this->value = hp\get_first_array_value( $this->value );
} else {
$this->value = null;
}
}
}
/**
* Sanitizes field value.
*/
protected function sanitize() {
if ( $this->multiple ) {
$this->value = array_filter( array_map( 'absint', $this->value ) );
} else {
$this->value = absint( $this->value );
}
if ( empty( $this->value ) ) {
$this->value = null;
}
}
/**
* Validates field value.
*
* @return bool
*/
public function validate() {
if ( parent::validate() && ! is_null( $this->value ) ) {
$attachment_ids = Models\Attachment::query()->filter(
[
'id__in' => (array) $this->value,
]
)->get_ids();
if ( count( $attachment_ids ) !== count( (array) $this->value ) ) {
// @todo replace temporary fix.
$this->value = $attachment_ids;
if ( ! $this->multiple ) {
$this->value = hp\get_first_array_value( $this->value );
}
}
}
return empty( $this->errors );
}
/**
* Renders field HTML.
*
* @return string
*/
public function render() {
$output = '<div ' . hp\html_attributes( $this->attributes ) . '>';
// Get ID.
$id = $this->name . '_' . uniqid();
// Render attachments.
$output .= '<div class="hp-row" ' . ( $this->multiple ? 'data-component="sortable"' : '' ) . '>';
if ( ! is_null( $this->value ) ) {
// Get attachments.
$attachments = Models\Attachment::query()->filter(
[
'id__in' => (array) $this->value,
]
)->order( 'id__in' )
->get();
// Render attachments.
foreach ( $attachments as $attachment ) {
$output .= $this->render_attachment( $attachment );
}
}
$output .= '</div>';
// Render error messages.
$output .= '<div class="hp-form__messages hp-form__messages--error" data-component="messages"></div>';
// Render upload button.
$output .= '<label for="' . esc_attr( $id ) . '">';
$output .= ( new Button(
[
'label' => $this->caption,
]
) )->render();
// Render upload field.
$output .= ( new File(
[
'name' => $this->name,
'multiple' => $this->multiple,
'formats' => $this->formats,
'disabled' => true,
'attributes' => [
'id' => $id,
'data-component' => 'file-upload',
'data-name' => hp\unprefix( $this->name ),
'data-url' => esc_url( hivepress()->router->get_url( 'attachment_upload_action' ) ),
],
]
) )->render();
$output .= '</label>';
$output .= '</div>';
return $output;
}
/**
* Renders attachment preview.
*
* @param object $attachment Attachment object.
* @return string
*/
public function render_attachment( $attachment ) {
$output = '<div class="hp-col-sm-2 hp-col-xs-4" data-url="' . esc_url( hivepress()->router->get_url( 'attachment_update_action', [ 'attachment_id' => $attachment->get_id() ] ) ) . '">';
// Render attachment.
if ( strpos( $attachment->get_mime_type(), 'image/' ) === 0 ) {
$output .= wp_get_attachment_image( $attachment->get_id(), 'thumbnail' );
$output .= '<a href="' . esc_url( $attachment->get_url() ) . '" target="_blank" title="' . esc_attr__( 'Download', 'hivepress' ) . '" class="hp-field__button hp-field__button--download"><i class="hp-icon fas fa-arrow-down"></i></a>';
} else {
$output .= '<div><a href="' . esc_url( $attachment->get_url() ) . '" target="_blank" title="' . esc_attr__( 'Download', 'hivepress' ) . '">' . esc_html( $attachment->get_name() ) . '</a></div>';
}
// Render delete button.
$output .= '<a href="#" title="' . esc_attr__( 'Delete', 'hivepress' ) . '" class="hp-field__button hp-field__button--delete" data-component="file-delete" data-url="' . esc_url( hivepress()->router->get_url( 'attachment_delete_action', [ 'attachment_id' => $attachment->get_id() ] ) ) . '"><i class="hp-icon fas fa-times"></i></a>';
$output .= '</div>';
return $output;
}
}
