functions.php ➔ foogallery_gallery_image_count_text() - Code Metrics - Inspection of "updated view" - fooplugins/foogallery - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/video-support ( 96814b )

by Brad

created 2018-06-22 10:58 UTC

functions.php ➔ foogallery_gallery_image_count_text() C

↳ Parent: Project

Complexity

Conditions	8
Paths	4

Size

Total Lines	25
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	8
eloc	16
nc	4
nop	3
dl	0
loc	25
rs	5.3846
c	0
b	0
f	0

<?php
/**
 * Useful functions for FooGallery PRO Videos
 */

/**
 * Returns the number of videos for a specific gallery
 * @param $post_id
 *
 * @return int
 */
function foogallery_get_gallery_video_count( $post_id ) {
	$video_count = get_post_meta( $post_id , FOOGALLERY_VIDEO_POST_META_VIDEO_COUNT, true );

	if ( !empty( $video_count ) ) {
		return absint( $video_count );
	}

	return 0;
}

/**
 * Sets the number of videos for a gallery
 *
 * @param $post_id
 */
function foogallery_set_gallery_video_count( $post_id ) {
	$video_count = foogallery_calculate_gallery_video_count( $post_id );
	if ( $video_count > 0 ) {
		update_post_meta( $post_id, FOOGALLERY_VIDEO_POST_META_VIDEO_COUNT, $video_count );
	} else {
		delete_post_meta( $post_id, FOOGALLERY_VIDEO_POST_META_VIDEO_COUNT );
	}
}

/**
 * Calculates the number of videos for a gallery
 * @param $post_id
 *
 * @return int
 */
function foogallery_calculate_gallery_video_count( $post_id ) {
	$video_count = 0;
	$gallery = FooGallery::get_by_id( $post_id );

	foreach ( $gallery->attachments() as $attachment ) {
		if ( foogallery_is_attachment_video( $attachment ) ) {
			//this attachment is a video
			$video_count++;
		}
	}
	return $video_count;
}

/**
 * Determines if an attachment is a video
 *
 * @param      $attachment_id
 *
 * @param FooGalleryAttachment $foogallery_attachment
 *
 * @return bool
 */
function foogallery_is_attachment_video( $foogallery_attachment ) {
	if ( isset( $foogallery_attachment ) && isset( $foogallery_attachment->_post ) ) {
		if ( 'image/foogallery' === $foogallery_attachment->_post->post_mime_type ) {
			//we are definitely dealing with a video
			return true;
		}
	}

	//allow legacy to override
	return apply_filters( 'foogallery_is_attachment_video', false, $foogallery_attachment );
}

/**
 * Returns the video and image count for a gallery
 *
 * @param $total_count
 * @param $image_count
 * @param $video_count
 *
 * @return string|void
 */
function foogallery_gallery_image_count_text( $total_count, $image_count, $video_count ) {
	//get image count text strings
	$images_single_text = foogallery_get_setting( 'language_images_count_single_text', __( '1 image', 'foogallery' ) );
	$images_plural_text = foogallery_get_setting( 'language_images_count_plural_text', __( '%s images', 'foogallery' ) );

	//get video count text strings
	$videos_none_text   = foogallery_get_setting( 'language_video_count_none_text',   __( 'No images or videos', 'foogallery' ) );
	$videos_single_text = foogallery_get_setting( 'language_video_count_single_text', __( '1 video', 'foogallery' ) );
	$videos_plural_text = foogallery_get_setting( 'language_video_count_plural_text', __( '%s videos', 'foogallery' ) );

	if ( 0 == $total_count ) {
		return $videos_none_text;
	} else if ( 0 == $video_count ) {
		//return the original text
		return sprintf( 1 == $image_count ? $images_single_text : $images_plural_text, $image_count );
	} else if ( 0 == $image_count ) {
		//we only have videos
		return sprintf( 1 == $video_count ? $videos_single_text : $videos_plural_text, $video_count );
	} else {
		//we have a mix of images and videos
		return sprintf( 1 == $image_count ? $images_single_text : $images_plural_text, $image_count )
		       . '; ' .
		       sprintf( 1 == $video_count ? $videos_single_text : $videos_plural_text, $video_count );
	}
}

///**
// * Custom encoding for JSON so that special characters are handled correctly
// *
// * @param $data
// *
// * @return string
// */
//function foogallery_esc_json_encode( $data ) {
//	if ( defined( 'JSON_HEX_AMP' ) ) {
//		// This is nice to have, but not strictly necessary since we use _wp_specialchars() below
//		$data = json_encode( $data, JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_HEX_QUOT );
//	} else {
//		$data = json_encode( $data );
//	}
//	return _wp_specialchars( $data, ENT_QUOTES, false, true );
//}

/**
 * Cleans the video URL before sending it to the client
 *
 * @param String $url The URL of the video in question
 *
 * @return String the cleaned up video URL
 */
function foogallery_clean_video_url( $url ) {
	//make the video URL Protocol-relative to cater for sites that are HTTPS
	$url = str_replace( 'http://', '//', $url );

	return apply_filters( 'foogallery_clean_video_url', $url );
}

/**
 * Build up the URL to the video URL from a FooGalleryAttachment object
 *
 * @param $attachment FooGalleryAttachment The attachment we want to extract the URL from
 *
 * @return String the video URL for the attachment
 */
function foogallery_get_video_url_from_attachment( $attachment ) {
	if ( empty( $attachment ) ) return '';

	$url = $attachment->custom_url;

	//append autoplay querystring
	$autoplay = foogallery_gallery_template_setting( 'video_autoplay', 'yes' );
	if ( 'yes' === $autoplay ) {
		$url = add_query_arg( 'autoplay', '1', $url );
	}

	return foogallery_clean_video_url( $url );
}

function foogallery_get_video_thumbnail_from_attachment( $attachment ) {
	$args = array(
		'width'  => 90,
		'height' => 90,
		'crop'   => true
	);

	return apply_filters( 'foogallery_attachment_resize_thumbnail', $attachment->url, $args, $attachment );
}

/**
 * Takes a URL and attempts to return the oEmbed data.
 *
 * @param string $url The URL to the content that should be attempted to be embedded.
 * @param array|string $args Optional. Arguments, usually passed from a shortcode. Default empty.
 * @return false|object False on failure, otherwise the result in the form of an object.
 *
 * @see WP_oEmbed::get_data()
 *
 * @description This method is a duplicate of the WP_oEmbed::get_data() method as it was only
 * included since WordPress 4.8.0.
 */
function foogallery_oembed_get_data($url, $args = '') {
	$oembed = _wp_oembed_get_object();
	$args = wp_parse_args($args);

	$provider = $oembed->get_provider($url, $args);

	if (!$provider) {
		return false;
	}

	$data = $oembed->fetch($provider, $url, $args);

	if (false === $data) {
		return false;
	}

	return $data;
}

1			<?php
2			/**
3			* Useful functions for FooGallery PRO Videos
4			*/
5
6			/**
7			* Returns the number of videos for a specific gallery
8			* @param $post_id
9			*
10			* @return int
11			*/
12			function foogallery_get_gallery_video_count( $post_id ) {
13			$video_count = get_post_meta( $post_id , FOOGALLERY_VIDEO_POST_META_VIDEO_COUNT, true );
14
15			if ( !empty( $video_count ) ) {
16			return absint( $video_count );
17			}
18
19			return 0;
20			}
21
22			/**
23			* Sets the number of videos for a gallery
24			*
25			* @param $post_id
26			*/
27			function foogallery_set_gallery_video_count( $post_id ) {
28			$video_count = foogallery_calculate_gallery_video_count( $post_id );
29			if ( $video_count > 0 ) {
30			update_post_meta( $post_id, FOOGALLERY_VIDEO_POST_META_VIDEO_COUNT, $video_count );
31			} else {
32			delete_post_meta( $post_id, FOOGALLERY_VIDEO_POST_META_VIDEO_COUNT );
33			}
34			}
35
36			/**
37			* Calculates the number of videos for a gallery
38			* @param $post_id
39			*
40			* @return int
41			*/
42			function foogallery_calculate_gallery_video_count( $post_id ) {
43			$video_count = 0;
44			$gallery = FooGallery::get_by_id( $post_id );
45
46			foreach ( $gallery->attachments() as $attachment ) {
47			if ( foogallery_is_attachment_video( $attachment ) ) {
48			//this attachment is a video
49			$video_count++;
50			}
51			}
52			return $video_count;
53			}
54
55			/**
56			* Determines if an attachment is a video
57			*
58			* @param $attachment_id
59			*
60			* @param FooGalleryAttachment $foogallery_attachment
61			*
62			* @return bool
63			*/
64			function foogallery_is_attachment_video( $foogallery_attachment ) {
65			if ( isset( $foogallery_attachment ) && isset( $foogallery_attachment->_post ) ) {
66			if ( 'image/foogallery' === $foogallery_attachment->_post->post_mime_type ) {
67			//we are definitely dealing with a video
68			return true;
69			}
70			}
71
72			//allow legacy to override
73			return apply_filters( 'foogallery_is_attachment_video', false, $foogallery_attachment );
74			}
75
76			/**
77			* Returns the video and image count for a gallery
78			*
79			* @param $total_count
80			* @param $image_count
81			* @param $video_count
82			*
83			* @return string\|void
84			*/
85			function foogallery_gallery_image_count_text( $total_count, $image_count, $video_count ) {
86			//get image count text strings
87			$images_single_text = foogallery_get_setting( 'language_images_count_single_text', __( '1 image', 'foogallery' ) );
88			$images_plural_text = foogallery_get_setting( 'language_images_count_plural_text', __( '%s images', 'foogallery' ) );
89
90			//get video count text strings
91			$videos_none_text = foogallery_get_setting( 'language_video_count_none_text', __( 'No images or videos', 'foogallery' ) );
92			$videos_single_text = foogallery_get_setting( 'language_video_count_single_text', __( '1 video', 'foogallery' ) );
93			$videos_plural_text = foogallery_get_setting( 'language_video_count_plural_text', __( '%s videos', 'foogallery' ) );
94
95			if ( 0 == $total_count ) {
96			return $videos_none_text;
97			} else if ( 0 == $video_count ) {
98			//return the original text
99			return sprintf( 1 == $image_count ? $images_single_text : $images_plural_text, $image_count );
100			} else if ( 0 == $image_count ) {
101			//we only have videos
102			return sprintf( 1 == $video_count ? $videos_single_text : $videos_plural_text, $video_count );
103			} else {
104			//we have a mix of images and videos
105			return sprintf( 1 == $image_count ? $images_single_text : $images_plural_text, $image_count )
106			. '; ' .
107			sprintf( 1 == $video_count ? $videos_single_text : $videos_plural_text, $video_count );
108			}
109			}
110
111			///**
112			// * Custom encoding for JSON so that special characters are handled correctly
113			// *
114			// * @param $data
115			// *
116			// * @return string
117			// */
118			//function foogallery_esc_json_encode( $data ) {
119			// if ( defined( 'JSON_HEX_AMP' ) ) {
120			// // This is nice to have, but not strictly necessary since we use _wp_specialchars() below
121			// $data = json_encode( $data, JSON_HEX_TAG \| JSON_HEX_AMP \| JSON_HEX_APOS \| JSON_HEX_QUOT );
122			// } else {
123			// $data = json_encode( $data );
124			// }
125			// return _wp_specialchars( $data, ENT_QUOTES, false, true );
126			//}
127
128			/**
129			* Cleans the video URL before sending it to the client
130			*
131			* @param String $url The URL of the video in question
132			*
133			* @return String the cleaned up video URL
134			*/
135			function foogallery_clean_video_url( $url ) {
136			//make the video URL Protocol-relative to cater for sites that are HTTPS
137			$url = str_replace( 'http://', '//', $url );
138
139			return apply_filters( 'foogallery_clean_video_url', $url );
140			}
141
142			/**
143			* Build up the URL to the video URL from a FooGalleryAttachment object
144			*
145			* @param $attachment FooGalleryAttachment The attachment we want to extract the URL from
146			*
147			* @return String the video URL for the attachment
148			*/
149			function foogallery_get_video_url_from_attachment( $attachment ) {
150			if ( empty( $attachment ) ) return '';
151
152			$url = $attachment->custom_url;
153
154			//append autoplay querystring
155			$autoplay = foogallery_gallery_template_setting( 'video_autoplay', 'yes' );
156			if ( 'yes' === $autoplay ) {
157			$url = add_query_arg( 'autoplay', '1', $url );
158			}
159
160			return foogallery_clean_video_url( $url );
161			}
162
163			function foogallery_get_video_thumbnail_from_attachment( $attachment ) {
164			$args = array(
165			'width' => 90,
166			'height' => 90,
167			'crop' => true
168			);
169
170			return apply_filters( 'foogallery_attachment_resize_thumbnail', $attachment->url, $args, $attachment );
171			}
172
173			/**
174			* Takes a URL and attempts to return the oEmbed data.
175			*
176			* @param string $url The URL to the content that should be attempted to be embedded.
177			* @param array\|string $args Optional. Arguments, usually passed from a shortcode. Default empty.
178			* @return false\|object False on failure, otherwise the result in the form of an object.
179			*
180			* @see WP_oEmbed::get_data()
181			*
182			* @description This method is a duplicate of the WP_oEmbed::get_data() method as it was only
183			* included since WordPress 4.8.0.
184			*/
185			function foogallery_oembed_get_data($url, $args = '') {
186			$oembed = _wp_oembed_get_object();
187			$args = wp_parse_args($args);
188
189			$provider = $oembed->get_provider($url, $args);
190
191			if (!$provider) {
192			return false;
193			}
194
195			$data = $oembed->fetch($provider, $url, $args);
196
197			if (false === $data) {
198			return false;
199			}
200
201			return $data;
202			}

fooplugins / foogallery

GitHub Access Token became invalid

Push — feature/video-support ( 96814b )

functions.php ➔ foogallery_gallery_image_count_text() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like