File properties/class-papi-property-file.php

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313

<?php

/**
 * WordPress media file property.
 */
class Papi_Property_File extends Papi_Property {

    /**
     * The convert type.
     *
     * @var string
     */
    public $convert_type = 'object';

    /**
     * The default value.
     *
     * @var array
     */
    public $default_value = [];

    /**
     * File type.
     *
     * @var string
     */
    protected $file_type  = 'file';

    /**
     * Format the value of the property before it's returned
     * to WordPress admin or the site.
     *
     * @param  mixed  $value
     * @param  string $slug
     * @param  int    $post_id
     *
     * @return mixed
     */
    public function format_value( $value, $slug, $post_id ) {
        if ( is_numeric( $value ) ) {
            $meta = wp_get_attachment_metadata( $value );

            if ( isset( $meta ) && ! empty( $meta ) ) {
                $att  = get_post( $value );
                $mine = [
                    'alt'         => trim( strip_tags( get_post_meta( $value, '_wp_attachment_image_alt', true ) ) ),
                    'caption'     => trim( strip_tags( $att->post_excerpt ) ),
                    'description' => trim( strip_tags( $att->post_content ) ),
                    'id'          => intval( $value ),
                    'is_image'    => (bool) wp_attachment_is_image( $value ),
                    'title'       => $att->post_title,
                    'url'         => wp_get_attachment_url( $value ),
                ];

                $meta = is_array( $meta ) ? $meta : ['file' => $meta];

                if ( isset( $meta['sizes'] ) ) {
                    foreach ( array_keys( $meta['sizes'] ) as $size ) {
                        if ( $src = wp_get_attachment_image_src( $mine['id'], $size ) ) {
                            $meta['sizes'][$size]['url'] = $src[0];
                        }
                    }
                }

                return (object) array_merge( $meta, $mine );
            }

            return (int) $value;
        }

        if ( is_array( $value ) ) {
            $value = array_filter( $value );

            foreach ( $value as $k => $v ) {
                $value[$k] = $this->format_value( $v, $slug, $post_id );
            }

            return $value;
        }

        if ( is_object( $value ) && ! isset( $value->url ) ) {
            return;
        }

        return $value;
    }

    /**
     * Get default settings.
     *
     * @return array
     */
    public function get_default_settings() {
        return [
            'multiple' => false
        ];
    }

    /**
     * Get labels.
     *
     * @return array
     */
    public function get_labels() {
        return [
            'add'     => __( 'Add file', 'papi' ),
            'no_file' => __( 'No file selected', 'papi' )
        ];
    }

    /**
     * Render property html.
     */
    public function html() {
        $css_classes = '';
        $labels      = $this->get_labels();
        $settings    = $this->get_settings();
        $slug        = $this->html_name();
        $value       = papi_to_array( $this->get_value() );

        // Keep only valid objects.
        $value = array_filter( $value, function ( $item ) {
            return is_object( $item ) && isset( $item->id ) && ! empty( $item->id );
        } );

        $show_button = empty( $value );

        if ( $settings->multiple ) {
            $css_classes .= ' multiple ';
            $slug .= '[]';
            $show_button = true;
        }
        ?>

        <div class="papi-property-file <?php echo $css_classes; ?>" data-file-type="<?php echo esc_attr( $this->file_type ); ?>">
            <p class="papi-file-select <?php echo $show_button ? '' : 'papi-hide'; ?>">
                <?php
                if ( ! $settings->multiple ) {
                    echo $labels['no_file'] . '&nbsp;';
                }

                papi_render_html_tag( 'input', [
                    'name'  => $slug,
                    'type'  => 'hidden',
                    'value' => ''
                ] );

                papi_render_html_tag( 'button', [
                    'data-slug' => $slug,
                    'class'     => 'button',
                    'type'      => 'button',

                    $labels['add']
                ] );
                ?>
            </p>
            <div class="attachments">
                <?php
                if ( is_array( $value ) ):
                    foreach ( $value as $file ):
                        if ( ! is_object( $file ) ) {
                            continue;
                        }

                        $url = wp_get_attachment_thumb_url( $file->id );

                        if ( empty( $url ) ) {
                            $url = wp_mime_type_icon( $file->id );
                        }
                        ?>
                        <div class="attachment">
                            <a class="check" href="#">&times;</a>
                            <div class="attachment-preview">
                                <div class="thumbnail">
                                    <div class="centered">
                                        <?php
                                        papi_render_html_tag( 'img', [
                                            'alt' => $file->alt,
                                            'src' => $url
                                        ] );

                                        papi_render_html_tag( 'input', [
                                            'name'  => $slug,
                                            'type'  => 'hidden',
                                            'value' => $file->id
                                        ] );

                                        if ( ! isset( $file->file ) && isset( $file->url ) ) {
                                            $file->file = $file->url;
                                        }
                                        ?>
                                    </div>
                                    <?php if ( $this->file_type === 'file' ): ?>
                                        <div class="filename">
                                            <div><?php echo basename( $file->file ); ?></div>
                                        </div>
                                    <?php endif; ?>
                                </div>
                            </div>
                        </div>
                    <?php
                    endforeach;
                endif;
                ?>
            </div>
            <div class="clear"></div>
        </div>
    <?php
    }

    /**
     * Import value to the property.
     *
     * @param  mixed  $value
     * @param  string $slug
     * @param  int    $post_id
     *
     * @return mixed
     */
    public function import_value( $value, $slug, $post_id ) {
        if ( $this->get_setting( 'multiple' ) ) {
            $values = [];

            foreach ( papi_to_array( $value ) as $item ) {
                if ( is_object( $item ) && isset( $item->id ) && $this->is_attachment( $item->id ) ) {
                    $values[] = $item->id;
                } else if ( is_numeric( $item ) ) {
                    if ( $this->is_attachment( $item ) ) {
                        $values[] = $item;
                    }
                }
            }

            return array_filter( $values, function ( $val ) {
                return ! empty( $val );
            } );
        }

        if ( is_object( $value ) && isset( $value->id ) && $this->is_attachment( $value->id ) ) {
            return (int) $value->id;
        }

        if ( is_numeric( $value ) && $this->is_attachment( (int) $value ) ) {
            return (int) $value;
        }
    }

    /**
     * Check if the given id is a attachment post type or not.
     *
     * @param  int $id
     *
     * @return bool
     */
    protected function is_attachment( $id ) {
        return get_post_type( (int) $id ) === 'attachment';
    }

    /**
     * Render file template.
     */
    public function render_file_template() {
        ?>
        <script type="text/template" id="tmpl-papi-property-file">
            <a class="check" href="#">&times;</a>
            <div class="attachment-preview">
                <div class="thumbnail">
                    <div class="centered">
                        <img src="<%= url %>" alt="<%= alt %>"/>
                        <input type="hidden" value="<%= id %>" name="<%= slug %>"/>
                    </div>
                    <% if (typeof filename !== "undefined") { %>
                    <div class="filename">
                        <div><%= filename %></div>
                    </div>
                    <% } %>
                </div>
            </div>
        </script>
        <?php
    }

    /**
     * Setup actions.
     */
    protected function setup_actions() {
        add_action( 'admin_head', [$this, 'render_file_template'] );
    }

    /**
     * Setup filters.
     */
    protected function setup_filters() {
        add_action( 'wp_get_attachment_metadata', [$this, 'wp_get_attachment_metadata'], 10, 2 );
    }

    /**
     * Get attachment metadata.
     *
     * @param  mixed $data
     * @param  int   $post_id
     *
     * @return mixed
     */
    public function wp_get_attachment_metadata( $data, $post_id ) {
        if ( papi_is_empty( $data ) ) {
            return get_post_meta( $post_id, '_wp_attached_file', true );
        }

        return $data;
    }
}

Classes

Functions