-
Notifications
You must be signed in to change notification settings - Fork 0
/
FieldMetadataBuilderInterface.php
103 lines (90 loc) · 2.29 KB
/
FieldMetadataBuilderInterface.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
<?php
/*
* This file is part of the Klipper package.
*
* (c) François Pluchino <francois.pluchino@klipper.dev>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Klipper\Component\Metadata;
/**
* @author François Pluchino <francois.pluchino@klipper.dev>
*/
interface FieldMetadataBuilderInterface extends ChildMetadataBuilderInterface
{
/**
* Get the field name.
*/
public function getField(): string;
/**
* Set if the field is sortable.
*
* @param bool $sortable Check if the fields is sortable
*
* @return static
*/
public function setSortable(?bool $sortable);
/**
* Check if the field is sortable.
*
* @return bool
*/
public function isSortable(): ?bool;
/**
* Set if the field is filterable.
*
* @param bool $filterable Check if the fields is filterable
*
* @return static
*/
public function setFilterable(?bool $filterable);
/**
* Check if the field is filterable.
*
* @return bool
*/
public function isFilterable(): ?bool;
/**
* Set if the field is searchable.
*
* @param bool $searchable Check if the fields is searchable
*
* @return static
*/
public function setSearchable(?bool $searchable);
/**
* Check if the field is searchable.
*
* @return bool
*/
public function isSearchable(): ?bool;
/**
* Set if the field is translatable.
*
* @param bool $translatable Check if the fields is translatable
*
* @return static
*/
public function setTranslatable(?bool $translatable);
/**
* Check if the field is translatable.
*
* @return bool
*/
public function isTranslatable(): ?bool;
/**
* Merge the field metadata builder.
*
* @param FieldMetadataBuilderInterface $builder The new field metadata builder
*
* @return static
*/
public function merge(FieldMetadataBuilderInterface $builder);
/**
* Build the field metadata.
*
* @param ObjectMetadataInterface $parent The object metadata parent
*/
public function build(ObjectMetadataInterface $parent): FieldMetadataInterface;
}