Relationship_Field::set_value_from_input() - Code Metrics - Inspection of "Merge branch 'refactor/nav-menu-container' into de..." - htmlburger/carbon-fields - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — development ( 987e6d...b78414 )

unknown

created 2017-01-13 09:05 UTC

Relationship_Field::set_value_from_input() A

↳ Parent: Relationship_Field

Complexity

Conditions	4
Paths	6

Size

Total Lines	15
Code Lines	10

Duplication

Lines	15
Ratio	100 %

Importance

Changes

Metric	Value
cc	4
eloc	10
nc	6
nop	1
dl	15
loc	15
rs	9.2
c	0
b	0
f	0

<?php

namespace Carbon_Fields\Field;

/**
 * Relationship field class.
 * Allows selecting and manually sorting entries from any custom post type.
 */
class Relationship_Field extends Field {
	protected $post_type = array( 'post' );
	protected $max = -1;
	protected $allow_duplicates = false;

	/**
	 * Admin initialization actions
	 */
	public function admin_init() {
		$this->add_template( $this->get_type() . '_item', array( $this, 'item_template' ) );

		parent::admin_init();
	}

	/**
	 * Load the field value from an input array based on it's name
	 *
	 * @param array $input (optional) Array of field names and values. Defaults to $_POST
	 **/
	public function set_value_from_input( $input = null ) {

		if ( is_null( $input ) ) {
			$input = $_POST;

		}

		if ( ! isset( $input[ $this->name ] ) ) {
			$this->set_value( null );
		} else {
			$value = stripslashes_deep( $input[ $this->name ] );
			if ( is_array( $value ) ) {
				$value = array_values( $value );
			}
			$this->set_value( $value );
		}
	}

	/**
	 * Set the post type of the entries.
	 *
	 * @param string|array $post_type Post type
	 */
	public function set_post_type( $post_type ) {
		if ( ! is_array( $post_type ) ) {
			$post_type = array( $post_type );
		}

		$this->post_type = $post_type;
		return $this;
	}

	/**
	 * Set the maximum allowed number of selected entries.
	 *
	 * @param int $max
	 */
	public function set_max( $max ) {
		$this->max = intval( $max );
		return $this;
	}

	/**
	 * Specify whether to allow each entry to be selected multiple times.
	 *
	 * @param  boolean $allow
	 */
	public function allow_duplicates( $allow = true ) {
		$this->allow_duplicates = (bool) $allow;
		return $this;
	}

	/**
	 * Used to get the title of an item.
	 *
	 * Can be overriden or extended by the `carbon_relationship_title` filter.
	 *
	 * @param int     $id      The database ID of the item.
	 * @param string  $type    Item type (post, term, user, comment, or a custom one).
	 * @param string  $subtype The subtype - "page", "post", "category", etc.
	 * @return string $title The title of the item.
	 */
	public function get_title_by_type( $id, $type, $subtype = '' ) {
		$title = get_the_title( $id );
		if ( ! $title ) {
			$title = '(no title) - ID: ' . $id;
		}

		/**
		 * Filter the title of the relationship item.
		 *
		 * @param string $title   The unfiltered item title.
		 * @param string $name    Name of the relationship field.
		 * @param int    $id      The database ID of the item.
		 * @param string $type    Item type (post, term, user, comment, or a custom one).
		 * @param string $subtype Subtype - "page", "post", "category", etc.
		 */
		return apply_filters( 'carbon_relationship_title', $title, $this->get_name(), $id, $type, $subtype );
	}

	/**
	 * Used to get the label of an item.
	 *
	 * Can be overriden or extended by the `carbon_relationship_item_label` filter.
	 *
	 * @param int     $id      The database ID of the item.
	 * @param string  $type    Item type (post, term, user, comment, or a custom one).
	 * @param string  $subtype Subtype - "page", "post", "category", etc.
	 * @return string $label The label of the item.
	 */
	public function get_item_label( $id, $type, $subtype = '' ) {
		$object = get_post_type_object( $subtype );
		$label = $object ? $object->labels->singular_name : null;

		/**
		 * Filter the label of the relationship item.
		 *
		 * @param string $label   The unfiltered item label.
		 * @param string $name    Name of the relationship field.
		 * @param int    $id      The database ID of the item.
		 * @param string $type    Item type (post, term, user, comment, or a custom one).
		 * @param string $subtype Subtype - "page", "post", "category", etc.
		 */
		return apply_filters( 'carbon_relationship_item_label', $label, $this->get_name(), $id, $type, $subtype );
	}

	/**
	 * Generate the item options for the relationship field.
	 *
	 * @return array $options The selectable options of the relationship field.
	 */
	public function get_options() {
		$options = array();
		/**
		 * Filter the default query when fetching posts for a particular field.
		 *
		 * @param array $args The parameters, passed to get_posts().
		 */
		foreach ( $this->post_type as $post_type ) {
			$filter_name = 'carbon_relationship_options_' . $this->get_name() . '_post_' . $post_type;
			$args = apply_filters( $filter_name, array(
				'post_type' => $post_type,
				'posts_per_page' => -1,

				'fields' => 'ids',
				'suppress_filters' => false,
			) );

			// fetch and prepare posts as relationship items
			$new_options = get_posts( $args );
			foreach ( $new_options as &$p ) {
				$p = array(
					'id' => $p,
					'title' => $this->get_title_by_type( $p, 'post', $post_type ),
					'type' => 'post',
					'subtype' => $post_type,
					'label' => $this->get_item_label( $p, 'post', $post_type ),
					'is_trashed' => ( get_post_status( $p ) == 'trash' ),
					'edit_link'  => get_edit_post_link( $p ),
				);
			}

			$options = array_merge( $options, $new_options );
		}

		/**
		 * Filter the final list of options, available to a certain relationship field.
		 *
		 * @param array $options Unfiltered options items.
		 * @param string $name Name of the relationship field.
		 */
		$options = apply_filters( 'carbon_relationship_options', $options, $this->get_name() );

		return $options;
	}

	/**
	 * Returns an array that holds the field data, suitable for JSON representation.
	 * This data will be available in the Underscore template and the Backbone Model.
	 *
	 * @param bool $load  Should the value be loaded from the database or use the value from the current instance.
	 * @return array
	 */
	public function to_json( $load ) {
		$field_data = parent::to_json( $load );

		$field_data['nextfieldIndex'] = 0;
		if ( ! empty( $field_data['value'] ) ) {
			$value = array();

			$field_data['value'] = maybe_unserialize( $field_data['value'] );
			$i = 0;
			foreach ( $field_data['value'] as $single_value ) {
				$post_type = get_post_type( $single_value );
				$value[] = array(
					'id' => $single_value,
					'title' => $this->get_title_by_type( $single_value, 'post', $post_type ),
					'type' => 'post',
					'subtype' => $post_type,
					'label' => $this->get_item_label( $single_value, 'post', $post_type ),
					'is_trashed' => ( get_post_status( $single_value ) == 'trash' ),
					'fieldIndex' => $i,
				);
				$i++;
			}
			$field_data['nextfieldIndex'] = $i;
			$field_data['value'] = $value;
		}

		$field_data = array_merge( $field_data, array(
			'options' => $this->get_options(),
			'max' => $this->max,
			'allow_duplicates' => $this->allow_duplicates,
		) );

		return $field_data;
	}

	/**
	 * The main Underscore template of this field.
	 */
	public function template() {
		?>
		<div class="carbon-relationship-container">
			<div class="selected-items-container">
				<strong>
					<#
					var selected_items_length = 0;
					if ( value ) {
						selected_items_length = value.length;
					} #>
					<span class="selected-counter">{{{ selected_items_length }}}</span>
					<span class="selected-label" data-single-label="<?php _e( 'selected item', 'carbon-fields' ); ?>" data-plural-label="<?php _e( 'selected items', 'carbon-fields' ); ?>">
						<?php _e( 'selected items', 'carbon-fields' ); ?>
					</span>

					<?php
					/* If set_max() has been set, show the allowed maximum items number */
					?>
					<# if ( max !== -1 ) { #>
						<span class="remaining"><?php _e( 'out of', 'carbon-fields' ); ?> {{{ max }}}</span>
					<# } #>
				</strong>
			</div>

			<div class="search-field carbon-relationship-search dashicons-before dashicons-search">
				<input type="text" class="search-field" placeholder="<?php esc_attr_e( 'Search...', 'carbon-fields' ); ?>" />
			</div>

			<div class="carbon-relationship-body">
				<div class="carbon-relationship-left">
					<ul class="carbon-relationship-list">
						<# if (options) { #>
							<# _.each(options, function(item) { #>
								<?php echo $this->item_template( false ); ?>

							<# }); #>
						<# } #>
					</ul>
				</div>

				<div class="carbon-relationship-right">
					<label><?php _e( 'Associated:', 'carbon-fields' ); ?></label>

					<ul class="carbon-relationship-list">
						<# if (value) { #>
							<# _.each(value, function(item) { #>
								<?php echo $this->item_template(); ?>

							<# }); #>
						<# } #>
					</ul>
				</div>
			</div>
		</div>
		<?php
	}

	/**
	 * Serves as a Underscore template for the relationship items.
	 * Used for both the selected and the selectable options.
	 *
	 * @param bool $display_input Whether to display the selected item input field.
	 */
	public function item_template( $display_input = true ) {
		?>
		<li>
			<span class="mobile-handle dashicons-before dashicons-menu"></span>
			<a href="#" data-item-id="{{{ item.id }}}" data-item-title="{{{ item.title }}}" data-item-type="{{{ item.type }}}" data-item-subtype="{{{ item.subtype }}}" data-item-label="{{{ item.label }}}" data-value="{{{ item.id }}}">
				<# if ( item.edit_link ) { #>
					<em class="edit-link dashicons-before dashicons-edit" data-href="{{{ item.edit_link }}}"><?php _e( 'Edit', 'carbon-fields' ); ?></em>
				<# } #>
				<em>{{{ item.label }}}</em>
				<span class="dashicons-before dashicons-plus-alt"></span>

				{{{ item.title }}}
			</a>
			<?php if ( $display_input ) :  ?>
				<input type="hidden" name="{{{ name }}}[{{{ item.fieldIndex }}}]" value="{{{ item.id }}}" />
			<?php endif; ?>
		</li>
		<?php
	}
}


1		<?php
2
3		namespace Carbon_Fields\Field;
4
5		/**
6		* Relationship field class.
7		* Allows selecting and manually sorting entries from any custom post type.
8		*/
9		class Relationship_Field extends Field {
10		protected $post_type = array( 'post' );
11		protected $max = -1;
12		protected $allow_duplicates = false;
13
14		/**
15		* Admin initialization actions
16		*/
17		public function admin_init() {
18		$this->add_template( $this->get_type() . '_item', array( $this, 'item_template' ) );
19
20		parent::admin_init();
21		}
22
23		/**
24		* Load the field value from an input array based on it's name
25		*
26		* @param array $input (optional) Array of field names and values. Defaults to $_POST
27		**/
28	View Code Duplication	public function set_value_from_input( $input = null ) {
		0 ignored issues – show Duplication introduced 2017-01-13 09:09 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...
29		if ( is_null( $input ) ) {
30		$input = $_POST;
		0 ignored issues – show introduced 2017-01-13 09:09 UTC by Report Bug Copy Issue Report Detected access of super global var $_POST, probably need manual inspection. Loading history... introduced 2017-01-13 09:09 UTC by Report Bug Copy Issue Report Detected usage of a non-sanitized input variable: $_POST Loading history...
31		}
32
33		if ( ! isset( $input[ $this->name ] ) ) {
34		$this->set_value( null );
35		} else {
36		$value = stripslashes_deep( $input[ $this->name ] );
37		if ( is_array( $value ) ) {
38		$value = array_values( $value );
39		}
40		$this->set_value( $value );
41		}
42		}
43
44		/**
45		* Set the post type of the entries.
46		*
47		* @param string\|array $post_type Post type
48		*/
49		public function set_post_type( $post_type ) {
50		if ( ! is_array( $post_type ) ) {
51		$post_type = array( $post_type );
52		}
53
54		$this->post_type = $post_type;
55		return $this;
56		}
57
58		/**
59		* Set the maximum allowed number of selected entries.
60		*
61		* @param int $max
62		*/
63		public function set_max( $max ) {
64		$this->max = intval( $max );
65		return $this;
66		}
67
68		/**
69		* Specify whether to allow each entry to be selected multiple times.
70		*
71		* @param boolean $allow
72		*/
73		public function allow_duplicates( $allow = true ) {
74		$this->allow_duplicates = (bool) $allow;
75		return $this;
76		}
77
78		/**
79		* Used to get the title of an item.
80		*
81		* Can be overriden or extended by the `carbon_relationship_title` filter.
82		*
83		* @param int $id The database ID of the item.
84		* @param string $type Item type (post, term, user, comment, or a custom one).
85		* @param string $subtype The subtype - "page", "post", "category", etc.
86		* @return string $title The title of the item.
87		*/
88		public function get_title_by_type( $id, $type, $subtype = '' ) {
89		$title = get_the_title( $id );
90		if ( ! $title ) {
91		$title = '(no title) - ID: ' . $id;
92		}
93
94		/**
95		* Filter the title of the relationship item.
96		*
97		* @param string $title The unfiltered item title.
98		* @param string $name Name of the relationship field.
99		* @param int $id The database ID of the item.
100		* @param string $type Item type (post, term, user, comment, or a custom one).
101		* @param string $subtype Subtype - "page", "post", "category", etc.
102		*/
103		return apply_filters( 'carbon_relationship_title', $title, $this->get_name(), $id, $type, $subtype );
104		}
105
106		/**
107		* Used to get the label of an item.
108		*
109		* Can be overriden or extended by the `carbon_relationship_item_label` filter.
110		*
111		* @param int $id The database ID of the item.
112		* @param string $type Item type (post, term, user, comment, or a custom one).
113		* @param string $subtype Subtype - "page", "post", "category", etc.
114		* @return string $label The label of the item.
115		*/
116		public function get_item_label( $id, $type, $subtype = '' ) {
117		$object = get_post_type_object( $subtype );
118		$label = $object ? $object->labels->singular_name : null;
119
120		/**
121		* Filter the label of the relationship item.
122		*
123		* @param string $label The unfiltered item label.
124		* @param string $name Name of the relationship field.
125		* @param int $id The database ID of the item.
126		* @param string $type Item type (post, term, user, comment, or a custom one).
127		* @param string $subtype Subtype - "page", "post", "category", etc.
128		*/
129		return apply_filters( 'carbon_relationship_item_label', $label, $this->get_name(), $id, $type, $subtype );
130		}
131
132		/**
133		* Generate the item options for the relationship field.
134		*
135		* @return array $options The selectable options of the relationship field.
136		*/
137		public function get_options() {
138		$options = array();
139		/**
140		* Filter the default query when fetching posts for a particular field.
141		*
142		* @param array $args The parameters, passed to get_posts().
143		*/
144		foreach ( $this->post_type as $post_type ) {
145		$filter_name = 'carbon_relationship_options_' . $this->get_name() . '_post_' . $post_type;
146		$args = apply_filters( $filter_name, array(
147		'post_type' => $post_type,
148		'posts_per_page' => -1,
		0 ignored issues – show introduced 2016-01-07 13:39 UTC by Report Bug Copy Issue Report Disabling pagination is prohibited in VIP context, do not set `posts_per_page` to `-1` ever. Loading history...
149		'fields' => 'ids',
150		'suppress_filters' => false,
151		) );
152
153		// fetch and prepare posts as relationship items
154		$new_options = get_posts( $args );
155		foreach ( $new_options as &$p ) {
156		$p = array(
157		'id' => $p,
158		'title' => $this->get_title_by_type( $p, 'post', $post_type ),
159		'type' => 'post',
160		'subtype' => $post_type,
161		'label' => $this->get_item_label( $p, 'post', $post_type ),
162		'is_trashed' => ( get_post_status( $p ) == 'trash' ),
163		'edit_link' => get_edit_post_link( $p ),
164		);
165		}
166
167		$options = array_merge( $options, $new_options );
168		}
169
170		/**
171		* Filter the final list of options, available to a certain relationship field.
172		*
173		* @param array $options Unfiltered options items.
174		* @param string $name Name of the relationship field.
175		*/
176		$options = apply_filters( 'carbon_relationship_options', $options, $this->get_name() );
177
178		return $options;
179		}
180
181		/**
182		* Returns an array that holds the field data, suitable for JSON representation.
183		* This data will be available in the Underscore template and the Backbone Model.
184		*
185		* @param bool $load Should the value be loaded from the database or use the value from the current instance.
186		* @return array
187		*/
188		public function to_json( $load ) {
189		$field_data = parent::to_json( $load );
190
191		$field_data['nextfieldIndex'] = 0;
192		if ( ! empty( $field_data['value'] ) ) {
193		$value = array();
194
195		$field_data['value'] = maybe_unserialize( $field_data['value'] );
196		$i = 0;
197		foreach ( $field_data['value'] as $single_value ) {
198		$post_type = get_post_type( $single_value );
199		$value[] = array(
200		'id' => $single_value,
201		'title' => $this->get_title_by_type( $single_value, 'post', $post_type ),
202		'type' => 'post',
203		'subtype' => $post_type,
204		'label' => $this->get_item_label( $single_value, 'post', $post_type ),
205		'is_trashed' => ( get_post_status( $single_value ) == 'trash' ),
206		'fieldIndex' => $i,
207		);
208		$i++;
209		}
210		$field_data['nextfieldIndex'] = $i;
211		$field_data['value'] = $value;
212		}
213
214		$field_data = array_merge( $field_data, array(
215		'options' => $this->get_options(),
216		'max' => $this->max,
217		'allow_duplicates' => $this->allow_duplicates,
218		) );
219
220		return $field_data;
221		}
222
223		/**
224		* The main Underscore template of this field.
225		*/
226		public function template() {
227		?>
228		<div class="carbon-relationship-container">
229		<div class="selected-items-container">
230		<strong>
231		<#
232		var selected_items_length = 0;
233		if ( value ) {
234		selected_items_length = value.length;
235		} #>
236		<span class="selected-counter">{{{ selected_items_length }}}</span>
237		<span class="selected-label" data-single-label="<?php _e( 'selected item', 'carbon-fields' ); ?>" data-plural-label="<?php _e( 'selected items', 'carbon-fields' ); ?>">
238		<?php _e( 'selected items', 'carbon-fields' ); ?>
239		</span>
240
241		<?php
242		/* If set_max() has been set, show the allowed maximum items number */
243		?>
244		<# if ( max !== -1 ) { #>
245		<span class="remaining"><?php _e( 'out of', 'carbon-fields' ); ?> {{{ max }}}</span>
246		<# } #>
247		</strong>
248		</div>
249
250		<div class="search-field carbon-relationship-search dashicons-before dashicons-search">
251		<input type="text" class="search-field" placeholder="<?php esc_attr_e( 'Search...', 'carbon-fields' ); ?>" />
252		</div>
253
254		<div class="carbon-relationship-body">
255		<div class="carbon-relationship-left">
256		<ul class="carbon-relationship-list">
257		<# if (options) { #>
258		<# _.each(options, function(item) { #>
259		<?php echo $this->item_template( false ); ?>
		1 ignored issue – show introduced 2016-01-07 13:39 UTC by Report Bug Copy Issue Report Expected next thing to be a escaping function, not '$this' Loading history...
260		<# }); #>
261		<# } #>
262		</ul>
263		</div>
264
265		<div class="carbon-relationship-right">
266		<label><?php _e( 'Associated:', 'carbon-fields' ); ?></label>
267
268		<ul class="carbon-relationship-list">
269		<# if (value) { #>
270		<# _.each(value, function(item) { #>
271		<?php echo $this->item_template(); ?>
		1 ignored issue – show introduced 2016-01-07 13:39 UTC by Report Bug Copy Issue Report Expected next thing to be a escaping function, not '$this' Loading history...
272		<# }); #>
273		<# } #>
274		</ul>
275		</div>
276		</div>
277		</div>
278		<?php
279		}
280
281		/**
282		* Serves as a Underscore template for the relationship items.
283		* Used for both the selected and the selectable options.
284		*
285		* @param bool $display_input Whether to display the selected item input field.
286		*/
287		public function item_template( $display_input = true ) {
288		?>
289		<li>
290		<span class="mobile-handle dashicons-before dashicons-menu"></span>
291		<a href="#" data-item-id="{{{ item.id }}}" data-item-title="{{{ item.title }}}" data-item-type="{{{ item.type }}}" data-item-subtype="{{{ item.subtype }}}" data-item-label="{{{ item.label }}}" data-value="{{{ item.id }}}">
292		<# if ( item.edit_link ) { #>
293		<em class="edit-link dashicons-before dashicons-edit" data-href="{{{ item.edit_link }}}"><?php _e( 'Edit', 'carbon-fields' ); ?></em>
294		<# } #>
295		<em>{{{ item.label }}}</em>
296		<span class="dashicons-before dashicons-plus-alt"></span>
297
298		{{{ item.title }}}
299		</a>
300		<?php if ( $display_input ) : ?>
301		<input type="hidden" name="{{{ name }}}[{{{ item.fieldIndex }}}]" value="{{{ item.id }}}" />
302		<?php endif; ?>
303		</li>
304		<?php
305		}
306		}
307

htmlburger / carbon-fields

Push — development ( 987e6d...b78414 )

Relationship_Field::set_value_from_input() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like