FooGalleryAttachment::html_img_src() - Code Metrics - Inspection of "removed unused album settings. These can be set fr..." - fooplugins/foogallery - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/gallery-datasources ( 744111...91cd91 )

by Brad

created 2016-10-29 10:59 UTC

FooGalleryAttachment::html_img_src() A

↳ Parent: FooGalleryAttachment

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php
/**
 * Class FooGalleryAttachment
 *
 * An easy to use wrapper class for a FooGallery Attachment
 */
if ( ! class_exists( 'FooGalleryAttachment' ) ) {

	class FooGalleryAttachment extends stdClass {
		/**
		 * public constructor
		 *
		 * @param null $post
		 */
		public function __construct( $post = null ) {
			$this->set_defaults();

			if ( $post !== null ) {
				$this->load( $post );
			}
		}

		/**
		 *  Sets the default when a new gallery is instantiated
		 */
		private function set_defaults() {
			$this->_post = null;
			$this->ID = 0;
			$this->title = '';
			$this->caption = '';
			$this->description = '';
			$this->alt = '';
			$this->url = '';
			$this->width = 0;
			$this->height = 0;
			$this->custom_url = '';
			$this->custom_target = '';
		}

		/**
		 * private attachment load function
		 * @param $post
		 */
		private function load( $post ) {
			$this->_post = $post;
			$this->ID = $post->ID;
			$this->title = trim( $post->post_title );
			$this->caption = foogallery_get_caption_title_for_attachment( $post );
			$this->description = foogallery_get_caption_desc_for_attachment( $post );
			$this->alt = trim( get_post_meta( $this->ID, '_wp_attachment_image_alt', true ) );
			$this->custom_url = get_post_meta( $this->ID, '_foogallery_custom_url', true );
			$this->custom_target = get_post_meta( $this->ID, '_foogallery_custom_target', true );
			$image_attributes = wp_get_attachment_image_src( $this->ID, 'full' );
			if ( $image_attributes ) {
				$this->url = $image_attributes[0];
				$this->width = $image_attributes[1];
				$this->height = $image_attributes[2];
			}
		}

		/**
		 * Static function to load a FooGalleryAttachment instance by passing in a post object
		 * @static
		 *
		 * @param $post
		 *
		 * @return FooGalleryAttachment
		 */
		public static function get( $post ) {
			return new self( $post );
		}

		/**
		 * Static function to load a FooGalleryAttachment instance by passing in an attachment_id
		 * @static
		 *
		 * @param $attachment_id
		 *
		 * @return FooGalleryAttachment
		 */
		public static function get_by_id( $attachment_id ) {
			$post = get_post( $attachment_id );
			return new self( $post );
		}

		/**
		 * Returns the image source only
		 *
		 * @param array $args
		 * @return string
		 */
		public function html_img_src( $args = array() ) {
			return apply_filters( 'foogallery_attachment_resize_thumbnail', $this->url, $args, $this );
		}

		/**
		 * Returns the HTML img tag for the attachment
		 * @param array $args
		 *
		 * @return string
		 */
		public function html_img( $args = array() ) {
			$attr['src'] = $this->html_img_src( $args );
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

			if ( ! empty( $this->alt ) ) {
				$attr['alt'] = $this->alt;
			}

			//pull any custom attributes out the args
			if ( isset( $args['image_attributes'] ) && is_array( $args['image_attributes'] ) ) {
				$attr = array_merge( $attr, $args['image_attributes'] );
			}

			//check for width and height args and add those to the image
			if ( isset( $args['width'] ) && intval( $args['width'] ) > 0 ) {
				$attr['width'] = $args['width'];
			}
			if ( isset( $args['height'] ) && intval( $args['height'] ) > 0 ) {
				$attr['height'] = $args['height'];
			}

			$attr = apply_filters( 'foogallery_attachment_html_image_attributes', $attr, $args, $this );
			$attr = array_map( 'esc_attr', $attr );
			$html = '<img ';
			foreach ( $attr as $name => $value ) {
				$html .= " $name=" . '"' . $value . '"';
			}
			$html .= ' />';

			return apply_filters( 'foogallery_attachment_html_image', $html, $args, $this );
		}

		/**
		 * Returns HTML for the attachment
		 * @param array $args
		 * @param bool $output_image
		 * @param bool $output_closing_tag
		 *
		 * @return string
		 */
		public function html( $args = array(), $output_image = true, $output_closing_tag = true ) {
			if ( empty ( $this->url ) )  {
				return '';
			}

			$arg_defaults = array(
				'link' => 'image',
				'custom_link' => $this->custom_url
			);

			$args = wp_parse_args( $args, $arg_defaults );

			$link = $args['link'];

			$img = $this->html_img( $args );

			/* 12 Apr 2016 - PLEASE NOTE
			We no longer just return the image html when "no link" option is chosen.
			It was decided that it is better to return an anchor link with no href or target attributes.
			This results in more standardized HTML output for better CSS and JS code
			*/

			if ( 'page' === $link ) {
				//get the URL to the attachment page
				$url = get_attachment_link( $this->ID );
			} else if ( 'custom' === $link ) {
				$url = $args['custom_link'];
			} else {
				$url = $this->url;
			}

			//fallback for images that might not have a custom url
			if ( empty( $url ) ) {
				$url = $this->url;
			}

			$attr = array();

			//only add href and target attributes to the anchor if the link is NOT set to 'none'
			if ( $link !== 'none' ){
				$attr['href'] = $url;
				if ( ! empty( $this->custom_target ) && 'default' !== $this->custom_target ) {
					$attr['target'] = $this->custom_target;
				}
			}

			if ( ! empty( $this->caption ) ) {
				$attr['data-caption-title'] = $this->caption;
			}

			if ( !empty( $this->description ) ) {
				$attr['data-caption-desc'] = $this->description;
			}

			$attr['data-attachment-id'] = $this->ID;

			//pull any custom attributes out the args
			if ( isset( $args['link_attributes'] ) && is_array( $args['link_attributes'] ) ) {
				$attr = array_merge( $attr, $args['link_attributes'] );
			}

			$attr = apply_filters( 'foogallery_attachment_html_link_attributes', $attr, $args, $this );
			$attr = array_map( 'esc_attr', $attr );
			$html = '<a ';
			foreach ( $attr as $name => $value ) {
				$html .= " $name=" . '"' . $value . '"';
			}
			$html .= '>';
			if ( $output_image ) {
				$html .= $img;
			}
			if ( $output_closing_tag ) {
				$html .= '</a>';
			};

			return apply_filters( 'foogallery_attachment_html_link', $html, $args, $this );
		}

		/**
		 * Returns generic html for captions
		 *
		 * @param $caption_content string Include title, desc, or both
		 *
		 * @return string
		 */
		public function html_caption( $caption_content ) {
			$html = '';
			$caption_html = array();
			if ( $this->caption && ( 'title' === $caption_content || 'both' === $caption_content ) ) {
				$caption_html[] = '<div class="foogallery-caption-title">' . $this->caption . '</div>';
			}
			if ( $this->description && ( 'desc' === $caption_content || 'both' === $caption_content ) ) {
				$caption_html[] = '<div class="foogallery-caption-desc">' . $this->description . '</div>';
			}

			if ( count($caption_html) > 0 ) {
				$html = '<div class="foogallery-caption"><div class="foogallery-caption-inner">';
				$html .= implode( $caption_html );
				$html .= '</div></div>';
			}

			return apply_filters( 'foogallery_attachment_html_caption', $html, $caption_content, $this );
		}
	}
}


1			<?php
2			/**
3			* Class FooGalleryAttachment
4			*
5			* An easy to use wrapper class for a FooGallery Attachment
6			*/
7			if ( ! class_exists( 'FooGalleryAttachment' ) ) {
8
9			class FooGalleryAttachment extends stdClass {
10			/**
11			* public constructor
12			*
13			* @param null $post
14			*/
15			public function __construct( $post = null ) {
16			$this->set_defaults();
17
18			if ( $post !== null ) {
19			$this->load( $post );
20			}
21			}
22
23			/**
24			* Sets the default when a new gallery is instantiated
25			*/
26			private function set_defaults() {
27			$this->_post = null;
28			$this->ID = 0;
29			$this->title = '';
30			$this->caption = '';
31			$this->description = '';
32			$this->alt = '';
33			$this->url = '';
34			$this->width = 0;
35			$this->height = 0;
36			$this->custom_url = '';
37			$this->custom_target = '';
38			}
39
40			/**
41			* private attachment load function
42			* @param $post
43			*/
44			private function load( $post ) {
45			$this->_post = $post;
46			$this->ID = $post->ID;
47			$this->title = trim( $post->post_title );
48			$this->caption = foogallery_get_caption_title_for_attachment( $post );
49			$this->description = foogallery_get_caption_desc_for_attachment( $post );
50			$this->alt = trim( get_post_meta( $this->ID, '_wp_attachment_image_alt', true ) );
51			$this->custom_url = get_post_meta( $this->ID, '_foogallery_custom_url', true );
52			$this->custom_target = get_post_meta( $this->ID, '_foogallery_custom_target', true );
53			$image_attributes = wp_get_attachment_image_src( $this->ID, 'full' );
54			if ( $image_attributes ) {
55			$this->url = $image_attributes[0];
56			$this->width = $image_attributes[1];
57			$this->height = $image_attributes[2];
58			}
59			}
60
61			/**
62			* Static function to load a FooGalleryAttachment instance by passing in a post object
63			* @static
64			*
65			* @param $post
66			*
67			* @return FooGalleryAttachment
68			*/
69			public static function get( $post ) {
70			return new self( $post );
71			}
72
73			/**
74			* Static function to load a FooGalleryAttachment instance by passing in an attachment_id
75			* @static
76			*
77			* @param $attachment_id
78			*
79			* @return FooGalleryAttachment
80			*/
81			public static function get_by_id( $attachment_id ) {
82			$post = get_post( $attachment_id );
83			return new self( $post );
84			}
85
86			/**
87			* Returns the image source only
88			*
89			* @param array $args
90			* @return string
91			*/
92			public function html_img_src( $args = array() ) {
93			return apply_filters( 'foogallery_attachment_resize_thumbnail', $this->url, $args, $this );
94			}
95
96			/**
97			* Returns the HTML img tag for the attachment
98			* @param array $args
99			*
100			* @return string
101			*/
102			public function html_img( $args = array() ) {
103			$attr['src'] = $this->html_img_src( $args );
			0 ignored issues – show Coding Style Comprehensibility introduced 2016-10-29 11:01 UTC by Report Bug Copy Issue Report `$attr` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$attr = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
104
105			if ( ! empty( $this->alt ) ) {
106			$attr['alt'] = $this->alt;
107			}
108
109			//pull any custom attributes out the args
110			if ( isset( $args['image_attributes'] ) && is_array( $args['image_attributes'] ) ) {
111			$attr = array_merge( $attr, $args['image_attributes'] );
112			}
113
114			//check for width and height args and add those to the image
115			if ( isset( $args['width'] ) && intval( $args['width'] ) > 0 ) {
116			$attr['width'] = $args['width'];
117			}
118			if ( isset( $args['height'] ) && intval( $args['height'] ) > 0 ) {
119			$attr['height'] = $args['height'];
120			}
121
122			$attr = apply_filters( 'foogallery_attachment_html_image_attributes', $attr, $args, $this );
123			$attr = array_map( 'esc_attr', $attr );
124			$html = '<img ';
125			foreach ( $attr as $name => $value ) {
126			$html .= " $name=" . '"' . $value . '"';
127			}
128			$html .= ' />';
129
130			return apply_filters( 'foogallery_attachment_html_image', $html, $args, $this );
131			}
132
133			/**
134			* Returns HTML for the attachment
135			* @param array $args
136			* @param bool $output_image
137			* @param bool $output_closing_tag
138			*
139			* @return string
140			*/
141			public function html( $args = array(), $output_image = true, $output_closing_tag = true ) {
142			if ( empty ( $this->url ) ) {
143			return '';
144			}
145
146			$arg_defaults = array(
147			'link' => 'image',
148			'custom_link' => $this->custom_url
149			);
150
151			$args = wp_parse_args( $args, $arg_defaults );
152
153			$link = $args['link'];
154
155			$img = $this->html_img( $args );
156
157			/* 12 Apr 2016 - PLEASE NOTE
158			We no longer just return the image html when "no link" option is chosen.
159			It was decided that it is better to return an anchor link with no href or target attributes.
160			This results in more standardized HTML output for better CSS and JS code
161			*/
162
163			if ( 'page' === $link ) {
164			//get the URL to the attachment page
165			$url = get_attachment_link( $this->ID );
166			} else if ( 'custom' === $link ) {
167			$url = $args['custom_link'];
168			} else {
169			$url = $this->url;
170			}
171
172			//fallback for images that might not have a custom url
173			if ( empty( $url ) ) {
174			$url = $this->url;
175			}
176
177			$attr = array();
178
179			//only add href and target attributes to the anchor if the link is NOT set to 'none'
180			if ( $link !== 'none' ){
181			$attr['href'] = $url;
182			if ( ! empty( $this->custom_target ) && 'default' !== $this->custom_target ) {
183			$attr['target'] = $this->custom_target;
184			}
185			}
186
187			if ( ! empty( $this->caption ) ) {
188			$attr['data-caption-title'] = $this->caption;
189			}
190
191			if ( !empty( $this->description ) ) {
192			$attr['data-caption-desc'] = $this->description;
193			}
194
195			$attr['data-attachment-id'] = $this->ID;
196
197			//pull any custom attributes out the args
198			if ( isset( $args['link_attributes'] ) && is_array( $args['link_attributes'] ) ) {
199			$attr = array_merge( $attr, $args['link_attributes'] );
200			}
201
202			$attr = apply_filters( 'foogallery_attachment_html_link_attributes', $attr, $args, $this );
203			$attr = array_map( 'esc_attr', $attr );
204			$html = '<a ';
205			foreach ( $attr as $name => $value ) {
206			$html .= " $name=" . '"' . $value . '"';
207			}
208			$html .= '>';
209			if ( $output_image ) {
210			$html .= $img;
211			}
212			if ( $output_closing_tag ) {
213			$html .= '</a>';
214			};
215
216			return apply_filters( 'foogallery_attachment_html_link', $html, $args, $this );
217			}
218
219			/**
220			* Returns generic html for captions
221			*
222			* @param $caption_content string Include title, desc, or both
223			*
224			* @return string
225			*/
226			public function html_caption( $caption_content ) {
227			$html = '';
228			$caption_html = array();
229			if ( $this->caption && ( 'title' === $caption_content \|\| 'both' === $caption_content ) ) {
230			$caption_html[] = '<div class="foogallery-caption-title">' . $this->caption . '</div>';
231			}
232			if ( $this->description && ( 'desc' === $caption_content \|\| 'both' === $caption_content ) ) {
233			$caption_html[] = '<div class="foogallery-caption-desc">' . $this->description . '</div>';
234			}
235
236			if ( count($caption_html) > 0 ) {
237			$html = '<div class="foogallery-caption"><div class="foogallery-caption-inner">';
238			$html .= implode( $caption_html );
239			$html .= '</div></div>';
240			}
241
242			return apply_filters( 'foogallery_attachment_html_caption', $html, $caption_content, $this );
243			}
244			}
245			}
246

fooplugins / foogallery

GitHub Access Token became invalid

Push — feature/gallery-datasources ( 744111...91cd91 )

FooGalleryAttachment::html_img_src() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like