Completed
Push — develop ( ea3d90...75c287 )
by Gennady
27:52 queued 16:16
created

Field_Template::__construct()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 12

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 9
CRAP Score 1

Importance

Changes 0
Metric Value
cc 1
nc 1
nop 5
dl 0
loc 12
ccs 9
cts 9
cp 1
crap 1
rs 9.8666
c 0
b 0
f 0
1
<?php
2
namespace GV;
3
4
/** If this file is called directly, abort. */
5
if ( ! defined( 'GRAVITYVIEW_DIR' ) ) {
6
	die();
7
}
8
9
/**
10
 * Load up the Gamajo Template Loader.
11
 *
12
 * @see https://github.com/GaryJones/Gamajo-Template-Loader
13
 */
14
if ( ! class_exists( '\GV\Gamajo_Template_Loader' ) ) {
15
	require gravityview()->plugin->dir( 'future/lib/class-gamajo-template-loader.php' );
16
}
17
18
/**
19
 * The Field Template class.
20
 *
21
 * Attached to a \GV\Field and used by a \GV\Field_Renderer.
22
 */
23
abstract class Field_Template extends Template {
24
	/**
25
	 * Prefix for filter names.
26
	 * @var string
27
	 */
28
	protected $filter_prefix = 'gravityview/template/fields';
29
30
	/**
31
	 * Directory name where custom templates for this plugin should be found in the theme.
32
	 * @var string
33
	 */
34
	protected $theme_template_directory = 'gravityview/fields/';
35
36
	/**
37
	 * Directory name where the default templates for this plugin are found.
38
	 * @var string
39
	 */
40
	protected $plugin_template_directory = 'templates/fields/';
41
42
	/**
43
	 * @var \GV\Field The field connected to this template.
44
	 */
45
	public $field;
46
47
	/**
48
	 * @var \GV\View The view context.
49
	 */
50
	public $view;
51
52
	/**
53
	 * @var \GV\Source The source context.
54
	 */
55
	public $source;
56
57
	/**
58
	 * @var \GV\Entry The entry context.
59
	 */
60
	public $entry;
61
62
	/**
63
	 * @var \GV\Request The request context.
64
	 */
65
	public $request;
66
67
	/**
68
	 * @var string The template slug to be loaded (like "table", "list")
69
	 */
70
	public static $slug;
71
72
	/**
73
	 * Initializer.
74
	 *
75
	 * @param \GV\Field $field The field about to be rendered.
76
	 * @param \GV\View $view The view in this context, if applicable.
77
	 * @param \GV\Source $source The source (form) in this context, if applicable.
78
	 * @param \GV\Entry $entry The entry in this context, if applicable.
79
	 * @param \GV\Request $request The request in this context, if applicable.
80
	 */
81 93
	public function __construct( Field $field, View $view = null, Source $source = null, Entry $entry = null, Request $request = null ) {
82 93
		$this->field = $field;
83 93
		$this->view = $view;
84 93
		$this->source = $source;
85 93
		$this->entry = $entry;
86 93
		$this->request = $request;
87
88
		/** Add granular overrides. */
89 93
		add_filter( $this->filter_prefix . '_get_template_part', $this->_add_id_specific_templates_callback = self::add_id_specific_templates( $this ), 10, 3 );
0 ignored issues
show
Bug introduced by
The property _add_id_specific_templates_callback does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
90
91 93
		parent::__construct();
92 93
	}
93
94 93
	public function __destruct() {
95 93
		remove_filter( $this->filter_prefix . '_get_template_part', $this->_add_id_specific_templates_callback );;
96 93
	}
97
98
	/**
99
	 * Enable granular template overrides based on current post, view, form, field types, etc.
100
	 *
101
	 * Why? See https://github.com/gravityview/GravityView/issues/1024
102
	 *
103
	 * @param \GV\Field_Template $template The template instance.
104
	 * @return callable The callback bound to `get_template_part`. See `\GV\Field_Template::__construct`
105
	 */
106 93
	public static function add_id_specific_templates( $template ) {
107
108 93
		$inputType  = null;
109 93
		$field_type = null;
110 93
		$field_id   = null;
111 93
		$view_id    = null;
112 93
		$form_id    = null;
113 93
		$is_view    = $template->request && $template->request->is_view();
114
115 93
		if ( $template->field ) {
116 93
			$inputType  = $template->field->inputType;
0 ignored issues
show
Bug introduced by
The property inputType does not seem to exist in GV\Field.

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
117 93
			$field_type = $template->field->type;
0 ignored issues
show
Bug introduced by
The property type does not seem to exist in GV\Field.

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
118 93
			$field_id   = $template->field->ID;
119
		}
120
121 93
		if ( $template->view ) {
122 93
			$view_id = $template->view->ID;
0 ignored issues
show
Bug introduced by
The property ID does not seem to exist in GV\View.

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
123 93
			$form_id = $template->view->form ? $template->view->form->ID : null;
124
		}
125
126 93
		$class = get_class( $template );
127
128
		/**
129
		 * Enable granular template overrides based on current post, view, form, field types, etc.
130
		 *
131
		 * The hierarchy is as follows:
132
		 *
133
		 * - post-[ID of post of page where view is embedded]-view-[View ID]-field-[Field type]-html.php
134
		 * - post-[ID of post of page where view is embedded]-view-[View ID]-field-[Field inputType]-html.php
135
		 * - post-[ID of post of page where view is embedded]-view-[View ID]-field-html.php
136
		 * - post-[ID of post of page where view is embedded]-field-[Field type]-html.php
137
		 * - post-[ID of post of page where view is embedded]-field-[Field inputType]-html.php
138
		 * - post-[ID of post of page where view is embedded]-field-html.php
139
		 * - post-[ID of post of page where view is embedded]-view-[View ID]-field-[Field type].php
140
		 * - post-[ID of post of page where view is embedded]-view-[View ID]-field-[Field inputType].php
141
		 * - post-[ID of post of page where view is embedded]-view-[View ID]-field.php
142
		 * - post-[ID of post of page where view is embedded]-field-[Field type].php
143
		 * - post-[ID of post of page where view is embedded]-field-[Field inputType].php
144
		 * - post-[ID of post of page where view is embedded]-field.php
145
		 * - form-[Form ID]-field-[Field ID]-html.php
146
		 * - form-[Form ID]-field-[Field ID].php
147
		 * - form-[Form ID]-field-[Field type]-html.php
148
		 * - form-[Form ID]-field-[Field inputType]-html.php
149
		 * - form-[Form ID]-field-[Field type].php
150
		 * - form-[Form ID]-field-[Field inputType].php
151
		 * - view-[View ID]-field-[Field type]-html.php
152
		 * - view-[View ID]-field-[Field inputType]-html.php
153
		 * - view-[View ID]-field-[Field type].php
154
		 * - view-[View ID]-field-[Field inputType].php
155
		 * - field-[Field type]-html.php
156
		 * - field-[Field inputType]-html.php
157
		 * - field-[Field type].php
158
		 * - field-[Field inputType].php
159
		 * - field-html.php
160
		 * - field.php
161
		 *
162
		 * @see  Gamajo_Template_Loader::get_template_file_names() Where the filter is
163
		 * @param array $templates Existing list of templates.
164
		 * @param string $slug      Name of the template base, example: `html`, `json`, `xml`
165
		 * @param string $name      Name of the template part.
166
		 *
167
		 * @return array $templates Modified template array, merged with existing $templates values
168
		 */
169 93
		return function( $templates, $slug, $name ) use ( $class, $inputType, $field_type, $view_id, $is_view, $form_id, $field_id ) {
170 93
			$specifics = array();
171
172 93
			list( $slug_dir, $slug_name ) = $class::split_slug( $slug, $name );
173
174 93
			global $post;
175
176 93
			if ( $is_view && $post ) {
177 10
				if ( $field_type ) {
178 10
					$specifics []= sprintf( '%spost-%d-view-%d-field-%s-%s.php', $slug_dir, $post->ID, $view_id, $field_type, $slug_name );
179 10
					$inputType && $specifics []= sprintf( '%spost-%d-view-%d-field-%s-%s.php', $slug_dir, $post->ID, $view_id, $inputType, $slug_name );
180 10
					$specifics []= sprintf( '%spost-%d-view-%d-field-%s.php', $slug_dir, $post->ID, $view_id, $field_type );
181 10
					$inputType && $specifics []= sprintf( '%spost-%d-view-%d-field-%s.php', $slug_dir, $post->ID, $view_id, $inputType );
182 10
					$specifics []= sprintf( '%spost-%d-field-%s-%s.php', $slug_dir, $post->ID, $field_type, $slug_name );
183 10
					$inputType && $specifics []= sprintf( '%spost-%d-field-%s-%s.php', $slug_dir, $post->ID, $inputType, $slug_name );
184 10
					$specifics []= sprintf( '%spost-%d-field-%s.php', $slug_dir, $post->ID, $field_type );
185 10
					$inputType &&  $specifics []= sprintf( '%spost-%d-field-%s.php', $slug_dir, $post->ID, $inputType );
186
				}
187
188 10
				$specifics []= sprintf( '%spost-%d-view-%d-field-%s.php', $slug_dir, $post->ID, $view_id, $slug_name );
189 10
				$specifics []= sprintf( '%spost-%d-view-%d-field.php', $slug_dir, $post->ID, $view_id );
190 10
				$specifics []= sprintf( '%spost-%d-field-%s.php', $slug_dir, $post->ID, $slug_name );
191 10
				$specifics []= sprintf( '%spost-%d-field.php', $slug_dir, $post->ID );
192
			}
193
			
194
			/** Field-specific */
195 93
			if ( $field_id && $form_id ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $field_id of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For string values, the empty string '' is a special case, in particular the following results might be unexpected:

''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
Loading history...
Bug Best Practice introduced by
The expression $form_id of type integer|null is loosely compared to true; this is ambiguous if the integer can be zero. You might want to explicitly use !== null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For integer values, zero is a special case, in particular the following results might be unexpected:

0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
Loading history...
196
197 93
				if ( $field_id ) {
198 93
					$specifics []= sprintf( '%sform-%d-field-%d-%s.php', $slug_dir, $form_id, $field_id, $slug_name );
199 93
					$specifics []= sprintf( '%sform-%d-field-%d.php', $slug_dir, $form_id, $field_id );
200
				}
201
202 93
				if ( $field_type ) {
203 93
					$specifics []= sprintf( '%sform-%d-field-%s-%s.php', $slug_dir, $form_id, $field_type, $slug_name );
204 93
					$inputType && $specifics []= sprintf( '%sform-%d-field-%s-%s.php', $slug_dir, $form_id, $inputType, $slug_name );
205 93
					$specifics []= sprintf( '%sform-%d-field-%s.php', $slug_dir, $form_id, $field_type );
206 93
					$inputType && $specifics []= sprintf( '%sform-%d-field-%s.php', $slug_dir, $form_id, $inputType );
207
208 93
					$specifics []= sprintf( '%sview-%d-field-%s-%s.php', $slug_dir, $view_id, $field_type, $slug_name );
209 93
					$inputType && $specifics []= sprintf( '%sview-%d-field-%s-%s.php', $slug_dir, $view_id, $inputType, $slug_name );
210 93
					$specifics []= sprintf( '%sview-%d-field-%s.php', $slug_dir, $view_id, $field_type );
211 93
					$inputType && $specifics []= sprintf( '%sview-%d-field-%s.php', $slug_dir, $view_id, $inputType );
212
213 93
					$specifics []= sprintf( '%sfield-%s-%s.php', $slug_dir, $field_type, $slug_name );
214 93
					$inputType && $specifics []= sprintf( '%sfield-%s-%s.php', $slug_dir, $inputType, $slug_name );
215 93
					$specifics []= sprintf( '%sfield-%s.php', $slug_dir, $field_type );
216 93
					$inputType && $specifics []= sprintf( '%sfield-%s.php', $slug_dir, $inputType );
217
				}
218
			}
219
220 93
			if ( $form_id ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $form_id of type integer|null is loosely compared to true; this is ambiguous if the integer can be zero. You might want to explicitly use !== null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For integer values, zero is a special case, in particular the following results might be unexpected:

0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
Loading history...
221
				/** Generic field templates */
222 93
				$specifics []= sprintf( '%sview-%d-field-%s.php', $slug_dir, $view_id, $slug_name );
223 93
				$specifics []= sprintf( '%sform-%d-field-%s.php', $slug_dir, $form_id, $slug_name );
224
225 93
				$specifics []= sprintf( '%sview-%d-field.php', $slug_dir, $view_id );
226 93
				$specifics []= sprintf( '%sform-%d-field.php', $slug_dir, $form_id );
227
			}
228
229
			/**
230
			 * Legacy.
231
			 * Ignore some types that conflict.
232
			 */
233 93
			if ( ! in_array( $field_type, array( 'notes' ) ) ) {
234 92
				$specifics []= sprintf( '%s.php', $field_type );
235 92
				$specifics []= sprintf( 'fields/%s.php', $field_type );
236
			}
237
238 93
			$specifics []= sprintf( '%sfield-%s.php', $slug_dir, $slug_name );
239 93
			$specifics []= sprintf( '%sfield.php', $slug_dir );
240
241 93
			return array_merge( $specifics, $templates );
242 93
		};
243
	}
244
245
	/**
246
	 * Output some HTML.
247
	 *
248
	 * @todo Move to \GV\Field_HTML_Template, but call filters here?
249
	 *
250
	 * @return void
251
	 */
252 93
	public function render() {
253 93
		if ( ! $entry = $this->entry->from_field( $this->field ) ) {
254
			gravityview()->log->error( 'Entry is invalid for field. Returning empty.' );
255
			return;
256
		}
257
258
		/** Retrieve the value. */
259 93
		$display_value = $value = $this->field->get_value( $this->view, $this->source, $entry );
260
261 93
		$source = $this->source;
262 93
		$source_backend = $source ? $source::$backend : null;
263
264 93
		\GV\Mocks\Legacy_Context::load( array(
265 93
			'field' => $this->field,
266
		) );
267
268
		/** Alter the display value according to Gravity Forms. */
269 93
		if ( $source_backend == \GV\Source::BACKEND_GRAVITYFORMS ) {
270
			/** Prevent any PHP warnings that may be generated. */
271 56
			ob_start();
272
273 56
			$display_value = \GFCommon::get_lead_field_display( $this->field->field, $value, $entry['currency'], false, 'html' );
0 ignored issues
show
Documentation introduced by
The property field 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...
274
275 56
			if ( $errors = ob_get_clean() ) {
276
				gravityview()->log->error( 'Errors when calling GFCommon::get_lead_field_display()', array( 'data' => $errors ) );
277
			}
278
279
			// `gform_entry_field_value` expects a GF_Field, but $this->field->field can be NULL
280 56
			if ( ! $this->field->field instanceof GF_Field ) {
0 ignored issues
show
Documentation introduced by
The property field 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...
281 56
				$gf_field = \GF_Fields::create( $this->field->field );
0 ignored issues
show
Documentation introduced by
The property field 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...
282
			}
283
284
			/** Call the Gravity Forms field value filter. */
285 56
			$display_value = apply_filters( 'gform_entry_field_value', $display_value, $gf_field, $entry->as_entry(), $this->source->form );
0 ignored issues
show
Bug introduced by
The property form does not seem to exist in GV\Source.

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
Bug introduced by
The variable $gf_field does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
286
287 56
			unset( $gf_field );
288
289
			/** Replace merge tags for admin-only fields. */
290 56
			if ( ! empty( $this->field->field->adminOnly ) ) {
0 ignored issues
show
Documentation introduced by
The property field 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...
291
				$display_value = \GravityView_API::replace_variables( $display_value, $this->form->form, $entry->as_entry(), false, false );
0 ignored issues
show
Bug introduced by
The property form does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
292
			}
293
		}
294
295 93
		$context = Template_Context::from_template( $this, compact( 'display_value', 'value' ) );
296
297
		/**
298
		 * Make various pieces of data available to the template
299
		 *  under the $gravityview scoped variable.
300
		 *
301
		 * @filter `gravityview/template/field/context`
302
		 * @param \GV\Template_Context $context The context for this template.
303
		 * @since 2.0
304
		 */
305 93
		$this->push_template_data( apply_filters( 'gravityview/template/field/context', $context ), 'gravityview' );
306
307
		/** Bake the template. */
308 93
		ob_start();
309 93
		$this->located_template = $this->get_template_part( static::$slug );
310 93
		$output = ob_get_clean();
311
312 93
		if ( empty( $output ) ) {
313
			/**
314
			 * @filter `gravityview_empty_value` What to display when a field is empty
315
			 * @deprecated Use the `gravityview/field/value/empty` filter instead
316
			 * @param string $value (empty string)
317
			 */
318 28
			$output = apply_filters( 'gravityview_empty_value', $output );
319
320
			/**
321
			 * @filter `gravityview/field/value/empty` What to display when this field is empty.
322
			 * @param string $value The value to display (Default: empty string)
323
			 * @param \GV\Template_Context The template context this is being called from.
324
			 */
325 28
			$output = apply_filters( 'gravityview/field/value/empty', $output, Template_Context::from_template( $this ) );
326
327 28
			$context = Template_Context::from_template( $this, compact( 'display_value', 'value' ) );
328
		}
329
330 93
		gravityview()->log->info( 'Field template for field #{field_id} loaded: {located_template}', array( 'field_id' => $this->field->ID, 'located_template' => $this->located_template ) );
331
332 93
		$this->pop_template_data( 'gravityview' );
333
334
		/** A compatibility array that's required by some of the deprecated filters. */
335
		$field_compat = array(
336 93
			'form' => $source_backend == \GV\Source::BACKEND_GRAVITYFORMS ? $this->source->form : ( $this->view->form ? $this->view->form->form : 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...
337 93
			'field_id' => $this->field->ID,
338 93
			'field' => $this->field->field,
0 ignored issues
show
Documentation introduced by
The property field 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...
339 93
			'field_settings' => $this->field->as_configuration(),
340 93
			'value' => $value,
341 93
			'display_value' => $display_value,
342 93
			'format' => 'html',
343 93
			'entry' => $entry->as_entry(),
344 93
			'field_type' => $this->field->type,
0 ignored issues
show
Documentation introduced by
The property type 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...
345 93
			'field_path' => $this->located_template,
346
		);
347
348
		/**
349
		 * Wrap output in a link, if enabled in the field settings
350
		 *
351
		 * @param string $output HTML value output
352
		 * @param \GV\Template_Context $context
353
		 *
354
		 * @return mixed|string|void
355
		 */
356 93
		$pre_link_compat_callback = function( $output, $context ) use ( $field_compat ) {
357 93
			$field = $context->field;
358
359
			/**
360
			 * @filter `gravityview_field_entry_value_{$field_type}_pre_link` Modify the field value output for a field type before Show As Link setting is applied. Example: `gravityview_field_entry_value_number_pre_link`
361
			 * @since 1.16
362
			 * @param string $output HTML value output
363
			 * @param array  $entry The GF entry array
364
			 * @param array  $field_settings Settings for the particular GV field
365
			 * @param array  $field Field array, as fetched from GravityView_View::getCurrentField()
366
			 *
367
			 * @deprecated Use the `gravityview/field/{$field_type}/output` or `gravityview/field/output` filters instead.
368
			 */
369 93
			$output = apply_filters( "gravityview_field_entry_value_{$field->type}_pre_link", $output, $context->entry->as_entry(), $field->as_configuration(), $field_compat );
370
371 93
			$output = apply_filters( 'gravityview_field_entry_value_pre_link', $output, $context->entry->as_entry(), $field->as_configuration(), $field_compat );
372
373
			/**
374
			 * Link to the single entry by wrapping the output in an anchor tag
375
			 *
376
			 * Fields can override this by modifying the field data variable inside the field. See /templates/fields/post_image.php for an example.
377
			 */
378 93
			if ( ! empty( $field->show_as_link ) && ! \gv_empty( $output, false, false ) ) {
379 4
				$link_atts = empty( $field->new_window ) ? array() : array( 'target' => '_blank' );
380
381 4
				$permalink = $context->entry->get_permalink( $context->view, $context->request );
382 4
				$output = \gravityview_get_link( $permalink, $output, $link_atts );
383
384
				/**
385
				 * @filter `gravityview_field_entry_link` Modify the link HTML
386
				 * @param string $link HTML output of the link
387
				 * @param string $href URL of the link
388
				 * @param array  $entry The GF entry array
389
				 * @param array $field_settings Settings for the particular GV field
390
				 * @deprecated Use `gravityview/template/field/entry_link`
391
				 */
392 4
				$output = apply_filters( 'gravityview_field_entry_link', $output, $permalink, $context->entry->as_entry(), $field->as_configuration() );
393
394
				/**
395
				 * @filter `gravityview/template/field/entry_link` Modify the link HTML
396
				 * @since 2.0
397
				 * @param string $link HTML output of the link
398
				 * @param string $href URL of the link
399
				 * @param \GV\Template_Context $context The context
400
				 */
401 4
				$output = apply_filters( 'gravityview/template/field/entry_link', $output, $permalink, $context );
402
			}
403
404 93
			return $output;
405 93
		};
406
407 93
		$post_link_compat_callback = function( $output, $context ) use ( $field_compat ) {
408 93
			$field = $context->field;
409
410
			/**
411
			 * @filter `gravityview_field_entry_value_{$field_type}` Modify the field value output for a field type. Example: `gravityview_field_entry_value_number`
412
			 * @since 1.6
413
			 * @param string $output HTML value output
414
			 * @param array  $entry The GF entry array
415
			 * @param  array $field_settings Settings for the particular GV field
416
			 * @param array $field Current field being displayed
417
			 *
418
			 * @deprecated Use the `gravityview/field/{$field_type}/output` or `gravityview/field/output` filters instead.
419
			 */
420 93
			$output = apply_filters( "gravityview_field_entry_value_{$field->type}", $output, $context->entry->as_entry(), $field->as_configuration(), $field_compat );
421
422
			/**
423
			 * @filter `gravityview_field_entry_value` Modify the field value output for all field types
424
			 * @param string $output HTML value output
425
			 * @param array  $entry The GF entry array
426
			 * @param  array $field_settings Settings for the particular GV field
427
			 * @param array $field_data  {@since 1.6}
428
			 *
429
			 * @deprecated Use the `gravityview/field/{$field_type}/output` or `gravityview/field/output` filters instead.
430
			 */
431 93
			$output = apply_filters( 'gravityview_field_entry_value', $output, $context->entry->as_entry(), $field->as_configuration(), $field_compat );
432
433
			/**
434
			 * @filter `gravityview/template/field/{$field_type}/output` Modify the field output for a field type.
435
			 *
436
			 * @since 2.0
437
			 *
438
			 * @param string $output The current output.
439
			 * @param \GV\Template_Context The template context this is being called from.
440
			 */
441 93
			return apply_filters( "gravityview/template/field/{$field->type}/output", $output, $context );
442 93
		};
443
444
		/**
445
		 * Okay, what's this whole pre/post_link compat deal, huh?
446
		 *
447
		 * Well, the `gravityview_field_entry_value_{$field_type}_pre_link` filter
448
		 *  is expected to be applied before the value is turned into an entry link.
449
		 *
450
		 * And then `gravityview_field_entry_value_{$field_type}` and `gravityview_field_entry_value`
451
		 *  are called afterwards.
452
		 *
453
		 * So we're going to use filter priorities to make sure this happens inline with
454
		 *  our new filters, in the correct sequence. Pre-link called with priority 5 and
455
		 *  post-link called with priority 9. Then everything else.
456
		 *
457
		 * If a new code wants to alter the value before it is hyperlinked (hyperlinkified?),
458
		 *  it should hook into a priority between -inf. and 8. Afterwards: 10 to +inf.
459
		 */
460
		add_filter( 'gravityview/template/field/output', $pre_link_compat_callback, 5, 2 );
461
		add_filter( 'gravityview/template/field/output', $post_link_compat_callback, 9, 2 );
462
463
		/**
464
		 * @filter `gravityview/template/field/output` Modify the field output for a field.
465
		 *
466
		 * @since 2.0
467
		 *
468
		 * @param string $output The current output.
469
		 * @param \GV\Template_Context The template this is being called from.
470
		 */
471
		echo apply_filters( "gravityview/template/field/output", $output, $context );
472
473
		remove_filter( 'gravityview/template/field/output', $pre_link_compat_callback, 5 );
474
		remove_filter( 'gravityview/template/field/output', $post_link_compat_callback, 9 );
475
	}
476
}
477
478
/** Load implementations. */
479
require gravityview()->plugin->dir( 'future/includes/class-gv-template-field-html.php' );
480
require gravityview()->plugin->dir( 'future/includes/class-gv-template-field-csv.php' );
481