GravityView_Field_FileUpload::__construct() - Code Metrics - Inspection of "Merge pull request #595 from gravityview/feature/e..." - gravityview/GravityView - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( fc0354...e2ac27 )

by Zack

created 2015-12-17 05:59 UTC

GravityView_Field_FileUpload::__construct() A

↳ Parent: GravityView_Field_FileUpload

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	4
rs	10
cc	1
eloc	3
nc	1
nop	0

<?php
/**
 * @package GravityView
 */


/**
 * Add custom options for date fields
 */
class GravityView_Field_FileUpload extends GravityView_Field {

	var $name = 'fileupload';

	var $_gf_field_class_name = 'GF_Field_FileUpload';

	var $label = 'File Upload';

	public function __construct() {
		$this->label = esc_attr__( 'File Upload', 'gravityview' );
		parent::__construct();
	}

	function field_options( $field_options, $template_id, $field_id, $context, $input_type ) {


		unset( $field_options['search_filter'] );

		if( 'edit' === $context ) {
			return $field_options;
		}

		$add_options['link_to_file'] = array(
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

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

    // do something with $myArray
}
			'type' => 'checkbox',
			'label' => __( 'Display as a Link:', 'gravityview' ),
			'desc' => __('Display the uploaded files as links, rather than embedded content.', 'gravityview'),
			'value' => false,
			'merge_tags' => false,
		);

		return $add_options + $field_options;
	}

	/**
	 * Return an array of files prepared for output.
	 *
	 * Processes files by file type and generates unique output for each. Returns array for each file, with the following keys:
	 * - `file_path` => The file path of the file, with a line break
	 * - `html` => The file output HTML formatted
	 *
	 * @since  1.2
	 * @todo  Support `playlist` shortcode for playlist of video/audio
	 * @param  string $value    Field value passed by Gravity Forms. String of file URL, or serialized string of file URL array
	 * @param  string $gv_class Field class to add to the output HTML
	 * @return array           Array of file output, with `file_path` and `html` keys (see comments above)
	 */
	static function get_files_array( $value, $gv_class ) {


		$gravityview_view = GravityView_View::getInstance();

		extract( $gravityview_view->getCurrentField() );


		$output_arr = array();

		// Get an array of file paths for the field.
		$file_paths = rgar( $field , 'multipleFiles' ) ? json_decode( $value ) : array( $value );

		// Process each file path
		foreach( $file_paths as $file_path ) {

			// If the site is HTTPS, use HTTPS
			if(function_exists('set_url_scheme')) { $file_path = set_url_scheme($file_path); }

			// This is from Gravity Forms's code
			$file_path = esc_attr(str_replace(" ", "%20", $file_path));

			// If the field is set to link to the single entry, link to it.
			$link = !empty( $field_settings['show_as_link'] ) ? GravityView_API::entry_link( $entry, $field ) : $file_path;

			// Get file path information
			$file_path_info = pathinfo($file_path);

			$html_format = NULL;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

			$disable_lightbox = false;

			$disable_wrapped_link = false;

			// Is this an image?
			$image = new GravityView_Image(array(
				'src' => $file_path,
				'class' => 'gv-image gv-field-id-'.$field_settings['id'],
				'alt' => $field_settings['label'],
				'width' => (gravityview_get_context() === 'single' ? NULL : 250)
			));

			$content = $image->html();

			// The new default content is the image, if it exists. If not, use the file name as the content.
			$content = !empty( $content ) ? $content : $file_path_info['basename'];

			// If pathinfo() gave us the extension of the file, run the switch statement using that.
			$extension = empty( $file_path_info['extension'] ) ? NULL : strtolower( $file_path_info['extension'] );


			switch( true ) {

				// Audio file
				case in_array( $extension, wp_get_audio_extensions() ):


					$disable_lightbox = true;

					if( shortcode_exists( 'audio' ) ) {

						$disable_wrapped_link = true;

						/**
						 * @filter `gravityview_audio_settings` Modify the settings passed to the `wp_video_shortcode()` function
						 * @since  1.2
						 * @param array $audio_settings Array with `src` and `class` keys
						 */
						$audio_settings = apply_filters( 'gravityview_audio_settings', array(
							'src' => $file_path,
							'class' => 'wp-audio-shortcode gv-audio gv-field-id-'.$field_settings['id']
						));

						/**
						 * Generate the audio shortcode
						 * @see http://codex.wordpress.org/Audio_Shortcode
						 * @see https://developer.wordpress.org/reference/functions/wp_audio_shortcode/
						 */
						$content = wp_audio_shortcode( $audio_settings );

					}

					break;

				// Video file
				case in_array( $extension, wp_get_video_extensions() ):


					$disable_lightbox = true;

					if( shortcode_exists( 'video' ) ) {

						$disable_wrapped_link = true;

						/**
						 * @filter `gravityview_video_settings` Modify the settings passed to the `wp_video_shortcode()` function
						 * @since  1.2
						 * @param array $video_settings Array with `src` and `class` keys
						 */
						$video_settings = apply_filters( 'gravityview_video_settings', array(
							'src' => $file_path,
							'class' => 'wp-video-shortcode gv-video gv-field-id-'.$field_settings['id']
						));

						/**
						 * Generate the video shortcode
						 * @see http://codex.wordpress.org/Video_Shortcode
						 * @see https://developer.wordpress.org/reference/functions/wp_video_shortcode/
						 */
						$content = wp_video_shortcode( $video_settings );

					}

					break;

				// PDF
				case $extension === 'pdf':

					// PDF needs to be displayed in an IFRAME
					$link = add_query_arg( array( 'TB_iframe' => 'true' ), $link );

					break;

				// if not image, do not set the lightbox (@since 1.5.3)
				case !in_array( $extension, array( 'jpg', 'jpeg', 'jpe', 'gif', 'png' ) ):

					$disable_lightbox = true;

					break;

			}

			// If using Link to File, override the content.
			// (We do this here so that the $disable_lightbox can be set. Yes, there's a little more processing time, but oh well.)
			if( !empty( $field_settings['link_to_file'] ) ) {

				// Force the content to be the file name
				$content =  $file_path_info["basename"];

				// Restore the wrapped link
				$disable_wrapped_link = false;

			}

			// Whether to use lightbox or not
			if( $disable_lightbox || empty( $gravityview_view->atts['lightbox'] ) || !empty( $field_settings['show_as_link'] ) ) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

				$link_atts = empty( $field_settings['show_as_link'] ) ? array( 'target' => '_blank' ) : array();

			} else {

				$link_atts = array(
					'rel' => sprintf( "%s-%s", $gv_class, $entry['id'] ),
					'target' => '_blank',
					'class' => 'thickbox',
				);

			}

			/**
			 * @filter `gravityview/fields/fileupload/link_atts` Modify the link attributes for a file upload field
			 * @param array|string $link_atts Array or attributes string
			 * @param array $field Current GravityView field array
			 */
			$link_atts = apply_filters( 'gravityview/fields/fileupload/link_atts', $link_atts, $gravityview_view->getCurrentField() );

			/**
			 * @filter `gravityview/fields/fileupload/disable_link` Filter to alter the default behaviour of wrapping images (or image names) with a link to the content object
			 * @since 1.5.1
			 * @param bool $disable_wrapped_link whether to wrap the content with a link to the content object.
			 * @param array $gravityview_view->field_data
			 * @see GravityView_API:field_value() for info about $gravityview_view->field_data
			 */
			$disable_wrapped_link = apply_filters( 'gravityview/fields/fileupload/disable_link', $disable_wrapped_link, $gravityview_view->getCurrentField() );

			// If the HTML output hasn't been overridden by the switch statement above, use the default format
			if( !empty( $content ) && empty( $disable_wrapped_link ) ) {

				/**
				 * Modify the link text (defaults to the file name)
				 *
				 * @since 1.7
				 *
				 * @param string $content The existing anchor content. Could be `<img>` tag, audio/video embed or the file name
				 * @param array $field GravityView array of the current field being processed
				 */
				$content = apply_filters( 'gravityview/fields/fileupload/link_content', $content, $gravityview_view->getCurrentField() );

                $content = gravityview_get_link( $link, $content, $link_atts );
			}

			$output_arr[] = array(
				'file_path' => $file_path,
				'content' => $content
			);

		} // End foreach loop

		/**
		 * @filter `gravityview/fields/fileupload/files_array` Modify the files array
		 * @since 1.7
		 * @param array $output_arr Associative array of files \n
		 *  @type string $file_path The path to the file as stored in Gravity Forms \n
		 *  @type string $content The generated output for the file \n
		 * @param array $field GravityView array of the current field being processed
		 */
		$output_arr = apply_filters( 'gravityview/fields/fileupload/files_array', $output_arr, $gravityview_view->getCurrentField() );

		return $output_arr;
	}

}

new GravityView_Field_FileUpload;


1		<?php
2		/**
3		* @package GravityView
4		*/
5
6
7		/**
8		* Add custom options for date fields
9		*/
10		class GravityView_Field_FileUpload extends GravityView_Field {
11
12		var $name = 'fileupload';
13
14		var $_gf_field_class_name = 'GF_Field_FileUpload';
15
16		var $label = 'File Upload';
17
18		public function __construct() {
19		$this->label = esc_attr__( 'File Upload', 'gravityview' );
20		parent::__construct();
21		}
22
23	View Code Duplication	function field_options( $field_options, $template_id, $field_id, $context, $input_type ) {
		0 ignored issues – show Best Practice introduced 2015-12-17 06:02 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history... Duplication introduced 2015-12-17 06:02 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
24
25		unset( $field_options['search_filter'] );
26
27		if( 'edit' === $context ) {
28		return $field_options;
29		}
30
31		$add_options['link_to_file'] = array(
		0 ignored issues – show Coding Style Comprehensibility introduced 2015-12-17 06:02 UTC by Report Bug Copy Issue Report `$add_options` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$add_options = 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...
32		'type' => 'checkbox',
33		'label' => __( 'Display as a Link:', 'gravityview' ),
34		'desc' => __('Display the uploaded files as links, rather than embedded content.', 'gravityview'),
35		'value' => false,
36		'merge_tags' => false,
37		);
38
39		return $add_options + $field_options;
40		}
41
42		/**
43		* Return an array of files prepared for output.
44		*
45		* Processes files by file type and generates unique output for each. Returns array for each file, with the following keys:
46		* - `file_path` => The file path of the file, with a line break
47		* - `html` => The file output HTML formatted
48		*
49		* @since 1.2
50		* @todo Support `playlist` shortcode for playlist of video/audio
51		* @param string $value Field value passed by Gravity Forms. String of file URL, or serialized string of file URL array
52		* @param string $gv_class Field class to add to the output HTML
53		* @return array Array of file output, with `file_path` and `html` keys (see comments above)
54		*/
55		static function get_files_array( $value, $gv_class ) {
		0 ignored issues – show Best Practice introduced 2015-12-17 06:02 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
56
57		$gravityview_view = GravityView_View::getInstance();
58
59		extract( $gravityview_view->getCurrentField() );
		0 ignored issues – show Bug introduced 2015-12-17 06:02 UTC by Report Bug Copy Issue Report `$gravityview_view->getCurrentField()` cannot be passed to `extract()` as the parameter `$var_array` expects a reference. Loading history...
60
61		$output_arr = array();
62
63		// Get an array of file paths for the field.
64		$file_paths = rgar( $field , 'multipleFiles' ) ? json_decode( $value ) : array( $value );
65
66		// Process each file path
67		foreach( $file_paths as $file_path ) {
68
69		// If the site is HTTPS, use HTTPS
70		if(function_exists('set_url_scheme')) { $file_path = set_url_scheme($file_path); }
71
72		// This is from Gravity Forms's code
73		$file_path = esc_attr(str_replace(" ", "%20", $file_path));
74
75		// If the field is set to link to the single entry, link to it.
76		$link = !empty( $field_settings['show_as_link'] ) ? GravityView_API::entry_link( $entry, $field ) : $file_path;
77
78		// Get file path information
79		$file_path_info = pathinfo($file_path);
80
81		$html_format = NULL;
		0 ignored issues – show Unused Code introduced 2015-12-17 06:02 UTC by Report Bug Copy Issue Report `$html_format` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
82
83		$disable_lightbox = false;
84
85		$disable_wrapped_link = false;
86
87		// Is this an image?
88		$image = new GravityView_Image(array(
89		'src' => $file_path,
90		'class' => 'gv-image gv-field-id-'.$field_settings['id'],
91		'alt' => $field_settings['label'],
92		'width' => (gravityview_get_context() === 'single' ? NULL : 250)
93		));
94
95		$content = $image->html();
96
97		// The new default content is the image, if it exists. If not, use the file name as the content.
98		$content = !empty( $content ) ? $content : $file_path_info['basename'];
99
100		// If pathinfo() gave us the extension of the file, run the switch statement using that.
101		$extension = empty( $file_path_info['extension'] ) ? NULL : strtolower( $file_path_info['extension'] );
102
103
104		switch( true ) {
105
106		// Audio file
107	View Code Duplication	case in_array( $extension, wp_get_audio_extensions() ):
		0 ignored issues – show Duplication introduced 2015-12-17 06:02 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
108
109		$disable_lightbox = true;
110
111		if( shortcode_exists( 'audio' ) ) {
112
113		$disable_wrapped_link = true;
114
115		/**
116		* @filter `gravityview_audio_settings` Modify the settings passed to the `wp_video_shortcode()` function
117		* @since 1.2
118		* @param array $audio_settings Array with `src` and `class` keys
119		*/
120		$audio_settings = apply_filters( 'gravityview_audio_settings', array(
121		'src' => $file_path,
122		'class' => 'wp-audio-shortcode gv-audio gv-field-id-'.$field_settings['id']
123		));
124
125		/**
126		* Generate the audio shortcode
127		* @see http://codex.wordpress.org/Audio_Shortcode
128		* @see https://developer.wordpress.org/reference/functions/wp_audio_shortcode/
129		*/
130		$content = wp_audio_shortcode( $audio_settings );
131
132		}
133
134		break;
135
136		// Video file
137	View Code Duplication	case in_array( $extension, wp_get_video_extensions() ):
		0 ignored issues – show Duplication introduced 2015-12-17 06:02 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
138
139		$disable_lightbox = true;
140
141		if( shortcode_exists( 'video' ) ) {
142
143		$disable_wrapped_link = true;
144
145		/**
146		* @filter `gravityview_video_settings` Modify the settings passed to the `wp_video_shortcode()` function
147		* @since 1.2
148		* @param array $video_settings Array with `src` and `class` keys
149		*/
150		$video_settings = apply_filters( 'gravityview_video_settings', array(
151		'src' => $file_path,
152		'class' => 'wp-video-shortcode gv-video gv-field-id-'.$field_settings['id']
153		));
154
155		/**
156		* Generate the video shortcode
157		* @see http://codex.wordpress.org/Video_Shortcode
158		* @see https://developer.wordpress.org/reference/functions/wp_video_shortcode/
159		*/
160		$content = wp_video_shortcode( $video_settings );
161
162		}
163
164		break;
165
166		// PDF
167		case $extension === 'pdf':
168
169		// PDF needs to be displayed in an IFRAME
170		$link = add_query_arg( array( 'TB_iframe' => 'true' ), $link );
171
172		break;
173
174		// if not image, do not set the lightbox (@since 1.5.3)
175		case !in_array( $extension, array( 'jpg', 'jpeg', 'jpe', 'gif', 'png' ) ):
176
177		$disable_lightbox = true;
178
179		break;
180
181		}
182
183		// If using Link to File, override the content.
184		// (We do this here so that the $disable_lightbox can be set. Yes, there's a little more processing time, but oh well.)
185		if( !empty( $field_settings['link_to_file'] ) ) {
186
187		// Force the content to be the file name
188		$content = $file_path_info["basename"];
189
190		// Restore the wrapped link
191		$disable_wrapped_link = false;
192
193		}
194
195		// Whether to use lightbox or not
196		if( $disable_lightbox \|\| empty( $gravityview_view->atts['lightbox'] ) \|\| !empty( $field_settings['show_as_link'] ) ) {
		0 ignored issues – show Documentation introduced 2015-12-17 06:02 UTC by Report Bug Copy Issue Report The property `$atts` is declared protected in `GravityView_View`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
197
198		$link_atts = empty( $field_settings['show_as_link'] ) ? array( 'target' => '_blank' ) : array();
199
200		} else {
201
202		$link_atts = array(
203		'rel' => sprintf( "%s-%s", $gv_class, $entry['id'] ),
204		'target' => '_blank',
205		'class' => 'thickbox',
206		);
207
208		}
209
210		/**
211		* @filter `gravityview/fields/fileupload/link_atts` Modify the link attributes for a file upload field
212		* @param array\|string $link_atts Array or attributes string
213		* @param array $field Current GravityView field array
214		*/
215		$link_atts = apply_filters( 'gravityview/fields/fileupload/link_atts', $link_atts, $gravityview_view->getCurrentField() );
216
217		/**
218		* @filter `gravityview/fields/fileupload/disable_link` Filter to alter the default behaviour of wrapping images (or image names) with a link to the content object
219		* @since 1.5.1
220		* @param bool $disable_wrapped_link whether to wrap the content with a link to the content object.
221		* @param array $gravityview_view->field_data
222		* @see GravityView_API:field_value() for info about $gravityview_view->field_data
223		*/
224		$disable_wrapped_link = apply_filters( 'gravityview/fields/fileupload/disable_link', $disable_wrapped_link, $gravityview_view->getCurrentField() );
225
226		// If the HTML output hasn't been overridden by the switch statement above, use the default format
227		if( !empty( $content ) && empty( $disable_wrapped_link ) ) {
228
229		/**
230		* Modify the link text (defaults to the file name)
231		*
232		* @since 1.7
233		*
234		* @param string $content The existing anchor content. Could be `<img>` tag, audio/video embed or the file name
235		* @param array $field GravityView array of the current field being processed
236		*/
237		$content = apply_filters( 'gravityview/fields/fileupload/link_content', $content, $gravityview_view->getCurrentField() );
238
239		$content = gravityview_get_link( $link, $content, $link_atts );
240		}
241
242		$output_arr[] = array(
243		'file_path' => $file_path,
244		'content' => $content
245		);
246
247		} // End foreach loop
248
249		/**
250		* @filter `gravityview/fields/fileupload/files_array` Modify the files array
251		* @since 1.7
252		* @param array $output_arr Associative array of files \n
253		* @type string $file_path The path to the file as stored in Gravity Forms \n
254		* @type string $content The generated output for the file \n
255		* @param array $field GravityView array of the current field being processed
256		*/
257		$output_arr = apply_filters( 'gravityview/fields/fileupload/files_array', $output_arr, $gravityview_view->getCurrentField() );
258
259		return $output_arr;
260		}
261
262		}
263
264		new GravityView_Field_FileUpload;
265

gravityview / GravityView

Push — develop ( fc0354...e2ac27 )

GravityView_Field_FileUpload::__construct() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like