Group extends Entity implements IMappableEntity, JsonSerializable Uses Entity_ID, Entity_Assignable

Represents a group of filters.

Tags
author

Barn2 Plugins support@barn2.com

license

GPL-3.0

copyright

Barn2 Media Ltd

Interfaces, Classes and Traits

IMappableEntity
JsonSerializable

Table of Contents

add_filter()  : self
Add a filter to the group.
assign()  : self
Assign mass data to entity.
create()  : self
Create a new group.
delete()  : void
Delete the group and its filters.
delete_filter()  : self
Remove a filter from the group.
get_filters()  : array<string|int, Filter>
Get the filters in this group.
get_filters_ids()  : array<string|int, mixed>
Get the IDs of the filters in this group.
get_id()  : int
Retrieve ID of the Entity Alias of id()
get_name()  : string
Get name of the group.
id()  : int
Retrieve ID of the Entity
jsonSerialize()  : mixed
mapEntity()  : mixed
priority()  : int
Get the priority order number of the group.
replicate()  : self
Replicate the group.
set_id()  : void
Set ID of the Entity
set_name()  : self
Set name of the group.
set_priority()  : self
Set the group priority order number.
update()  : self
Update the group.

Methods

add_filter()

Add a filter to the group.

public add_filter(Filter $filter) : self
Parameters
$filter : Filter
Return values
self —

assign()

Assign mass data to entity.

public assign(array<string|int, mixed> $data) : self
Parameters
$data : array<string|int, mixed>
Return values
self —

create()

Create a new group.

public static create(array<string|int, mixed> $data) : self
Parameters
$data : array<string|int, mixed>

The data to create the group.

Return values
self —

delete()

Delete the group and its filters.

public delete() : void
Return values
void —

delete_filter()

Remove a filter from the group.

public delete_filter(Filter $filter) : self
Parameters
$filter : Filter
Return values
self —

get_filters()

Get the filters in this group.

public get_filters([bool $exclude_atts = false ][, bool $exclude_atts_parent = false ]) : array<string|int, Filter>
Parameters
$exclude_atts : bool = false

Whether to exclude attribute filters.

$exclude_atts_parent : bool = false

Whether to exclude parent attribute filters.

Tags
todo

Implement the exclude_atts_parent parameter.

Return values
array<string|int, Filter> —

get_filters_ids()

Get the IDs of the filters in this group.

public get_filters_ids() : array<string|int, mixed>
Return values
array<string|int, mixed> —

get_id()

Retrieve ID of the Entity Alias of id()

public get_id() : int
Return values
int —

get_name()

Get name of the group.

public get_name() : string
Return values
string —

id()

Retrieve ID of the Entity

public id() : int
Return values
int —

jsonSerialize()

public jsonSerialize() : mixed
Tags
inheritdoc
Return values
mixed —

mapEntity()

public static mapEntity(IEntityMapper $mapper) : mixed
Parameters
$mapper : IEntityMapper
Tags
inheritdoc
Return values
mixed —

priority()

Get the priority order number of the group.

public priority() : int
Return values
int —

replicate()

Replicate the group.

public replicate() : self
Tags
todo

Move the whole logic for filters replication in this method.

Return values
self —

set_id()

Set ID of the Entity

public set_id(int|string|null $id) : void
Parameters
$id : int|string|null

ID of the Entity

Return values
void —

set_name()

Set name of the group.

public set_name(string $name) : self
Parameters
$name : string
Return values
self —

set_priority()

Set the group priority order number.

public set_priority(int $priority) : self
Parameters
$priority : int
Return values
self —

update()

Update the group.

public update(array<string|int, mixed> $data) : self
Parameters
$data : array<string|int, mixed>

The data to update.

Return values
self —

Search results