class-gravityview-lightbox-provider-fancybox.php

Go to the documentation of this file.

<?php
/**
 * Integrate with the FancyBox lightbox and gallery scripts
 * @see https://fancyapps.com/fancybox/3/docs/#options
 * @since 2.10
 */

/**
 * Register the FancyBox lightbox
 *
 * @internal
 */
class GravityView_Lightbox_Provider_FancyBox extends GravityView_Lightbox_Provider {

    public static $slug = 'fancybox';

    public static $script_slug = 'gravityview-fancybox';

    public static $style_slug = 'gravityview-fancybox';

    /**
     * @inheritDoc
     */
    public function print_scripts( $gravityview ) {

        parent::print_scripts( $gravityview );

        if ( ! self::is_active( $gravityview ) ) {
            return;
        }

        $settings = self::get_settings();

        $settings = json_encode( $settings );
        ?>
        <style>
            .fancybox-container {
                z-index: 100000; /** Divi is 99999 */
            }

            .admin-bar .fancybox-container {
                margin-top: 32px;
            }
        </style>
        <script>
            if ( window.Fancybox ){
                Fancybox.bind(".gravityview-fancybox", <?php echo $settings; ?>);
            }
        </script>
        <?php

    }

    /**
     * Options to pass to Fancybox
     *
     * @see https://fancyapps.com/fancybox/3/docs/#options
     *
     * @return array
     */
    protected function default_settings() {

        $defaults = array(
                'animationEffect' => 'fade',
                'toolbar'         => true,
                'closeExisting'   => true,
                'arrows'          => true,
                'buttons'         => array(
                    'thumbs',
                    'close',
                ),
                'i18n'            => array(
                    'en' => array(
                        'CLOSE'       => __( 'Close', 'gk-gravityview' ),
                        'NEXT'        => __( 'Next', 'gk-gravityview' ),
                        'PREV'        => __( 'Previous', 'gk-gravityview' ),
                        'ERROR'       => __( 'The requested content cannot be loaded. Please try again later.', 'gk-gravityview' ),
                        'PLAY_START'  => __( 'Start slideshow', 'gk-gravityview' ),
                        'PLAY_STOP'   => __( 'Pause slideshow', 'gk-gravityview' ),
                        'FULL_SCREEN' => __( 'Full screen', 'gk-gravityview' ),
                        'THUMBS'      => __( 'Thumbnails', 'gk-gravityview' ),
                        'DOWNLOAD'    => __( 'Download', 'gk-gravityview' ),
                        'SHARE'       => __( 'Share', 'gk-gravityview' ),
                        'ZOOM'        => __( 'Zoom', 'gk-gravityview' ),
                    ),
                )
        );

        return $defaults;
    }

    /**
     * @inheritDoc
     */
    public function enqueue_scripts() {
        wp_register_script( self::$script_slug, plugins_url( 'assets/lib/fancybox/dist/fancybox.umd.js', GRAVITYVIEW_FILE ), array(), GV_PLUGIN_VERSION );
    }

    /**
     * @inheritDoc
     */
    public function enqueue_styles() {
        wp_register_style( self::$style_slug, plugins_url( 'assets/lib/fancybox/dist/fancybox.css', GRAVITYVIEW_FILE ), array(), GV_PLUGIN_VERSION );
    }

    /**
     * @inheritDoc
     */
    public function allowed_atts( $atts = array() ) {

        $atts['data-fancybox']         = null;
        $atts['data-fancybox-trigger'] = null;
        $atts['data-fancybox-index']   = null;
        $atts['data-src']              = null;
        $atts['data-type']             = null;
        $atts['data-width']            = null;
        $atts['data-height']           = null;
        $atts['data-srcset']           = null;
        $atts['data-caption']          = null;
        $atts['data-options']          = null;
        $atts['data-filter']           = null;

        return $atts;
    }

    /**
     * @inheritDoc
     */
    public function fileupload_link_atts( $link_atts, $field_compat = array(), $context = null, $additional_details = null ) {

        if ( $context && ! $context->view->settings->get( 'lightbox', false ) ) {
            return $link_atts;
        }

        // Prevent empty content from getting added to the lightbox gallery
        if ( is_array( $additional_details ) && empty( $additional_details['file_path'] ) ) {
            return $link_atts;
        }

        // Prevent empty content from getting added to the lightbox gallery
        if ( is_array( $additional_details ) && ! empty( $additional_details['disable_lightbox'] ) ) {
            return $link_atts;
        }

        $link_atts['class'] = \GV\Utils::get( $link_atts, 'class' ) . ' gravityview-fancybox';

        $link_atts['class'] = gravityview_sanitize_html_class( $link_atts['class'] );

        if ( $context && ! empty( $context->field->field ) ) {
            if ( $context->field->field->multipleFiles ) {
                $entry = $context->entry->as_entry();
                $link_atts['data-fancybox'] = 'gallery-' . sprintf( "%s-%s-%s", $entry['form_id'], $context->field->ID, $context->entry->get_slug() );
            }
        }

        $file_path = \GV\Utils::get( $additional_details, 'file_path' );

        /**
         * For file types that require IFRAME, declare `pdf` media type.
         * @see https://fancyapps.com/docs/ui/fancybox#media-types
         */
        if ( false !== strpos( $file_path, 'gv-iframe' ) ) {
            $link_atts['data-type'] = 'pdf';
        }

        return $link_atts;
    }

}

GravityView_Lightbox::register( 'GravityView_Lightbox_Provider_FancyBox' );