GV\Field_Collection

A collection of \GV\Field objects.

Source: future/includes/class-gv-collection-field.php:14

Details

• Kind: class
• Namespace: GV
• Extends: Collection
• Implements: Collection_Position_Aware

Methods

Method	Description
all()	Returns all the objects in this collection as an an array. Here for docBlock purposes only.
add()	Add a \GV\Field to this collection.
get()	Get a \GV\Field from this list by UID.
by_position()	Get a copy of this \GV\Field_Collection filtered by position.
by_visible()	Get a copy of this \GV\Field_Collection filtered by visibility to current user context.
from_configuration()	Parses a configuration array into a Field_Collection.
as_configuration()	Return a configuration array for this field collection.

Method Reference

all()

public function all()

Returns all the objects in this collection as an an array. Here for docBlock purposes only.

Returns

• \GV\Field[]

Since: 2.0.13.1

Source: future/includes/class-gv-collection-field.php:23

add()

public function add( $field )

Add a \GV\Field to this collection.

Parameters

Name	Type	Default	Description
$field	\GV\Field		The field to add to the internal array.

Returns

• void

Since: 2.0

Source: future/includes/class-gv-collection-field.php:36

get()

public function get( $field_uid )

Get a \GV\Field from this list by UID.

Parameters

Name	Type	Default	Description
$field_uid	int		The UID of the field in the field to get.

Returns

• \GV\Field | null — The \GV\Field with the $field_uid as the UID, or null if not found.

Since: 2.0

Source: future/includes/class-gv-collection-field.php:54

by_position()

public function by_position( $position )

Get a copy of this \GV\Field_Collection filtered by position.

Parameters

Name	Type	Default	Description
$position	string		The position to get the fields for. Can be a wildcard *

Returns

• \GV\Field_Collection — A filtered collection of \GV\Fields, filtered by position.

Source: future/includes/class-gv-collection-field.php:74

by_visible()

public function by_visible( $view=null )

Get a copy of this \GV\Field_Collection filtered by visibility to current user context.

Parameters

Name	Type	Default	Description
$view		null	\GV\View The view!

Returns

• \GV\Field_Collection — A filtered collection of \GV\Fields, filtered by visibility.

Source: future/includes/class-gv-collection-field.php:97

from_configuration()

public static function from_configuration( $configuration )

Parses a configuration array into a Field_Collection.

$configuration = [
    'directory_table-columns' => [
        '5372653f25d44' => [
            'id'            => '1',
            'label'         => 'Name',
            'show_label'    => '1',
            'custom_label'  => '',
            'custom_class'  => '',
            'only_loggedin' => '0',
        ],
    ],
    'single_table-columns' => [ ... ],
];
$fields = \GV\Field_Collection::from_configuration( $configuration );

Parameters

Name	Type	Default	Description
$configuration	array		Multidimensional array keyed by zone position (e.g., 'directory_table-columns'), with each zone containing field configurations keyed by unique field UID.

Returns

• \GV\Field_Collection — A collection of fields.

See Also

• \GV\Field::as_configuration() For the complete field configuration structure.

Since: 2.0

Source: future/includes/class-gv-collection-field.php:138

as_configuration()

public function as_configuration()

Return a configuration array for this field collection.

Returns

• array

See Also

• \GV\Field_Collection::from_configuration() for structure.

Source: future/includes/class-gv-collection-field.php:164