FilesExpand file tree

master

/

IItem.php

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

183 lines (165 loc) · 5.88 KB

master

/

IItem.php

Copy path

Top

File metadata and controls

• Code
• Blame

183 lines (165 loc) · 5.88 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

<?php

/**

* This file is part of MetaModels/core.

*

* (c) 2012-2024 The MetaModels team.

*

* For the full copyright and license information, please view the LICENSE

* file that was distributed with this source code.

*

* This project is provided in good faith and hope to be usable by anyone.

*

* @package MetaModels/core

* @author Christian Schiffler <c.schiffler@cyberspectrum.de>

* @author Stefan Heimes <stefan_heimes@hotmail.com>

* @author Richard Henkenjohann <richardhenkenjohann@googlemail.com>

* @author Sven Baumann <baumann.sv@gmail.com>

* @author Ingolf Steinhardt <info@e-spin.de>

* @copyright 2012-2024 The MetaModels team.

* @license https://github.com/MetaModels/core/blob/master/LICENSE LGPL-3.0-or-later

* @filesource

*/

namespace MetaModels;

use MetaModels\Render\Setting\ICollection;

/**

* Interface for a MetaModel item.

*/

interface IItem

{

/**

* Return the native value of an attribute.

*

* @param string $strAttributeName The name of the attribute.

*

* @return mixed

*/

public function get($strAttributeName);

/**

* Set the native value of an attribute.

*

* @param string $strAttributeName The name of the attribute.

* @param mixed $varValue The value of the attribute.

*

* @return \MetaModels\IItem

*/

public function set($strAttributeName, $varValue);

/**

* Fetch the MetaModel that represents this item.

*

* @return \MetaModels\IMetaModel The instance.

*/

public function getMetaModel();

/**

* Fetch the MetaModel attribute instance with the given name.

*

* @param string $strAttributeName The name of the attribute.

*

* @return \MetaModels\Attribute\IAttribute|null the instance or null if not found.

*/

public function getAttribute($strAttributeName);

/**

* Check if the given attribute is set. This mean if in the data array

* is the filed set or not. If the attribute is not loaded the function

* will return false.

*

* @param string $strAttributeName The desired attribute.

*

* @return bool True means the data is set, on load of the item or at any time.

* False means the attribute is not set.

*/

public function isAttributeSet($strAttributeName);

/**

* Return a list of the col names from the attributes which are set.

* Including all meta fields as well.

*

* @return array

*/

public function getSetAttributes();

/**

* Determines if this item is a variant of another item.

*

* @return bool True if it is a variant, false otherwise

*/

public function isVariant();

/**

* Determines if this item is variant base of other items.

*

* Note: this does not mean that there actually exist variants of

* this item. It merely simply states, that this item is able

* to function as variant base for other items.

*

* @return bool true if it is a variant base, false otherwise.

*/

public function isVariantBase();

/**

* Fetch the MetaModel variants for this item.

*

* @param \MetaModels\Filter\IFilter $objFilter The filter settings to be applied.

*

* @return \MetaModels\IItems|null A list of all variants for this item or null if the item cannot handle variants.

*/

public function getVariants($objFilter);

/**

* Fetch the MetaModel variant base for this item.

*

* Note: For a non-variant item the variant base is the item itself.

*

* @return IItem The variant base.

*/

public function getVariantBase();

/**

* Save the current data for every attribute to the data sink.

*

* @param int|null $timestamp Optional parameter for use own timestamp.

* This is useful if save a collection of models and all shall have

* the same timestamp.

*

* @return void

*/

public function save($timestamp = null);

/**

* Renders the item in the given output format.

*

* For further information {@see IMetaModelAttribute::parseValue()}.

*

* @param string $strOutputFormat Optional, the desired output format (default: text).

* @param ICollection $objSettings The render settings to use optional (default: null).

*

* @return array attribute name => format => value

*

* The "text" and "$strOutputFormat" entries behave like read-only arrays but may be lazy

* value objects instead of plain arrays - see \MetaModels\Item::parseValue().

*/

public function parseValue($strOutputFormat = 'text', $objSettings = null);

/**

* Renders a single attribute in the given output format.

*

* For further information {@see IMetaModelAttribute::parseValue()}.

*

* @param string $strAttributeName The desired attribute.

* @param string $strOutputFormat Optional, the desired output format (default: text).

* @param ICollection $objSettings The render settings to use optional (default: null).

*

* @return array format=>value

*/

public function parseAttribute($strAttributeName, $strOutputFormat = 'text', $objSettings = null);

/**

* Returns a new item containing the same values as this item but no id.

*

* This is useful when creating new items that shall be based upon another item

*

* @return \MetaModels\IItem the new copy.

*/

public function copy();

/**

* Returns a new item containing the same values as this item but no id.

*

* Additionally, the item will be a variant child of this item.

*

* NOTE: if this item is not a variant base itself, this item will return a item

* that is a child of these items variant base. i.e. exact clone.

*

* @return \MetaModels\IItem the new copy.

*/

public function varCopy();

}