Issues in class-foogallery-paging.php (master) - Issues in master - fooplugins/foogallery - Measure and Improve Code Quality continuously with Scrutinizer

Issues (1881)

Security Analysis not enabled

Cross-Site Scripting

Cross-Site Scripting enables an attacker to inject code into the response of a web-request that is viewed by other users. It can for example be used to bypass access controls, or even to take over other users' accounts.

File Exposure

File Exposure allows an attacker to gain access to local files that he should not be able to access. These files can for example include database credentials, or other configuration files.

File Manipulation

File Manipulation enables an attacker to write custom data to files. This potentially leads to injection of arbitrary code on the server.

Object Injection

Object Injection enables an attacker to inject an object into PHP code, and can lead to arbitrary code execution, file exposure, or file manipulation attacks.

Code Injection

Code Injection enables an attacker to execute arbitrary code on the server.

Response Splitting

Response Splitting can be used to send arbitrary responses.

File Inclusion

File Inclusion enables an attacker to inject custom files into PHP's file loading mechanism, either explicitly passed to include, or for example via PHP's auto-loading mechanism.

Command Injection

Command Injection enables an attacker to inject a shell command that is execute with the privileges of the web-server. This can be used to expose sensitive data, or gain access of your server.

SQL Injection

SQL Injection enables an attacker to execute arbitrary SQL code on your database server gaining access to user data, or manipulating user data.

XPath Injection

XPath Injection enables an attacker to modify the parts of XML document that are read. If that XML document is for example used for authentication, this can lead to further vulnerabilities similar to SQL Injection.

LDAP Injection

LDAP Injection enables an attacker to inject LDAP statements potentially granting permission to run unauthorized queries, or modify content inside the LDAP tree.

Header Injection

Other Vulnerability

This category comprises other attack vectors such as manipulating the PHP runtime, loading custom extensions, freezing the runtime, or similar.

Regex Injection

Regex Injection enables an attacker to execute arbitrary code in your PHP process.

XML Injection

XML Injection enables an attacker to read files on your local filesystem including configuration files, or can be abused to freeze your web-server process.

Variable Injection

Variable Injection enables an attacker to overwrite program variables with custom data, and can lead to further vulnerabilities.

Unfortunately, the security analysis is currently not available for your project. If you are a non-commercial open-source project, please contact support to gain access.

includes/class-foogallery-paging.php (1 issue)

Labels

Severity

Minor 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php
/**
 * Class used to handle paging for gallery templates
 */
if ( ! class_exists( 'FooGallery_Paging' ) ) {

	class FooGallery_Paging {

		function __construct() {
			if ( is_admin() ) {
				//add extra fields to the templates that support paging
				add_filter( 'foogallery_override_gallery_template_fields', array( $this, 'add_paging_fields' ), 10, 2 );

				//build up any preview arguments
				add_filter( 'foogallery_preview_arguments', array( $this, 'preview_arguments' ), 10, 3 );
			}

			//adds the paging property to a FooGallery
			add_action( 'foogallery_located_template', array( $this, 'determine_paging' ), 10, 2 );

			//add the paging attributes to the gallery container
			add_filter( 'foogallery_build_container_data_options', array( $this, 'add_paging_options' ), 20, 3 );

			//limit the number of attachments returned when rendering a gallery
            add_filter( 'foogallery_gallery_attachments_override_for_rendering', array( $this, 'attachments_override' ), 10, 3 );

			//output a script block with the rest of the attachments as json
			add_action( 'foogallery_loaded_template', array( $this, 'output_paging_script_block' ) );
		}

		/**
		 * Add paging fields to the gallery template
		 *
		 * @uses "foogallery_override_gallery_template_fields"
		 * @param $fields
		 * @param $template
		 *
		 * @return array
		 */
		function add_paging_fields( $fields, $template ) {
			if ( $template && array_key_exists( 'paging_support', $template ) && true === $template['paging_support'] ) {
				$fields[] = array(
					'id'      => 'paging_type',
					'title'   => __( 'Paging Type', 'foogallery' ),
					'desc'    => __( 'Add paging to a large gallery.', 'foogallery' ),
					'section' => __( 'Paging', 'foogallery' ),
					'spacer'  => '<span class="spacer"></span>',
					'type'    => 'radio',
					'default' => '',
					'choices' => apply_filters( 'foogallery_gallery_template_paging_type_choices', array(
						''  => __( 'None', 'foogallery' ),
						'dots'   => __( 'Dots', 'foogallery' )
					) ),
					'row_data'=> array(
						'data-foogallery-change-selector' => 'input',
						'data-foogallery-preview' => 'shortcode',
						'data-foogallery-value-selector' => 'input:checked',
					)
				);

				$fields[] = array(
					'id'      => 'paging_size',
					'title'   => __( 'Page Size', 'foogallery' ),
					'desc'    => __( 'The size of your pages.', 'foogallery' ),
					'section' => __( 'Paging', 'foogallery' ),
					'type'    => 'number',
					'class'   => 'small-text',
					'default' => 20,
					'step'    => '1',
					'min'     => '0',
					'row_data'=> array(
						'data-foogallery-change-selector' => 'input',
						'data-foogallery-preview' => 'shortcode',
						'data-foogallery-hidden'                   => true,
						'data-foogallery-show-when-field'          => 'paging_type',
						'data-foogallery-show-when-field-operator' => '!==',
						'data-foogallery-show-when-field-value'    => '',
					)
				);

				$fields[] = array(
					'id'      => 'paging_position',
					'title'   => __( 'Position', 'foogallery' ),
					'desc'    => __( 'The position of the paging for either dots or pagination.', 'foogallery' ),
					'section' => __( 'Paging', 'foogallery' ),
					'spacer'  => '<span class="spacer"></span>',
					'type'    => 'radio',
					'default' => 'both',
					'choices' => apply_filters( 'foogallery_gallery_template_paging_position_choices', array(
						''  => __( 'None', 'foogallery' ),
						'top'   => __( 'Top', 'foogallery' ),
						'bottom'   => __( 'Bottom', 'foogallery' ),
						'both'   => __( 'Both', 'foogallery' )
					) ),
					'row_data'=> array(
						'data-foogallery-hidden' => true,
						'data-foogallery-show-when-field-operator' => 'regex',
						'data-foogallery-show-when-field' => 'paging_type',
						'data-foogallery-show-when-field-value' => 'dots|pagination',
						'data-foogallery-change-selector' => 'input',
						'data-foogallery-preview' => 'shortcode'
					)
				);

				$fields[] = array(
					'id'      => 'paging_theme',
					'title'   => __( 'Theme', 'foogallery' ),
					'desc'    => __( 'The theme used for paging.', 'foogallery' ),
					'section' => __( 'Paging', 'foogallery' ),
					'spacer'  => '<span class="spacer"></span>',
					'type'    => 'radio',
					'default' => 'fg-light',
					'choices' => apply_filters( 'foogallery_gallery_template_paging_theme_choices', array(
						'fg-light'  => __( 'Light', 'foogallery' ),
						'fg-dark'   => __( 'Dark', 'foogallery' ),
					) ),
					'row_data'=> array(
						'data-foogallery-change-selector' => 'input',
						'data-foogallery-preview' => 'shortcode',
						'data-foogallery-hidden'                   => true,
						'data-foogallery-show-when-field'          => 'paging_type',
						'data-foogallery-show-when-field-operator' => '!==',
						'data-foogallery-show-when-field-value'    => '',
					)
				);

				$fields[] = array(
					'id'      => 'paging_scroll',
					'title'   => __( 'Scroll To Top', 'foogallery' ),
					'desc'    => __( 'Whether or not it should scroll to the top of the gallery when paging is changed.', 'foogallery' ),
					'section' => __( 'Paging', 'foogallery' ),
					'type'    => 'radio',
					'spacer'  => '<span class="spacer"></span>',
					'default' => 'true',
					'choices' => array(
						'true'  => __( 'Yes', 'foogallery' ),
						'false'  => __( 'No', 'foogallery' ),
					),
					'row_data'=> array(
						'data-foogallery-hidden' => true,
						'data-foogallery-show-when-field-operator' => 'regex',
						'data-foogallery-show-when-field' => 'paging_type',
						'data-foogallery-show-when-field-value' => 'dots|pagination',
						'data-foogallery-change-selector' => 'input',
						'data-foogallery-preview' => 'shortcode'
					)
				);

				$fields[] = array(
					'id'      => 'paging_limit',
					'title'   => __( 'Paging Limit', 'foogallery' ),
					'desc'    => __( 'The maximum number of page links to display for the gallery.', 'foogallery' ),
					'section' => __( 'Paging', 'foogallery' ),
					'type'    => 'number',
					'class'   => 'small-text',
					'default' => 5,
					'step'    => '1',
					'min'     => '0',
					'row_data'=> array(
						'data-foogallery-hidden' => true,
						'data-foogallery-show-when-field' => 'paging_type',
						'data-foogallery-show-when-field-value' => 'pagination',
						'data-foogallery-change-selector' => 'input',
						'data-foogallery-preview' => 'shortcode'
					)
				);

				$fields[] = array(
					'id'      => 'paging_showFirstLast',
					'title'   => __( 'First &amp; Last Buttons', 'foogallery' ),
					'desc'    => __( 'Whether or not to show the first &amp; last buttons for pagination.', 'foogallery' ),
					'section' => __( 'Paging', 'foogallery' ),
					'type'    => 'radio',
					'spacer'  => '<span class="spacer"></span>',
					'default' => 'true',
					'choices' => array(
						'true'  => __( 'Show', 'foogallery' ),
						'false'  => __( 'Hide', 'foogallery' ),
					),
					'row_data'=> array(
						'data-foogallery-hidden' => true,
						'data-foogallery-show-when-field' => 'paging_type',
						'data-foogallery-show-when-field-value' => 'pagination',
						'data-foogallery-change-selector' => 'input',
						'data-foogallery-preview' => 'shortcode'
					)
				);

				$fields[] = array(
					'id'      => 'paging_showPrevNext',
					'title'   => __( 'Prev &amp; Next Buttons', 'foogallery' ),
					'desc'    => __( 'Whether or not to show the previous &amp; next buttons for pagination.', 'foogallery' ),
					'section' => __( 'Paging', 'foogallery' ),
					'type'    => 'radio',
					'spacer'  => '<span class="spacer"></span>',
					'default' => 'true',
					'choices' => array(
						'true'  => __( 'Show', 'foogallery' ),
						'false'  => __( 'Hide', 'foogallery' ),
					),
					'row_data'=> array(
						'data-foogallery-hidden' => true,
						'data-foogallery-show-when-field' => 'paging_type',
						'data-foogallery-show-when-field-value' => 'pagination',
						'data-foogallery-change-selector' => 'input',
						'data-foogallery-preview' => 'shortcode'
					)
				);

				$fields[] = array(
					'id'      => 'paging_showPrevNextMore',
					'title'   => __( 'More Buttons', 'foogallery' ),
					'desc'    => __( 'Whether or not to show the previous &amp; next more buttons for pagination.', 'foogallery' ),
					'section' => __( 'Paging', 'foogallery' ),
					'type'    => 'radio',
					'spacer'  => '<span class="spacer"></span>',
					'default' => 'true',
					'choices' => array(
						'true'  => __( 'Show', 'foogallery' ),
						'false'  => __( 'Hide', 'foogallery' ),
					),
					'row_data'=> array(
						'data-foogallery-hidden' => true,
						'data-foogallery-show-when-field' => 'paging_type',
						'data-foogallery-show-when-field-value' => 'pagination',
						'data-foogallery-change-selector' => 'input',
						'data-foogallery-preview' => 'shortcode'
					)
				);

				$fields[] = array(
					'id'      => 'paging_output',
					'title'   => __( 'Paging Output', 'foogallery' ),
					'desc'    => __( 'How the paging items are output. We recommend that very large galleries output as JSON.', 'foogallery' ),
					'section' => __( 'Paging', 'foogallery' ),
					'spacer'  => '<span class="spacer"></span>',
					'type'    => 'radio',
					'default' => 'html',
					'choices' => apply_filters( 'foogallery_gallery_template_paging_output_choices', array(
						''  => __( 'JSON', 'foogallery' ),
						'html'   => __( 'HTML', 'foogallery' )
					) ),
					'row_data'=> array(
						'data-foogallery-change-selector' => 'input',
						'data-foogallery-preview' => 'shortcode',
						'data-foogallery-value-selector' => 'input:checked',
						'data-foogallery-hidden'                   => true,
						'data-foogallery-show-when-field'          => 'paging_type',
						'data-foogallery-show-when-field-operator' => '!==',
						'data-foogallery-show-when-field-value'    => '',
					)
				);
			}

			return $fields;
		}

		/**
		 * Determine if the gallery has paging enabled
		 *
		 * @param $foogallery FooGallery
		 */
		function determine_paging( $foogallery ) {
			$template_data = foogallery_get_gallery_template( $foogallery->gallery_template );

			//check the template supports paging
			$paging = $template_data && array_key_exists( 'paging_support', $template_data ) && true === $template_data['paging_support'];

			$foogallery->paging = apply_filters( 'foogallery_paging', $paging, $foogallery );
		}

		/**
		 * Add the required paging options if needed
		 *
		 * @param $attributes array
		 * @param $gallery FooGallery
		 *
		 * @return array
		 */
		function add_paging_options($options, $gallery, $attributes) {

			if ( isset( $gallery->paging ) && true === $gallery->paging) {

				//check if we have arguments from the shortcode and override the saved settings
				$paging = $this->get_foogallery_argument( $gallery, 'paging_type', 'paging', '' );

				if ( '' !== $paging ) {
					$paging_position = $this->get_foogallery_argument( $gallery, 'paging_position', 'paging_position', 'both' );
					$paging_theme    = $this->get_foogallery_argument( $gallery, 'paging_theme', 'paging_theme', 'fg-light' );
					$paging_size     = intval( $this->get_foogallery_argument( $gallery, 'paging_size', 'paging_size', '30' ) );
					$paging_scroll   = $this->get_foogallery_argument( $gallery, 'paging_scroll', 'paging_scroll', 'true' ) === 'true';

					//force bottom position for infinite and loadMore paging
					if ( 'infinite' === $paging || 'loadMore' === $paging ) {
						$paging_position = 'bottom';
					}

                    $paging_options = array(
						'type'        => $paging,
						'theme'       => $paging_theme,
						'size'        => $paging_size,
						'position'    => $paging_position,
						'scrollToTop' => $paging_scroll
					);

					if ( 'pagination' === $paging ) {
                        $paging_options['limit'] = intval( $this->get_foogallery_argument( $gallery, 'paging_limit', 'paging_limit', '5' ) );;
						$paging_options['showFirstLast'] = $this->get_foogallery_argument( $gallery, 'paging_showFirstLast', 'paging_showFirstLast', 'true' ) === 'true';;
						$paging_options['showPrevNext'] = $this->get_foogallery_argument( $gallery, 'paging_showPrevNext', 'paging_showPrevNext', 'true' ) === 'true';;
						$paging_options['showPrevNextMore'] = $this->get_foogallery_argument( $gallery, 'paging_showPrevNextMore', 'paging_showPrevNextMore', 'true' ) === 'true';;
					}

                    $options['paging'] = $gallery->paging_options = $paging_options;

					if ( 'on' !== foogallery_get_setting( 'output_json_to_script_block', '') ) {
						$paging_output = $this->get_foogallery_argument( $gallery, 'paging_output', 'paging_output', '' );
						//add the items to the option if paging_output is set to JSON
						if ( '' === $paging_output && $paging_size > 0 ) {
							//build up the arguments from the gallery template

							$attachments      = array_slice( $gallery->attachments(), $paging_size );
							$json_objects     = array_map( 'foogallery_build_json_object_from_attachment', $attachments );
							$options['items'] = $json_objects;
						}
					}
				}
			}
			return $options;
		}

		private function get_foogallery_argument( $gallery, $setting_id, $argument_name, $default_value ) {
			global $current_foogallery_arguments;

			if ( isset( $current_foogallery_arguments ) && isset( $current_foogallery_arguments[$argument_name] ) ) {
				return $current_foogallery_arguments[$argument_name];
			} else {
				return $gallery->get_setting( $setting_id, $default_value );
			}
		}

		/**
		 * Build up a arguments used in the preview of the gallery
		 *
		 * @param $args
		 * @param $post_data
		 * @param $template
		 *
		 * @return mixed
		 */
		function preview_arguments( $args, $post_data, $template ) {
			$template_data = foogallery_get_gallery_template( $template );

			//check the template supports paging
			if ( $template_data && array_key_exists( 'paging_support', $template_data ) && true === $template_data['paging_support'] ) {
				$args['paging'] = $post_data[FOOGALLERY_META_SETTINGS][$template. '_paging_type'];
				$args['paging_position'] = $post_data[FOOGALLERY_META_SETTINGS][$template. '_paging_position'];
				$args['paging_theme'] = $post_data[FOOGALLERY_META_SETTINGS][$template. '_paging_theme'];
				$args['paging_size'] = $post_data[FOOGALLERY_META_SETTINGS][$template. '_paging_size'];
				$args['paging_scroll'] = $post_data[FOOGALLERY_META_SETTINGS][$template. '_paging_scroll'];
				$args['paging_output'] = $post_data[FOOGALLERY_META_SETTINGS][$template. '_paging_output'];

				$args['paging_limit'] = $post_data[FOOGALLERY_META_SETTINGS][$template. '_paging_limit'];
				$args['paging_showFirstLast'] = $post_data[FOOGALLERY_META_SETTINGS][$template. '_paging_showFirstLast'];
				$args['paging_showPrevNext'] = $post_data[FOOGALLERY_META_SETTINGS][$template. '_paging_showPrevNext'];
				$args['paging_showPrevNextMore'] = $post_data[FOOGALLERY_META_SETTINGS][$template. '_paging_showPrevNextMore'];
			}

			return $args;
		}

		/**
		 * Checks if the gallery output is JSON
		 *
		 * @param FooGallery $gallery
		 * @return bool
		 */
		function is_paging_output_json($gallery) {
			if ( isset( $gallery->paging ) && true === $gallery->paging ) {
				$paging_output = $this->get_foogallery_argument( $gallery, 'paging_output', 'paging_output', '' );
				return '' === $paging_output;
			}
			return false;
		}

        /**
         * Override the attachments returned for rendering a paginated gallery
         *
         * @param bool $override
         * @param FooGallery $gallery
         * @return bool|array
         */
		function attachments_override( $override, $gallery ) {

            if ( $this->is_paging_output_json( $gallery ) ) {

                $page_size = isset( $gallery->paging_options ) && array_key_exists( 'size', $gallery->paging_options ) ? $gallery->paging_options['size'] : 0;

                if ( $page_size > 0 ) {

                    $attachments = $gallery->attachments();

                    //return the first N attachments for the gallery
                    return array_splice( $attachments, 0, $page_size );

                }
            }

            return $override;
        }

		/**
		 * Output a script block with all the gallery attachments as json
		 *
		 * @param FooGallery $gallery
		 */
		function output_paging_script_block( $gallery ) {
			if ( 'on' === foogallery_get_setting( 'output_json_to_script_block', '') ) {
				if ( $this->is_paging_output_json( $gallery ) ) {
					$page_size = isset( $gallery->paging_options ) && array_key_exists( 'size', $gallery->paging_options ) ? $gallery->paging_options['size'] : 0;
					if ( $page_size > 0 ) {
						//build up the arguments from the gallery template
						$attachments      = array_slice( $gallery->attachments(), $page_size );
						$attachments_json = array_map( 'foogallery_build_json_from_attachment', $attachments );
						echo '<script type="text/javascript">';
						echo '  window["foogallery-gallery-' . $gallery->ID . '-items"] = [';
						echo implode( ', ', $attachments_json );
						echo '  ];';
						echo '</script>';
					}
				}
			}
		}
	}
}

GitHub Access Token became invalid

Issues (1881)

Security Analysis not enabled

includes/class-foogallery-paging.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

1			<?php
2			/**
3			* Class used to handle paging for gallery templates
4			*/
5			if ( ! class_exists( 'FooGallery_Paging' ) ) {
6
7			class FooGallery_Paging {
8
9			function __construct() {
10			if ( is_admin() ) {
11			//add extra fields to the templates that support paging
12			add_filter( 'foogallery_override_gallery_template_fields', array( $this, 'add_paging_fields' ), 10, 2 );
13
14			//build up any preview arguments
15			add_filter( 'foogallery_preview_arguments', array( $this, 'preview_arguments' ), 10, 3 );
16			}
17
18			//adds the paging property to a FooGallery
19			add_action( 'foogallery_located_template', array( $this, 'determine_paging' ), 10, 2 );
20
21			//add the paging attributes to the gallery container
22			add_filter( 'foogallery_build_container_data_options', array( $this, 'add_paging_options' ), 20, 3 );
23
24			//limit the number of attachments returned when rendering a gallery
25			add_filter( 'foogallery_gallery_attachments_override_for_rendering', array( $this, 'attachments_override' ), 10, 3 );
26
27			//output a script block with the rest of the attachments as json
28			add_action( 'foogallery_loaded_template', array( $this, 'output_paging_script_block' ) );
29			}
30
31			/**
32			* Add paging fields to the gallery template
33			*
34			* @uses "foogallery_override_gallery_template_fields"
35			* @param $fields
36			* @param $template
37			*
38			* @return array
39			*/
40			function add_paging_fields( $fields, $template ) {
41			if ( $template && array_key_exists( 'paging_support', $template ) && true === $template['paging_support'] ) {
42			$fields[] = array(
43			'id' => 'paging_type',
44			'title' => __( 'Paging Type', 'foogallery' ),
45			'desc' => __( 'Add paging to a large gallery.', 'foogallery' ),
46			'section' => __( 'Paging', 'foogallery' ),
47			'spacer' => '<span class="spacer"></span>',
48			'type' => 'radio',
49			'default' => '',
50			'choices' => apply_filters( 'foogallery_gallery_template_paging_type_choices', array(
51			'' => __( 'None', 'foogallery' ),
52			'dots' => __( 'Dots', 'foogallery' )
53			) ),
54			'row_data'=> array(
55			'data-foogallery-change-selector' => 'input',
56			'data-foogallery-preview' => 'shortcode',
57			'data-foogallery-value-selector' => 'input:checked',
58			)
59			);
60
61			$fields[] = array(
62			'id' => 'paging_size',
63			'title' => __( 'Page Size', 'foogallery' ),
64			'desc' => __( 'The size of your pages.', 'foogallery' ),
65			'section' => __( 'Paging', 'foogallery' ),
66			'type' => 'number',
67			'class' => 'small-text',
68			'default' => 20,
69			'step' => '1',
70			'min' => '0',
71			'row_data'=> array(
72			'data-foogallery-change-selector' => 'input',
73			'data-foogallery-preview' => 'shortcode',
74			'data-foogallery-hidden' => true,
75			'data-foogallery-show-when-field' => 'paging_type',
76			'data-foogallery-show-when-field-operator' => '!==',
77			'data-foogallery-show-when-field-value' => '',
78			)
79			);
80
81			$fields[] = array(
82			'id' => 'paging_position',
83			'title' => __( 'Position', 'foogallery' ),
84			'desc' => __( 'The position of the paging for either dots or pagination.', 'foogallery' ),
85			'section' => __( 'Paging', 'foogallery' ),
86			'spacer' => '<span class="spacer"></span>',
87			'type' => 'radio',
88			'default' => 'both',
89			'choices' => apply_filters( 'foogallery_gallery_template_paging_position_choices', array(
90			'' => __( 'None', 'foogallery' ),
91			'top' => __( 'Top', 'foogallery' ),
92			'bottom' => __( 'Bottom', 'foogallery' ),
93			'both' => __( 'Both', 'foogallery' )
94			) ),
95			'row_data'=> array(
96			'data-foogallery-hidden' => true,
97			'data-foogallery-show-when-field-operator' => 'regex',
98			'data-foogallery-show-when-field' => 'paging_type',
99			'data-foogallery-show-when-field-value' => 'dots\|pagination',
100			'data-foogallery-change-selector' => 'input',
101			'data-foogallery-preview' => 'shortcode'
102			)
103			);
104
105			$fields[] = array(
106			'id' => 'paging_theme',
107			'title' => __( 'Theme', 'foogallery' ),
108			'desc' => __( 'The theme used for paging.', 'foogallery' ),
109			'section' => __( 'Paging', 'foogallery' ),
110			'spacer' => '<span class="spacer"></span>',
111			'type' => 'radio',
112			'default' => 'fg-light',
113			'choices' => apply_filters( 'foogallery_gallery_template_paging_theme_choices', array(
114			'fg-light' => __( 'Light', 'foogallery' ),
115			'fg-dark' => __( 'Dark', 'foogallery' ),
116			) ),
117			'row_data'=> array(
118			'data-foogallery-change-selector' => 'input',
119			'data-foogallery-preview' => 'shortcode',
120			'data-foogallery-hidden' => true,
121			'data-foogallery-show-when-field' => 'paging_type',
122			'data-foogallery-show-when-field-operator' => '!==',
123			'data-foogallery-show-when-field-value' => '',
124			)
125			);
126
127			$fields[] = array(
128			'id' => 'paging_scroll',
129			'title' => __( 'Scroll To Top', 'foogallery' ),
130			'desc' => __( 'Whether or not it should scroll to the top of the gallery when paging is changed.', 'foogallery' ),
131			'section' => __( 'Paging', 'foogallery' ),
132			'type' => 'radio',
133			'spacer' => '<span class="spacer"></span>',
134			'default' => 'true',
135			'choices' => array(
136			'true' => __( 'Yes', 'foogallery' ),
137			'false' => __( 'No', 'foogallery' ),
138			),
139			'row_data'=> array(
140			'data-foogallery-hidden' => true,
141			'data-foogallery-show-when-field-operator' => 'regex',
142			'data-foogallery-show-when-field' => 'paging_type',
143			'data-foogallery-show-when-field-value' => 'dots\|pagination',
144			'data-foogallery-change-selector' => 'input',
145			'data-foogallery-preview' => 'shortcode'
146			)
147			);
148
149			$fields[] = array(
150			'id' => 'paging_limit',
151			'title' => __( 'Paging Limit', 'foogallery' ),
152			'desc' => __( 'The maximum number of page links to display for the gallery.', 'foogallery' ),
153			'section' => __( 'Paging', 'foogallery' ),
154			'type' => 'number',
155			'class' => 'small-text',
156			'default' => 5,
157			'step' => '1',
158			'min' => '0',
159			'row_data'=> array(
160			'data-foogallery-hidden' => true,
161			'data-foogallery-show-when-field' => 'paging_type',
162			'data-foogallery-show-when-field-value' => 'pagination',
163			'data-foogallery-change-selector' => 'input',
164			'data-foogallery-preview' => 'shortcode'
165			)
166			);
167
168			$fields[] = array(
169			'id' => 'paging_showFirstLast',
170			'title' => __( 'First & Last Buttons', 'foogallery' ),
171			'desc' => __( 'Whether or not to show the first & last buttons for pagination.', 'foogallery' ),
172			'section' => __( 'Paging', 'foogallery' ),
173			'type' => 'radio',
174			'spacer' => '<span class="spacer"></span>',
175			'default' => 'true',
176			'choices' => array(
177			'true' => __( 'Show', 'foogallery' ),
178			'false' => __( 'Hide', 'foogallery' ),
179			),
180			'row_data'=> array(
181			'data-foogallery-hidden' => true,
182			'data-foogallery-show-when-field' => 'paging_type',
183			'data-foogallery-show-when-field-value' => 'pagination',
184			'data-foogallery-change-selector' => 'input',
185			'data-foogallery-preview' => 'shortcode'
186			)
187			);
188
189			$fields[] = array(
190			'id' => 'paging_showPrevNext',
191			'title' => __( 'Prev & Next Buttons', 'foogallery' ),
192			'desc' => __( 'Whether or not to show the previous & next buttons for pagination.', 'foogallery' ),
193			'section' => __( 'Paging', 'foogallery' ),
194			'type' => 'radio',
195			'spacer' => '<span class="spacer"></span>',
196			'default' => 'true',
197			'choices' => array(
198			'true' => __( 'Show', 'foogallery' ),
199			'false' => __( 'Hide', 'foogallery' ),
200			),
201			'row_data'=> array(
202			'data-foogallery-hidden' => true,
203			'data-foogallery-show-when-field' => 'paging_type',
204			'data-foogallery-show-when-field-value' => 'pagination',
205			'data-foogallery-change-selector' => 'input',
206			'data-foogallery-preview' => 'shortcode'
207			)
208			);
209
210			$fields[] = array(
211			'id' => 'paging_showPrevNextMore',
212			'title' => __( 'More Buttons', 'foogallery' ),
213			'desc' => __( 'Whether or not to show the previous & next more buttons for pagination.', 'foogallery' ),
214			'section' => __( 'Paging', 'foogallery' ),
215			'type' => 'radio',
216			'spacer' => '<span class="spacer"></span>',
217			'default' => 'true',
218			'choices' => array(
219			'true' => __( 'Show', 'foogallery' ),
220			'false' => __( 'Hide', 'foogallery' ),
221			),
222			'row_data'=> array(
223			'data-foogallery-hidden' => true,
224			'data-foogallery-show-when-field' => 'paging_type',
225			'data-foogallery-show-when-field-value' => 'pagination',
226			'data-foogallery-change-selector' => 'input',
227			'data-foogallery-preview' => 'shortcode'
228			)
229			);
230
231			$fields[] = array(
232			'id' => 'paging_output',
233			'title' => __( 'Paging Output', 'foogallery' ),
234			'desc' => __( 'How the paging items are output. We recommend that very large galleries output as JSON.', 'foogallery' ),
235			'section' => __( 'Paging', 'foogallery' ),
236			'spacer' => '<span class="spacer"></span>',
237			'type' => 'radio',
238			'default' => 'html',
239			'choices' => apply_filters( 'foogallery_gallery_template_paging_output_choices', array(
240			'' => __( 'JSON', 'foogallery' ),
241			'html' => __( 'HTML', 'foogallery' )
242			) ),
243			'row_data'=> array(
244			'data-foogallery-change-selector' => 'input',
245			'data-foogallery-preview' => 'shortcode',
246			'data-foogallery-value-selector' => 'input:checked',
247			'data-foogallery-hidden' => true,
248			'data-foogallery-show-when-field' => 'paging_type',
249			'data-foogallery-show-when-field-operator' => '!==',
250			'data-foogallery-show-when-field-value' => '',
251			)
252			);
253			}
254
255			return $fields;
256			}
257
258			/**
259			* Determine if the gallery has paging enabled
260			*
261			* @param $foogallery FooGallery
262			*/
263			function determine_paging( $foogallery ) {
264			$template_data = foogallery_get_gallery_template( $foogallery->gallery_template );
265
266			//check the template supports paging
267			$paging = $template_data && array_key_exists( 'paging_support', $template_data ) && true === $template_data['paging_support'];
268
269			$foogallery->paging = apply_filters( 'foogallery_paging', $paging, $foogallery );
270			}
271
272			/**
273			* Add the required paging options if needed
274			*
275			* @param $attributes array
276			* @param $gallery FooGallery
277			*
278			* @return array
279			*/
280			function add_paging_options($options, $gallery, $attributes) {
			0 ignored issues – show Unused Code introduced 2017-09-05 19:29 UTC by Report Bug Copy Issue Report Show Similar Issues like this The parameter `$attributes` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
281			if ( isset( $gallery->paging ) && true === $gallery->paging) {
282
283			//check if we have arguments from the shortcode and override the saved settings
284			$paging = $this->get_foogallery_argument( $gallery, 'paging_type', 'paging', '' );
285
286			if ( '' !== $paging ) {
287			$paging_position = $this->get_foogallery_argument( $gallery, 'paging_position', 'paging_position', 'both' );
288			$paging_theme = $this->get_foogallery_argument( $gallery, 'paging_theme', 'paging_theme', 'fg-light' );
289			$paging_size = intval( $this->get_foogallery_argument( $gallery, 'paging_size', 'paging_size', '30' ) );
290			$paging_scroll = $this->get_foogallery_argument( $gallery, 'paging_scroll', 'paging_scroll', 'true' ) === 'true';
291
292			//force bottom position for infinite and loadMore paging
293			if ( 'infinite' === $paging \|\| 'loadMore' === $paging ) {
294			$paging_position = 'bottom';
295			}
296
297			$paging_options = array(
298			'type' => $paging,
299			'theme' => $paging_theme,
300			'size' => $paging_size,
301			'position' => $paging_position,
302			'scrollToTop' => $paging_scroll
303			);
304
305			if ( 'pagination' === $paging ) {
306			$paging_options['limit'] = intval( $this->get_foogallery_argument( $gallery, 'paging_limit', 'paging_limit', '5' ) );;
307			$paging_options['showFirstLast'] = $this->get_foogallery_argument( $gallery, 'paging_showFirstLast', 'paging_showFirstLast', 'true' ) === 'true';;
308			$paging_options['showPrevNext'] = $this->get_foogallery_argument( $gallery, 'paging_showPrevNext', 'paging_showPrevNext', 'true' ) === 'true';;
309			$paging_options['showPrevNextMore'] = $this->get_foogallery_argument( $gallery, 'paging_showPrevNextMore', 'paging_showPrevNextMore', 'true' ) === 'true';;
310			}
311
312			$options['paging'] = $gallery->paging_options = $paging_options;
313
314			if ( 'on' !== foogallery_get_setting( 'output_json_to_script_block', '') ) {
315			$paging_output = $this->get_foogallery_argument( $gallery, 'paging_output', 'paging_output', '' );
316			//add the items to the option if paging_output is set to JSON
317			if ( '' === $paging_output && $paging_size > 0 ) {
318			//build up the arguments from the gallery template
319
320			$attachments = array_slice( $gallery->attachments(), $paging_size );
321			$json_objects = array_map( 'foogallery_build_json_object_from_attachment', $attachments );
322			$options['items'] = $json_objects;
323			}
324			}
325			}
326			}
327			return $options;
328			}
329
330			private function get_foogallery_argument( $gallery, $setting_id, $argument_name, $default_value ) {
331			global $current_foogallery_arguments;
332
333			if ( isset( $current_foogallery_arguments ) && isset( $current_foogallery_arguments[$argument_name] ) ) {
334			return $current_foogallery_arguments[$argument_name];
335			} else {
336			return $gallery->get_setting( $setting_id, $default_value );
337			}
338			}
339
340			/**
341			* Build up a arguments used in the preview of the gallery
342			*
343			* @param $args
344			* @param $post_data
345			* @param $template
346			*
347			* @return mixed
348			*/
349			function preview_arguments( $args, $post_data, $template ) {
350			$template_data = foogallery_get_gallery_template( $template );
351
352			//check the template supports paging
353			if ( $template_data && array_key_exists( 'paging_support', $template_data ) && true === $template_data['paging_support'] ) {
354			$args['paging'] = $post_data[FOOGALLERY_META_SETTINGS][$template. '_paging_type'];
355			$args['paging_position'] = $post_data[FOOGALLERY_META_SETTINGS][$template. '_paging_position'];
356			$args['paging_theme'] = $post_data[FOOGALLERY_META_SETTINGS][$template. '_paging_theme'];
357			$args['paging_size'] = $post_data[FOOGALLERY_META_SETTINGS][$template. '_paging_size'];
358			$args['paging_scroll'] = $post_data[FOOGALLERY_META_SETTINGS][$template. '_paging_scroll'];
359			$args['paging_output'] = $post_data[FOOGALLERY_META_SETTINGS][$template. '_paging_output'];
360
361			$args['paging_limit'] = $post_data[FOOGALLERY_META_SETTINGS][$template. '_paging_limit'];
362			$args['paging_showFirstLast'] = $post_data[FOOGALLERY_META_SETTINGS][$template. '_paging_showFirstLast'];
363			$args['paging_showPrevNext'] = $post_data[FOOGALLERY_META_SETTINGS][$template. '_paging_showPrevNext'];
364			$args['paging_showPrevNextMore'] = $post_data[FOOGALLERY_META_SETTINGS][$template. '_paging_showPrevNextMore'];
365			}
366
367			return $args;
368			}
369
370			/**
371			* Checks if the gallery output is JSON
372			*
373			* @param FooGallery $gallery
374			* @return bool
375			*/
376			function is_paging_output_json($gallery) {
377			if ( isset( $gallery->paging ) && true === $gallery->paging ) {
378			$paging_output = $this->get_foogallery_argument( $gallery, 'paging_output', 'paging_output', '' );
379			return '' === $paging_output;
380			}
381			return false;
382			}
383
384			/**
385			* Override the attachments returned for rendering a paginated gallery
386			*
387			* @param bool $override
388			* @param FooGallery $gallery
389			* @return bool\|array
390			*/
391			function attachments_override( $override, $gallery ) {
392
393			if ( $this->is_paging_output_json( $gallery ) ) {
394
395			$page_size = isset( $gallery->paging_options ) && array_key_exists( 'size', $gallery->paging_options ) ? $gallery->paging_options['size'] : 0;
396
397			if ( $page_size > 0 ) {
398
399			$attachments = $gallery->attachments();
400
401			//return the first N attachments for the gallery
402			return array_splice( $attachments, 0, $page_size );
403
404			}
405			}
406
407			return $override;
408			}
409
410			/**
411			* Output a script block with all the gallery attachments as json
412			*
413			* @param FooGallery $gallery
414			*/
415			function output_paging_script_block( $gallery ) {
416			if ( 'on' === foogallery_get_setting( 'output_json_to_script_block', '') ) {
417			if ( $this->is_paging_output_json( $gallery ) ) {
418			$page_size = isset( $gallery->paging_options ) && array_key_exists( 'size', $gallery->paging_options ) ? $gallery->paging_options['size'] : 0;
419			if ( $page_size > 0 ) {
420			//build up the arguments from the gallery template
421			$attachments = array_slice( $gallery->attachments(), $page_size );
422			$attachments_json = array_map( 'foogallery_build_json_from_attachment', $attachments );
423			echo '<script type="text/javascript">';
424			echo ' window["foogallery-gallery-' . $gallery->ID . '-items"] = [';
425			echo implode( ', ', $attachments_json );
426			echo ' ];';
427			echo '</script>';
428			}
429			}
430			}
431			}
432			}
433			}

fooplugins / foogallery

GitHub Access Token became invalid

Issues (1881)

Security Analysis not enabled

includes/class-foogallery-paging.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like