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

Completed

Push — develop ( 909693...91529b )

by Zack

created 2018-09-27 16:42 UTC

View_Table_Template::__construct() A

↳ Parent: View_Table_Template

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
nc	1
nop	3
dl	0
loc	6
ccs	4
cts	4
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php

namespace GV;

/** If this file is called directly, abort. */
if ( ! defined( 'GRAVITYVIEW_DIR' ) ) {
	die();
}

/**
 * The View Table Template class .
 *
 * Renders a \GV\View and a \GV\Entry_Collection via a \GV\View_Renderer.
 */
class View_Table_Template extends View_Template {
	/**
	 * @var string The template slug to be loaded (like "table", "list")
	 */
	public static $slug = 'table';


	/**
     * Constructor. Add filters to modify output.
     *
	 * @since 2.0.4
	 *
	 * @param View $view
	 * @param Entry_Collection $entries
	 * @param Request $request
	 */
	public function __construct( View $view, Entry_Collection $entries, Request $request ) {

	    add_filter( 'gravityview/template/field/label', array( __CLASS__, 'add_columns_sort_links' ), 100, 2 );

		parent::__construct( $view, $entries, $request );
	}

	/**
     * Add sorting links to HTML columns that support sorting
     *
     * @since 2.0.4
     * @since 2.0.5 Made static
     *
     * @static
     *
	 * @param string $column_label Label for the table column
	 * @param \GV\Template_Context $context
	 *
	 * @return string
	 */
	static public function add_columns_sort_links( $column_label, $context = null ) {


		$sort_columns = $context->view->settings->get( 'sort_columns' );

		if ( empty( $sort_columns ) ) {
            return $column_label;
		}

		if ( ! \GravityView_frontend::getInstance()->is_field_sortable( $context->field->ID, $context->view->form->form ) ) {
			return $column_label;
		}

		$sorting = \GravityView_View::getInstance()->getSorting();

		$class = 'gv-sort';

		$sort_field_id = \GravityView_frontend::_override_sorting_id_by_field_type( $context->field->ID, $context->view->form->ID );

		$sort_args = array(
			'sort' => $context->field->ID,
			'dir' => 'asc',
		);

		if ( ! empty( $sorting['key'] ) && (string) $sort_field_id === (string) $sorting['key'] ) {
			//toggle sorting direction.
			if ( 'asc' === $sorting['direction'] ) {
				$sort_args['dir'] = 'desc';
				$class .= ' gv-icon-sort-desc';
			} else {
				$sort_args['dir'] = 'asc';
				$class .= ' gv-icon-sort-asc';
			}
		} else {
			$class .= ' gv-icon-caret-up-down';
		}

		$url = add_query_arg( $sort_args, remove_query_arg( array('pagenum') ) );


		return '<a href="'. esc_url_raw( $url ) .'" class="'. $class .'" ></a>&nbsp;'. $column_label;
	}

	/**
	 * Output the table column names.
	 *
	 * @return void
	 */
	public function the_columns() {
		$fields = $this->view->fields->by_position( 'directory_table-columns' );

		foreach ( $fields->by_visible()->all() as $field ) {
			$context = Template_Context::from_template( $this, compact( 'field' ) );

			$args = array(
				'field' => is_numeric( $field->ID ) ? $field->as_configuration() : null,
				'hide_empty' => false,
				'zone_id' => 'directory_table-columns',
				'markup' => '<th id="{{ field_id }}" class="{{ class }}" style="{{width:style}}" data-label="{{label_value:esc_attr}}">{{label}}</th>',
				'label_markup' => '<span class="gv-field-label">{{ label }}</span>',
				'label' => self::get_field_column_label( $field, $context ),
			);

			echo \gravityview_field_output( $args, $context );

		}
	}

	/**
     * Returns the label for a column, with support for all deprecated filters
     *
     * @since 2.1
     *
	 * @param \GV\Field $field
	 * @param \GV\Template_Context $context
	 */
	protected static function get_field_column_label( $field, $context = null ) {

		$form = $field->form_id ? GF_Form::by_id( $field->form_id ) : $context->view->form;
<?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.");
        }
    }

}

		/**
		 * @deprecated Here for back-compatibility.
		 */
		$column_label = apply_filters( 'gravityview_render_after_label', $field->get_label( $context->view, $form ), $field->as_configuration() );
		$column_label = apply_filters( 'gravityview/template/field_label', $column_label, $field->as_configuration(), $form->form ? $form->form : null, null );

		/**
		 * @filter `gravityview/template/field/label` Override the field label.
		 * @since 2.0
		 * @param[in,out] string $column_label The label to override.
		 * @param \GV\Template_Context $context The context. Does not have entry set here.
		 */
		$column_label = apply_filters( 'gravityview/template/field/label', $column_label, $context );

		return $column_label;
    }

	/**
	 * Output the entry row.
	 *
	 * @param \GV\Entry $entry The entry to be rendered.
	 * @param array $attributes The attributes for the <tr> tag
	 *
	 * @return void
	 */
	public function the_entry( \GV\Entry $entry, $attributes ) {

		$fields = $this->view->fields->by_position( 'directory_table-columns' )->by_visible();

		$context = Template_Context::from_template( $this, compact( 'entry', 'fields' ) );

		/**
		 * Push legacy entry context.
		 */
		\GV\Mocks\Legacy_Context::load( array(
			'entry' => $entry,
		) );

		/**
		 * @filter `gravityview_table_cells` Modify the fields displayed in a table
		 * @param array $fields
		 * @param \GravityView_View $this
		 * @deprecated Use `gravityview/template/table/fields`
		 */
		$fields = apply_filters( 'gravityview_table_cells', $fields->as_configuration(), \GravityView_View::getInstance() );
		$fields = Field_Collection::from_configuration( $fields );

		/**
		 * @filter `gravityview/template/table/fields` Modify the fields displayed in this tables.
		 * @param \GV\Field_Collection $fields The fields.
		 * @param \GV\Template_Context $context The context.
		 * @since 2.0
		 */
		$fields = apply_filters( 'gravityview/template/table/fields', $fields, $context );

		$context = Template_Context::from_template( $this, compact( 'entry', 'fields' ) );

		/**
		 * @filter `gravityview/template/table/entry/row/attributes` Filter the row attributes for the row in table view.
		 *
		 * @param array $attributes The HTML attributes.
		 * @param \GV\Template_Context The context.
		 *
		 * @since 2.0
		 */
		$attributes = apply_filters( 'gravityview/template/table/entry/row/attributes', $attributes, $context );

		/** Glue the attributes together. */
		foreach ( $attributes as $attribute => $value ) {
			$attributes[ $attribute ] = sprintf( "$attribute=\"%s\"", esc_attr( $value ) );
		}
		$attributes = implode( ' ', $attributes );

		?>
			<tr<?php echo $attributes ? " $attributes" : ''; ?>>

                <?php

				/**
				 * @action `gravityview/template/table/cells/before` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
				 * @since 2.0
				 * @param \GV\Template_Context The context.
				 */
				do_action( 'gravityview/template/table/cells/before', $context );

                /**
                 * @action `gravityview_table_cells_before` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
                 * @since 1.0.7
				 * @param \GravityView_View $this Current GravityView_View object
				 * @deprecated Use `gravityview/template/table/cells/before`
                 */
                do_action( 'gravityview_table_cells_before', \GravityView_View::getInstance() );

                foreach ( $fields->all() as $field ) {
					$this->the_field( $field, $entry );
				}

				/**
				 * @action `gravityview/template/table/cells/after` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
				 * @since 2.0
				 * @param \GV\Template_Context The context.
				 */
				do_action( 'gravityview/template/table/cells/after', $context );

                /**
                 * @action `gravityview_table_cells_after` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
                 * @since 1.0.7
				 * @param \GravityView_View $this Current GravityView_View object
				 * @deprecated Use `gravityview/template/table/cells/after`
                 */
                do_action( 'gravityview_table_cells_after', \GravityView_View::getInstance() );

				?>
			</tr>
		<?php
	}

	/**
	 * Output a field cell.
	 *
	 * @param \GV\Field $field The field to be ouput.
	 * @param \GV\Field $entry The entry this field is for.
	 *
	 * @return void
	 */
	public function the_field( \GV\Field $field, \GV\Entry $entry ) {
		$form = $this->view->form;

		if ( $entry instanceof Multi_Entry ) {
			if ( ! $entry = Utils::get( $entry, $field->form_id ) ) {
<?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.");
        }
    }

}
				return;
			}
			$form = GF_Form::by_id( $field->form_id );
<?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.");
        }
    }

}
		}

		$context = Template_Context::from_template( $this, compact( 'field', 'entry' ) );

		$renderer = new Field_Renderer();
		$source = is_numeric( $field->ID ) ? $this->view->form : new Internal_Source();

		$value = $renderer->render( $field, $this->view, $source, $entry, $this->request );

		$args = array(
			'entry' => $entry->as_entry(),
			'field' => is_numeric( $field->ID ) ? $field->as_configuration() : null,
			'value' => $value,
			'hide_empty' => false,
			'zone_id' => 'directory_table-columns',
            'label' => self::get_field_column_label( $field, $context ),
			'markup' => '<td id="{{ field_id }}" class="{{ class }}" data-label="{{label_value:esc_attr}}">{{ value }}</td>',
            'form' => $form,
		);

		/** Output. */
		echo \gravityview_field_output( $args, $context );

	}

	/**
	 * `gravityview_table_body_before` and `gravityview/template/table/body/before` actions.
	 *
	 * Output inside the `tbody` of the table.
	 *
	 * @param $context \GV\Template_Context The 2.0 context.
	 *
	 * @return void
	 */
	public static function body_before( $context ) {
		/**
		 * @action `gravityview/template/table/body/before` Output inside the `tbody` of the table.
		 * @since 2.0
		 * @param \GV\Template_Context $context The template context.
		 */
		do_action( 'gravityview/template/table/body/before', $context );

		/**
		* @action `gravityview_table_body_before` Inside the `tbody`, before any rows are rendered. Can be used to insert additional rows.
		* @deprecated Use `gravityview/template/table/body/before`
		* @since 1.0.7
		* @param \GravityView_View $gravityview_view Current GravityView_View object.
		*/
		do_action( 'gravityview_table_body_before', \GravityView_View::getInstance() /** ugh! */ );
	}

	/**
	 * `gravityview_table_body_after` and `gravityview/template/table/body/after` actions.
	 *
	 * Output inside the `tbody` of the table.
	 *
	 * @param $context \GV\Template_Context The 2.0 context.
	 *
	 * @return void
	 */
	public static function body_after( $context ) {
		/**
		 * @action `gravityview/template/table/body/after` Output inside the `tbody` of the table at the end.
		 * @since 2.0
		 * @param \GV\Template_Context $context The template context.
		 */
		do_action( 'gravityview/template/table/body/after', $context );

		/**
		* @action `gravityview_table_body_after` Inside the `tbody`, after any rows are rendered. Can be used to insert additional rows.
		* @deprecated Use `gravityview/template/table/body/after`
		* @since 1.0.7
		* @param \GravityView_View $gravityview_view Current GravityView_View object.
		*/
		do_action( 'gravityview_table_body_after', \GravityView_View::getInstance() /** ugh! */ );
	}

	/**
	 * `gravityview_table_tr_before` and `gravityview/template/table/tr/after` actions.
	 *
	 * Output inside the `tr` of the table.
	 *
	 * @param $context \GV\Template_Context The 2.0 context.
	 *
	 * @return void
	 */
	public static function tr_before( $context ) {
		/**
		 * @action `gravityview/template/table/tr/before` Output inside the `tr` of the table when there are no results.
		 * @since 2.0
		 * @param \GV\Template_Context $context The template context.
		 */
		do_action( 'gravityview/template/table/tr/before', $context );

		/**
		 * @action `gravityview_table_tr_before` Before the `tr` while rendering each entry in the loop. Can be used to insert additional table rows.
		 * @since 1.0.7
		 * @deprecated USe `gravityview/template/table/tr/before`
		 * @param \GravityView_View $gravityview_view Current GraivtyView_View object.
		 */
		do_action( 'gravityview_table_tr_before', \GravityView_View::getInstance() /** ugh! */ );
	}

	/**
	 * `gravityview_table_tr_after` and `gravityview/template/table/tr/after` actions.
	 *
	 * Output inside the `tr` of the table.
	 *
	 * @param $context \GV\Template_Context The 2.0 context.
	 *
	 * @return void
	 */
	public static function tr_after( $context ) {
		/**
		 * @action `gravityview/template/table/tr/after` Output inside the `tr` of the table when there are no results.
		 * @since 2.0
		 * @param \GV\Template_Context $context The template context.
		 */
		do_action( 'gravityview/template/table/tr/after', $context );

		/**
		 * @action `gravityview_table_tr_after` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
		 * @since 1.0.7
		 * @deprecated USe `gravityview/template/table/tr/after`
		 * @param \GravityView_View $gravityview_view Current GravityView_View object.
		 */
		do_action( 'gravityview_table_tr_after', \GravityView_View::getInstance() /** ugh! */ );
	}

	/**
	 * `gravityview_entry_class` and `gravityview/template/table/entry/class` filters.
	 *
	 * Modify of the class of a row.
	 *
	 * @param string $class The class.
	 * @param \GV\Entry $entry The entry.
	 * @param \GV\Template_Context The context.
	 *
	 * @return string The classes.
	 */
	public static function entry_class( $class, $entry, $context ) {
		/**
		 * @filter `gravityview_entry_class` Modify the class applied to the entry row.
		 * @param string $class Existing class.
		 * @param array $entry Current entry being displayed
		 * @param \GravityView_View $this Current GravityView_View object
		 * @deprecated Use `gravityview/template/table/entry/class`
		 * @return string The modified class.
		 */
		$class = apply_filters( 'gravityview_entry_class', $class, $entry->as_entry(), \GravityView_View::getInstance() );

		/**
		 * @filter `gravityview/template/table/entry/class` Modify the class aplied to the entry row.
		 * @param string $class The existing class.
		 * @param \GV\Template_Context The context.
		 * @return string The modified class.
		 */
		return apply_filters( 'gravityview/template/table/entry/class', $class, Template_Context::from_template( $context->template, compact( 'entry' ) ) );
	}
}


1		<?php
		0 ignored issues – show Coding Style Compatibility introduced 2017-03-29 06:38 UTC by Report Bug Copy Issue Report 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	14	public function __construct( View $view, Entry_Collection $entries, Request $request ) {
31
32	14	add_filter( 'gravityview/template/field/label', array( __CLASS__, 'add_columns_sort_links' ), 100, 2 );
33
34	14	parent::__construct( $view, $entries, $request );
35	14	}
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	23	static public function add_columns_sort_links( $column_label, $context = null ) {
		0 ignored issues – show Coding Style introduced 2018-05-14 19:19 UTC by Report Bug Copy Issue Report As per PSR2, the `static` declaration should come after the visibility declaration. Loading history...
51
52	23	$sort_columns = $context->view->settings->get( 'sort_columns' );
53
54	23	if ( empty( $sort_columns ) ) {
55	23	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 2016-01-18 22:19 UTC by Report Bug Copy Issue Report No space after opening parenthesis of array is bad style Loading history... introduced 2016-01-18 22:19 UTC by Report Bug Copy Issue Report No space before closing parenthesis of array is bad style Loading history...
87
88		return '<a href="'. esc_url_raw( $url ) .'" class="'. $class .'" ></a> '. $column_label;
89		}
90
91		/**
92		* Output the table column names.
93		*
94		* @return void
95		*/
96	15	public function the_columns() {
97	15	$fields = $this->view->fields->by_position( 'directory_table-columns' );
98
99	15	foreach ( $fields->by_visible()->all() as $field ) {
100	15	$context = Template_Context::from_template( $this, compact( 'field' ) );
101	15
102		$args = array(
103		'field' => is_numeric( $field->ID ) ? $field->as_configuration() : null,
104		'hide_empty' => false,
105		'zone_id' => 'directory_table-columns',
106	15	'markup' => '<th id="{{ field_id }}" class="{{ class }}" style="{{width:style}}" data-label="{{label_value:esc_attr}}">{{label}}</th>',
107	15	'label_markup' => '<span class="gv-field-label">{{ label }}</span>',
108		'label' => self::get_field_column_label( $field, $context ),
109		);
110
111		echo \gravityview_field_output( $args, $context );
		0 ignored issues – show introduced 2018-05-08 22:40 UTC by Report Bug Copy Issue Report Expected next thing to be a escaping function, not '\' Loading history...
112		}
113		}
114
115	15	/**
116		* Returns the label for a column, with support for all deprecated filters
117		*
118	15	* @since 2.1
119		*
120	15	* @param \GV\Field $field
121	15	* @param \GV\Template_Context $context
122	15	*/
123	15	protected static function get_field_column_label( $field, $context = null ) {
124
125		$form = $field->form_id ? GF_Form::by_id( $field->form_id ) : $context->view->form;
		0 ignored issues – show Documentation introduced 2018-06-26 20:24 UTC by Report Bug Copy Issue Report 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...
126	15
127		/**
128	15	* @deprecated Here for back-compatibility.
129		*/
130		$column_label = apply_filters( 'gravityview_render_after_label', $field->get_label( $context->view, $form ), $field->as_configuration() );
131		$column_label = apply_filters( 'gravityview/template/field_label', $column_label, $field->as_configuration(), $form->form ? $form->form : null, null );
132
133		/**
134		* @filter `gravityview/template/field/label` Override the field label.
135		* @since 2.0
136		* @param[in,out] string $column_label The label to override.
137		* @param \GV\Template_Context $context The context. Does not have entry set here.
138	12	*/
139		$column_label = apply_filters( 'gravityview/template/field/label', $column_label, $context );
140	12
141		return $column_label;
142	12	}
143
144		/**
145		* Output the entry row.
146		*
147	12	* @param \GV\Entry $entry The entry to be rendered.
148	12	* @param array $attributes The attributes for the <tr> tag
149		*
150		* @return void
151		*/
152		public function the_entry( \GV\Entry $entry, $attributes ) {
153
154		$fields = $this->view->fields->by_position( 'directory_table-columns' )->by_visible();
155
156		$context = Template_Context::from_template( $this, compact( 'entry', 'fields' ) );
157	12
158	12	/**
159		* Push legacy entry context.
160		*/
161		\GV\Mocks\Legacy_Context::load( array(
162		'entry' => $entry,
163		) );
164
165		/**
166	12	* @filter `gravityview_table_cells` Modify the fields displayed in a table
167		* @param array $fields
168	12	* @param \GravityView_View $this
169		* @deprecated Use `gravityview/template/table/fields`
170		*/
171		$fields = apply_filters( 'gravityview_table_cells', $fields->as_configuration(), \GravityView_View::getInstance() );
172		$fields = Field_Collection::from_configuration( $fields );
173
174		/**
175		* @filter `gravityview/template/table/fields` Modify the fields displayed in this tables.
176		* @param \GV\Field_Collection $fields The fields.
177		* @param \GV\Template_Context $context The context.
178	12	* @since 2.0
179		*/
180		$fields = apply_filters( 'gravityview/template/table/fields', $fields, $context );
181	12
182	12	$context = Template_Context::from_template( $this, compact( 'entry', 'fields' ) );
183
184	12	/**
185		* @filter `gravityview/template/table/entry/row/attributes` Filter the row attributes for the row in table view.
186		*
187		* @param array $attributes The HTML attributes.
188		* @param \GV\Template_Context The context.
189		*
190		* @since 2.0
191		*/
192		$attributes = apply_filters( 'gravityview/template/table/entry/row/attributes', $attributes, $context );
193
194		/** Glue the attributes together. */
195	12	foreach ( $attributes as $attribute => $value ) {
196		$attributes[ $attribute ] = sprintf( "$attribute=\"%s\"", esc_attr( $value ) );
197		}
198		$attributes = implode( ' ', $attributes );
199
200		?>
201		<tr<?php echo $attributes ? " $attributes" : ''; ?>>
		0 ignored issues – show introduced 2018-05-08 22:40 UTC by Report Bug Copy Issue Report Expected next thing to be a escaping function, not '$attributes' Loading history...
202		<?php
203	12
204		/**
205	12	* @action `gravityview/template/table/cells/before` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
206	12	* @since 2.0
207		* @param \GV\Template_Context The context.
208		*/
209		do_action( 'gravityview/template/table/cells/before', $context );
210
211		/**
212		* @action `gravityview_table_cells_before` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
213		* @since 1.0.7
214	12	* @param \GravityView_View $this Current GravityView_View object
215		* @deprecated Use `gravityview/template/table/cells/before`
216		*/
217		do_action( 'gravityview_table_cells_before', \GravityView_View::getInstance() );
218
219		foreach ( $fields->all() as $field ) {
220		$this->the_field( $field, $entry );
221		}
222	12
223		/**
224		* @action `gravityview/template/table/cells/after` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
225	12	* @since 2.0
226		* @param \GV\Template_Context The context.
227	12	*/
228		do_action( 'gravityview/template/table/cells/after', $context );
229
230		/**
231		* @action `gravityview_table_cells_after` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
232		* @since 1.0.7
233		* @param \GravityView_View $this Current GravityView_View object
234		* @deprecated Use `gravityview/template/table/cells/after`
235		*/
236		do_action( 'gravityview_table_cells_after', \GravityView_View::getInstance() );
237	11
238	11	?>
239		</tr>
240	11	<?php
241	1	}
242
243		/**
244	1	* Output a field cell.
245		*
246		* @param \GV\Field $field The field to be ouput.
247	11	* @param \GV\Field $entry The entry this field is for.
248		*
249	11	* @return void
250	11	*/
251		public function the_field( \GV\Field $field, \GV\Entry $entry ) {
252	11	$form = $this->view->form;
253
254		if ( $entry instanceof Multi_Entry ) {
255	11	if ( ! $entry = Utils::get( $entry, $field->form_id ) ) {
		0 ignored issues – show Documentation introduced 2018-05-08 22:39 UTC by Report Bug Copy Issue Report 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...
256	11	return;
257	11	}
258		$form = GF_Form::by_id( $field->form_id );
		0 ignored issues – show Documentation introduced 2018-05-08 22:39 UTC by Report Bug Copy Issue Report 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...
259	11	}
260	11
261	11	$context = Template_Context::from_template( $this, compact( 'field', 'entry' ) );
262
263		$renderer = new Field_Renderer();
264		$source = is_numeric( $field->ID ) ? $this->view->form : new Internal_Source();
265	11
266	11	$value = $renderer->render( $field, $this->view, $source, $entry, $this->request );
267
268		$args = array(
269		'entry' => $entry->as_entry(),
270		'field' => is_numeric( $field->ID ) ? $field->as_configuration() : null,
271		'value' => $value,
272		'hide_empty' => false,
273		'zone_id' => 'directory_table-columns',
274		'label' => self::get_field_column_label( $field, $context ),
275		'markup' => '<td id="{{ field_id }}" class="{{ class }}" data-label="{{label_value:esc_attr}}">{{ value }}</td>',
276		'form' => $form,
277	14	);
278
279		/** Output. */
280		echo \gravityview_field_output( $args, $context );
		0 ignored issues – show introduced 2018-05-08 22:40 UTC by Report Bug Copy Issue Report Expected next thing to be a escaping function, not '\' Loading history...
281		}
282
283	14	/**
284		* `gravityview_table_body_before` and `gravityview/template/table/body/before` actions.
285		*
286		* Output inside the `tbody` of the table.
287		*
288		* @param $context \GV\Template_Context The 2.0 context.
289		*
290		* @return void
291	14	*/
292	14	public static function body_before( $context ) {
293		/**
294		* @action `gravityview/template/table/body/before` Output inside the `tbody` of the table.
295		* @since 2.0
296		* @param \GV\Template_Context $context The template context.
297		*/
298		do_action( 'gravityview/template/table/body/before', $context );
299
300		/**
301		* @action `gravityview_table_body_before` Inside the `tbody`, before any rows are rendered. Can be used to insert additional rows.
302		* @deprecated Use `gravityview/template/table/body/before`
303	14	* @since 1.0.7
304		* @param \GravityView_View $gravityview_view Current GravityView_View object.
305		*/
306		do_action( 'gravityview_table_body_before', \GravityView_View::getInstance() /** ugh! */ );
307		}
308
309	14	/**
310		* `gravityview_table_body_after` and `gravityview/template/table/body/after` actions.
311		*
312		* Output inside the `tbody` of the table.
313		*
314		* @param $context \GV\Template_Context The 2.0 context.
315		*
316		* @return void
317	14	*/
318	14	public static function body_after( $context ) {
319		/**
320		* @action `gravityview/template/table/body/after` Output inside the `tbody` of the table at the end.
321		* @since 2.0
322		* @param \GV\Template_Context $context The template context.
323		*/
324		do_action( 'gravityview/template/table/body/after', $context );
325
326		/**
327		* @action `gravityview_table_body_after` Inside the `tbody`, after any rows are rendered. Can be used to insert additional rows.
328		* @deprecated Use `gravityview/template/table/body/after`
329	6	* @since 1.0.7
330		* @param \GravityView_View $gravityview_view Current GravityView_View object.
331		*/
332		do_action( 'gravityview_table_body_after', \GravityView_View::getInstance() /** ugh! */ );
333		}
334
335	6	/**
336		* `gravityview_table_tr_before` and `gravityview/template/table/tr/after` actions.
337		*
338		* Output inside the `tr` of the table.
339		*
340		* @param $context \GV\Template_Context The 2.0 context.
341		*
342		* @return void
343	6	*/
344	6	public static function tr_before( $context ) {
345		/**
346		* @action `gravityview/template/table/tr/before` Output inside the `tr` of the table when there are no results.
347		* @since 2.0
348		* @param \GV\Template_Context $context The template context.
349		*/
350		do_action( 'gravityview/template/table/tr/before', $context );
351
352		/**
353		* @action `gravityview_table_tr_before` Before the `tr` while rendering each entry in the loop. Can be used to insert additional table rows.
354		* @since 1.0.7
355	6	* @deprecated USe `gravityview/template/table/tr/before`
356		* @param \GravityView_View $gravityview_view Current GraivtyView_View object.
357		*/
358		do_action( 'gravityview_table_tr_before', \GravityView_View::getInstance() /** ugh! */ );
359		}
360
361	6	/**
362		* `gravityview_table_tr_after` and `gravityview/template/table/tr/after` actions.
363		*
364		* Output inside the `tr` of the table.
365		*
366		* @param $context \GV\Template_Context The 2.0 context.
367		*
368		* @return void
369	6	*/
370	6	public static function tr_after( $context ) {
371		/**
372		* @action `gravityview/template/table/tr/after` Output inside the `tr` of the table when there are no results.
373		* @since 2.0
374		* @param \GV\Template_Context $context The template context.
375		*/
376		do_action( 'gravityview/template/table/tr/after', $context );
377
378		/**
379		* @action `gravityview_table_tr_after` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
380		* @since 1.0.7
381		* @deprecated USe `gravityview/template/table/tr/after`
382		* @param \GravityView_View $gravityview_view Current GravityView_View object.
383	11	*/
384		do_action( 'gravityview_table_tr_after', \GravityView_View::getInstance() /** ugh! */ );
385		}
386
387		/**
388		* `gravityview_entry_class` and `gravityview/template/table/entry/class` filters.
389		*
390		* Modify of the class of a row.
391		*
392	11	* @param string $class The class.
393		* @param \GV\Entry $entry The entry.
394		* @param \GV\Template_Context The context.
395		*
396		* @return string The classes.
397		*/
398		public static function entry_class( $class, $entry, $context ) {
399		/**
400	11	* @filter `gravityview_entry_class` Modify the class applied to the entry row.
401		* @param string $class Existing class.
402		* @param array $entry Current entry being displayed
403		* @param \GravityView_View $this Current GravityView_View object
404		* @deprecated Use `gravityview/template/table/entry/class`
405		* @return string The modified class.
406		*/
407		$class = apply_filters( 'gravityview_entry_class', $class, $entry->as_entry(), \GravityView_View::getInstance() );
408
409		/**
410		* @filter `gravityview/template/table/entry/class` Modify the class aplied to the entry row.
411		* @param string $class The existing class.
412		* @param \GV\Template_Context The context.
413		* @return string The modified class.
414		*/
415		return apply_filters( 'gravityview/template/table/entry/class', $class, Template_Context::from_template( $context->template, compact( 'entry' ) ) );
416		}
417		}
418

gravityview / GravityView

Push — develop ( 909693...91529b )

View_Table_Template::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like