Completed
Push — master ( b9ab02...8a7f17 )
by Zack
54:54 queued 46:56
created

View_Table_Template::__destruct()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 6
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 4
CRAP Score 1

Importance

Changes 0
Metric Value
cc 1
eloc 3
nc 1
nop 0
dl 0
loc 6
ccs 4
cts 4
cp 1
crap 1
rs 9.4285
c 0
b 0
f 0
1
<?php
0 ignored issues
show
Coding Style Compatibility introduced by
For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 14 and the first side effect is on line 6.

The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file.

The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place.

To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1.

Loading history...
2
namespace GV;
3
4
/** If this file is called directly, abort. */
5
if ( ! defined( 'GRAVITYVIEW_DIR' ) ) {
6
	die();
7
}
8
9
/**
10
 * The View Table Template class .
11
 *
12
 * Renders a \GV\View and a \GV\Entry_Collection via a \GV\View_Renderer.
13
 */
14
class View_Table_Template extends View_Template {
15
	/**
16
	 * @var string The template slug to be loaded (like "table", "list")
17
	 */
18
	public static $slug = 'table';
19
20
21
	/**
22
     * Constructor. Add filters to modify output.
23
     *
24
	 * @since 2.0.4
25
	 *
26
	 * @param View $view
27
	 * @param Entry_Collection $entries
28
	 * @param Request $request
29
	 */
30 10
	public function __construct( View $view, Entry_Collection $entries, Request $request ) {
31
32 10
	    add_filter( 'gravityview/template/field/label', array( __CLASS__, 'add_columns_sort_links' ), 100, 2 );
33
34 10
		parent::__construct( $view, $entries, $request );
35 10
	}
36
37
	/**
38
     * Add sorting links to HTML columns that support sorting
39
     *
40
     * @since 2.0.4
41
     * @since 2.0.5 Made static
42
     *
43
     * @static
44
     *
45
	 * @param string $column_label Label for the table column
46
	 * @param \GV\Template_Context $context
47
	 *
48
	 * @return string
49
	 */
50 17
	static public function add_columns_sort_links( $column_label, $context = null ) {
0 ignored issues
show
Coding Style introduced by
As per PSR2, the static declaration should come after the visibility declaration.
Loading history...
51
52 17
		$sort_columns = $context->view->settings->get( 'sort_columns' );
53
54 17
		if ( empty( $sort_columns ) ) {
55 17
            return $column_label;
56
		}
57
58
		if ( ! \GravityView_frontend::getInstance()->is_field_sortable( $context->field->ID, $context->view->form->form ) ) {
59
			return $column_label;
60
		}
61
62
		$sorting = \GravityView_View::getInstance()->getSorting();
63
64
		$class = 'gv-sort';
65
66
		$sort_field_id = \GravityView_frontend::_override_sorting_id_by_field_type( $context->field->ID, $context->view->form->ID );
67
68
		$sort_args = array(
69
			'sort' => $context->field->ID,
70
			'dir' => 'asc',
71
		);
72
73
		if ( ! empty( $sorting['key'] ) && (string) $sort_field_id === (string) $sorting['key'] ) {
74
			//toggle sorting direction.
75
			if ( 'asc' === $sorting['direction'] ) {
76
				$sort_args['dir'] = 'desc';
77
				$class .= ' gv-icon-sort-desc';
78
			} else {
79
				$sort_args['dir'] = 'asc';
80
				$class .= ' gv-icon-sort-asc';
81
			}
82
		} else {
83
			$class .= ' gv-icon-caret-up-down';
84
		}
85
86
		$url = add_query_arg( $sort_args, remove_query_arg( array('pagenum') ) );
0 ignored issues
show
introduced by
No space after opening parenthesis of array is bad style
Loading history...
introduced by
No space before closing parenthesis of array is bad style
Loading history...
87
88
		return '<a href="'. esc_url_raw( $url ) .'" class="'. $class .'" ></a>&nbsp;'. $column_label;
89
	}
90
91
	/**
92
	 * Output the table column names.
93
	 *
94
	 * @return void
95
	 */
96 11
	public function the_columns() {
97 11
		$fields = $this->view->fields->by_position( 'directory_table-columns' );
98
99 11
		foreach ( $fields->by_visible()->all() as $field ) {
100 11
			$context = Template_Context::from_template( $this, compact( 'field' ) );
101 11
			$form = $field->form_id ? GF_Form::by_id( $field->form_id ) : $this->view->form;
102
103
			/**
104
			 * @deprecated Here for back-compatibility.
105
			 */
106 11
			$column_label = apply_filters( 'gravityview_render_after_label', $field->get_label( $this->view, $form ), $field->as_configuration() );
107 11
			$column_label = apply_filters( 'gravityview/template/field_label', $column_label, $field->as_configuration(), $form->form ? $form->form : null, null );
0 ignored issues
show
Documentation introduced by
The property $form is declared private in GV\Form. 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...
108
109
			/**
110
			 * @filter `gravityview/template/field/label` Override the field label.
111
			 * @since 2.0
112
			 * @param[in,out] string $column_label The label to override.
113
			 * @param \GV\Template_Context $context The context. Does not have entry set here.
114
			 */
115 11
			$column_label = apply_filters( 'gravityview/template/field/label', $column_label, $context );
116
117
			$args = array(
118 11
				'hide_empty' => false,
119 11
				'zone_id' => 'directory_table-columns',
120 11
				'markup' => '<th id="{{ field_id }}" class="{{ class }}">{{label}}</th>',
121 11
				'label_markup' => '<span class="gv-field-label">{{ label }}</span>',
122 11
				'label' => $column_label,
123
			);
124
125 11
			echo \gravityview_field_output( $args, $context );
0 ignored issues
show
introduced by
Expected next thing to be a escaping function, not '\'
Loading history...
126
		}
127 11
	}
128
129
	/**
130
	 * Output the entry row.
131
	 *
132
	 * @param \GV\Entry $entry The entry to be rendered.
133
	 * @param array $attributes The attributes for the <tr> tag
134
	 *
135
	 * @return void
136
	 */
137 9
	public function the_entry( \GV\Entry $entry, $attributes ) {
138
139 9
		$fields = $this->view->fields->by_position( 'directory_table-columns' )->by_visible();
140
141 9
		$context = Template_Context::from_template( $this, compact( 'entry', 'fields' ) );
142
143
		/**
144
		 * Push legacy entry context.
145
		 */
146 9
		\GV\Mocks\Legacy_Context::load( array(
147 9
			'entry' => $entry,
148
		) );
149
150
		/**
151
		 * @filter `gravityview_table_cells` Modify the fields displayed in a table
152
		 * @param array $fields
153
		 * @param GravityView_View $this
154
		 * @deprecated Use `gravityview/template/table/fields`
155
		 */
156 9
		$fields = apply_filters( 'gravityview_table_cells', $fields->as_configuration(), \GravityView_View::getInstance() );
157 9
		$fields = Field_Collection::from_configuration( $fields );
158
159
		/**
160
		 * @filter `gravityview/template/table/fields` Modify the fields displayed in this tables.
161
		 * @param \GV\Field_Collection $fields The fields.
162
		 * @param \GV\Template_Context $context The context.
163
		 * @since 2.0
164
		 */
165 9
		$fields = apply_filters( 'gravityview/template/table/fields', $fields, $context );
166
167 9
		$context = Template_Context::from_template( $this, compact( 'entry', 'fields' ) );
168
169
		/**
170
		 * @filter `gravityview/template/table/entry/row/attributes` Filter the row attributes for the row in table view.
171
		 *
172
		 * @param array $attributes The HTML attributes.
173
		 * @param \GV\Template_Context The context.
174
		 *
175
		 * @since 2.0
176
		 */
177 9
		$attributes = apply_filters( 'gravityview/template/table/entry/row/attributes', $attributes, $context );
178
179
		/** Glue the attributes together. */
180 9
		foreach ( $attributes as $attribute => $value ) {
181 9
			$attributes[ $attribute ] = sprintf( "$attribute=\"%s\"", esc_attr( $value ) );
182
		}
183 9
		$attributes = implode( ' ', $attributes );
184
185
		?>
186
			<tr<?php echo $attributes ? " $attributes" : ''; ?>>
0 ignored issues
show
introduced by
Expected next thing to be a escaping function, not '$attributes'
Loading history...
187
                <?php
188
189
				/**
190
				 * @action `gravityview/template/table/cells/before` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
191
				 * @since 2.0
192
				 * @param \GV\Template_Context The context.
193
				 */
194 9
				do_action( 'gravityview/template/table/cells/before', $context );
195
196
                /**
197
                 * @action `gravityview_table_cells_before` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
198
                 * @since 1.0.7
199
				 * @param GravityView_View $this Current GravityView_View object
200
				 * @deprecated Use `gravityview/template/table/cells/before`
201
                 */
202 9
                do_action( 'gravityview_table_cells_before', \GravityView_View::getInstance() );
203
204 9
                foreach ( $fields->all() as $field ) {
205 9
					$this->the_field( $field, $entry );
206
				}
207
208
				/**
209
				 * @action `gravityview/template/table/cells/after` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
210
				 * @since 2.0
211
				 * @param \GV\Template_Context The context.
212
				 */
213 9
				do_action( 'gravityview/template/table/cells/after', $context );
214
215
                /**
216
                 * @action `gravityview_table_cells_after` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
217
                 * @since 1.0.7
218
				 * @param GravityView_View $this Current GravityView_View object
219
				 * @deprecated Use `gravityview/template/table/cells/after`
220
                 */
221 9
                do_action( 'gravityview_table_cells_after', \GravityView_View::getInstance() );
222
223
				?>
224 9
			</tr>
225
		<?php
226 9
	}
227
228
	/**
229
	 * Output a field cell.
230
	 *
231
	 * @param \GV\Field $field The field to be ouput.
232
	 * @param \GV\Field $entry The entry this field is for.
233
	 *
234
	 * @return void
235
	 */
236 8
	public function the_field( \GV\Field $field, \GV\Entry $entry ) {
237 8
		$form = $this->view->form;
238
239 8
		if ( $entry instanceof Multi_Entry ) {
240 1
			if ( ! $entry = Utils::get( $entry, $field->form_id ) ) {
0 ignored issues
show
Documentation introduced by
The property form_id does not exist on object<GV\Field>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read 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.");
        }
    }

}

If the property has read access only, you can use the @property-read 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...
241
				return;
242
			}
243 1
			$form = GF_Form::by_id( $field->form_id );
0 ignored issues
show
Documentation introduced by
The property form_id does not exist on object<GV\Field>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read 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.");
        }
    }

}

If the property has read access only, you can use the @property-read 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...
244
		}
245
246 8
		$context = Template_Context::from_template( $this, compact( 'field', 'entry' ) );
247
248 8
		$renderer = new Field_Renderer();
249 8
		$source = is_numeric( $field->ID ) ? $this->view->form : new Internal_Source();
250
251 8
		$value = $renderer->render( $field, $this->view, $source, $entry, $this->request );
252
253
		$args = array(
254 8
			'value' => $value,
255
			'hide_empty' => false,
256 8
			'zone_id' => 'directory_table-columns',
257 8
			'markup' => '<td id="{{ field_id }}" class="{{ class }}">{{ value }}</td>',
258 8
            'form' => $form,
259
		);
260
261
		/** Output. */
262 8
		echo \gravityview_field_output( $args, $context );
0 ignored issues
show
introduced by
Expected next thing to be a escaping function, not '\'
Loading history...
263 8
	}
264
265
	/**
266
	 * `gravityview_table_body_before` and `gravityview/template/table/body/before` actions.
267
	 *
268
	 * Output inside the `tbody` of the table.
269
	 *
270
	 * @param $context \GV\Template_Context The 2.0 context.
271
	 *
272
	 * @return void
273
	 */
274 10
	public static function body_before( $context ) {
275
		/**
276
		 * @action `gravityview/template/table/body/before` Output inside the `tbody` of the table.
277
		 * @since 2.0
278
		 * @param \GV\Template_Context $context The template context.
279
		 */
280 10
		do_action( 'gravityview/template/table/body/before', $context );
281
282
		/**
283
		* @action `gravityview_table_body_before` Inside the `tbody`, before any rows are rendered. Can be used to insert additional rows.
284
		* @deprecated Use `gravityview/template/table/body/before`
285
		* @since 1.0.7
286
		* @param \GravityView_View $gravityview_view Current GravityView_View object.
287
		*/
288 10
		do_action( 'gravityview_table_body_before', \GravityView_View::getInstance() /** ugh! */ );
289 10
	}
290
291
	/**
292
	 * `gravityview_table_body_after` and `gravityview/template/table/body/after` actions.
293
	 *
294
	 * Output inside the `tbody` of the table.
295
	 *
296
	 * @param $context \GV\Template_Context The 2.0 context.
297
	 *
298
	 * @return void
299
	 */
300 10
	public static function body_after( $context ) {
301
		/**
302
		 * @action `gravityview/template/table/body/after` Output inside the `tbody` of the table at the end.
303
		 * @since 2.0
304
		 * @param \GV\Template_Context $context The template context.
305
		 */
306 10
		do_action( 'gravityview/template/table/body/after', $context );
307
308
		/**
309
		* @action `gravityview_table_body_after` Inside the `tbody`, after any rows are rendered. Can be used to insert additional rows.
310
		* @deprecated Use `gravityview/template/table/body/after`
311
		* @since 1.0.7
312
		* @param \GravityView_View $gravityview_view Current GravityView_View object.
313
		*/
314 10
		do_action( 'gravityview_table_body_after', \GravityView_View::getInstance() /** ugh! */ );
315 10
	}
316
317
	/**
318
	 * `gravityview_table_tr_before` and `gravityview/template/table/tr/after` actions.
319
	 *
320
	 * Output inside the `tr` of the table.
321
	 *
322
	 * @param $context \GV\Template_Context The 2.0 context.
323
	 *
324
	 * @return void
325
	 */
326 4
	public static function tr_before( $context ) {
327
		/**
328
		 * @action `gravityview/template/table/tr/before` Output inside the `tr` of the table when there are no results.
329
		 * @since 2.0
330
		 * @param \GV\Template_Context $context The template context.
331
		 */
332 4
		do_action( 'gravityview/template/table/tr/before', $context );
333
334
		/**
335
		 * @action `gravityview_table_tr_before` Before the `tr` while rendering each entry in the loop. Can be used to insert additional table rows.
336
		 * @since 1.0.7
337
		 * @deprecated USe `gravityview/template/table/tr/before`
338
		 * @param \GravityView_View $gravityview_view Current GraivtyView_View object.
339
		 */
340 4
		do_action( 'gravityview_table_tr_before', \GravityView_View::getInstance() /** ugh! */ );
341 4
	}
342
343
	/**
344
	 * `gravityview_table_tr_after` and `gravityview/template/table/tr/after` actions.
345
	 *
346
	 * Output inside the `tr` of the table.
347
	 *
348
	 * @param $context \GV\Template_Context The 2.0 context.
349
	 *
350
	 * @return void
351
	 */
352 4
	public static function tr_after( $context ) {
353
		/**
354
		 * @action `gravityview/template/table/tr/after` Output inside the `tr` of the table when there are no results.
355
		 * @since 2.0
356
		 * @param \GV\Template_Context $context The template context.
357
		 */
358 4
		do_action( 'gravityview/template/table/tr/after', $context );
359
360
		/**
361
		 * @action `gravityview_table_tr_after` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
362
		 * @since 1.0.7
363
		 * @deprecated USe `gravityview/template/table/tr/after`
364
		 * @param \GravityView_View $gravityview_view Current GravityView_View object.
365
		 */
366 4
		do_action( 'gravityview_table_tr_after', \GravityView_View::getInstance() /** ugh! */ );
367 4
	}
368
369
	/**
370
	 * `gravityview_entry_class` and `gravityview/template/table/entry/class` filters.
371
	 *
372
	 * Modify of the class of a row.
373
	 *
374
	 * @param string $class The class.
375
	 * @param \GV\Entry $entry The entry.
376
	 * @param \GV\Template_Context The context.
377
	 *
378
	 * @return string The classes.
379
	 */
380 8
	public static function entry_class( $class, $entry, $context ) {
381
		/**
382
		 * @filter `gravityview_entry_class` Modify the class applied to the entry row.
383
		 * @param string $class Existing class.
384
		 * @param array $entry Current entry being displayed
385
		 * @param \GravityView_View $this Current GravityView_View object
386
		 * @deprecated Use `gravityview/template/table/entry/class`
387
		 * @return string The modified class.
388
		 */
389 8
		$class = apply_filters( 'gravityview_entry_class', $class, $entry->as_entry(), \GravityView_View::getInstance() );
390
391
		/**
392
		 * @filter `gravityview/template/table/entry/class` Modify the class aplied to the entry row.
393
		 * @param string $class The existing class.
394
		 * @param \GV\Template_Context The context.
395
		 * @return string The modified class.
396
		 */
397 8
		return apply_filters( 'gravityview/template/table/entry/class', $class, Template_Context::from_template( $context->template, compact( 'entry' ) ) );
398
	}
399
}
400