-
Notifications
You must be signed in to change notification settings - Fork 11
Expand file tree
/
Copy pathEntityOptionsTrait.php
More file actions
147 lines (139 loc) · 3.69 KB
/
EntityOptionsTrait.php
File metadata and controls
147 lines (139 loc) · 3.69 KB
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
<?php
/**
* Copyright 2018 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
namespace Google\Cloud\Datastore;
/**
* Methods for handling Datastore Entity options boilerplate.
*
* This trait partially implements {@see \Google\Cloud\Datastore\EntityInterface}
* and is useful when your application requires custom entities with non-standard
* objects.
*/
trait EntityOptionsTrait
{
/**
* @var array
*/
private $options;
/**
* Fetch the cursor
*
* This is only set when the entity was obtained from a query result. It
* can be used to manually paginate results.
*
* Example:
* ```
* $cursor = $entity->cursor();
* ```
*
* @see https://cloud.google.com/datastore/docs/reference/rest/v1/EntityResult EntityResult.cursor
*
* @return string|null
*/
public function cursor(): ?string
{
return isset($this->options['cursor'])
? $this->options['cursor']
: null;
}
/**
* Fetch the baseVersion
*
* This is only set when the entity was obtained from a query result. It
* is used for concurrency control internally.
*
* Example:
* ```
* $baseVersion = $entity->baseVersion();
* ```
*
* @see https://cloud.google.com/datastore/docs/reference/rest/v1/EntityResult EntitResult.version
*
* @return string|null
*/
public function baseVersion(): ?string
{
return isset($this->options['baseVersion'])
? $this->options['baseVersion']
: null;
}
/**
* Indicate whether the entity was created as the result of an API call.
*
* Example:
* ```
* $populatedByService = $entity->populatedByService();
* ```
*
* @return bool
*/
public function populatedByService(): bool
{
return isset($this->options['populatedByService'])
? $this->options['populatedByService']
: false;
}
/**
* A list of entity properties to exclude from datastore indexes.
*
* Example:
* ```
* $entity['birthDate'] = new DateTime('December 31, 1969');
* $entity->setExcludeFromIndexes([
* 'birthDate'
* ]);
* ```
*
* @param array $properties A list of properties to exclude from indexes.
* @return void
*/
public function setExcludeFromIndexes(array $properties): void
{
$this->options['excludeFromIndexes'] = $properties;
}
/**
* Return a list of properties excluded from datastore indexes.
*
* Example:
* ```
* $excludedFromIndexes = $entity->excludedProperties();
* ```
*
* @return array
*/
public function excludedProperties(): array
{
return isset($this->options['excludeFromIndexes'])
? $this->options['excludeFromIndexes']
: [];
}
/**
* Return a list of meaning values.
*
* Example:
* ```
* $meanings = $entity->meanings();
* ```
*
* @return array
*/
public function meanings(): array
{
return isset($this->options['meanings'])
? $this->options['meanings']
: [];
}
}