Repository navigation
Expand file tree
/
Copy pathArrayType.php
More file actions
142 lines (132 loc) · 4.02 KB
/
Copy pathArrayType.php
File metadata and controls
142 lines (132 loc) · 4.02 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
<?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\Spanner;
/**
* Represents a Spanner SQL Query array type declaration.
*
* Array types may usually be inferred. Types are only required if the array
* is nullable, or if it contains structs.
*
* Example:
* ```
* use Google\Cloud\Spanner\ArrayType;
* use Google\Cloud\Spanner\Database;
* use Google\Cloud\Spanner\SpannerClient;
*
* $spanner = new SpannerClient();
* $database = $spanner->connect('my-instance', 'my-database');
*
* $arrayType = new ArrayType(Database::TYPE_STRING);
*
* $res = $database->execute('SELECT @arrayParam as arrayValue', [
* 'parameters' => [
* 'arrayParam' => ['foo', 'bar', null]
* ],
* 'types' => [
* 'arrayParam' => $arrayType
* ]
* ])->rows()->current();
*
* $firstValue = $res['arrayValue'][0]; // `foo`
* ```
*
* ```
* // Arrays may contain structs.
* use Google\Cloud\Spanner\ArrayType;
* use Google\Cloud\Spanner\Database;
* use Google\Cloud\Spanner\StructType;
*
* $arrayType = new ArrayType(
* (new StructType)
* ->add('companyName', Database::TYPE_STRING)
* ->add('companyId', Database::TYPE_INT64)
* );
* ```
*/
class ArrayType
{
/**
* @var int|null
*/
private $type;
/**
* @var StructType|null
*/
private $structType;
/**
* @param int|null|StructType $type A value type code or nested struct
* definition. Accepted integer values are defined as constants on
* {@see Google\Cloud\Spanner\Database}, and are as follows:
* `Database::TYPE_BOOL`, `Database::TYPE_INT64`,
* `Database::TYPE_FLOAT64`, `Database::TYPE_TIMESTAMP`,
* `Database::TYPE_DATE`, `Database::TYPE_STRING` and
* `Database::TYPE_BYTES`. Nested arrays are not supported in Cloud
* Spanner, and attempts to use `Database::TYPE_ARRAY` will result in
* an exception. If null is given, Google Cloud PHP will attempt to
* infer the array type.
* @throws \InvalidArgumentException If an invalid type is provided, or if
* a struct is defined but the given type is not
* `Database::TYPE_STRUCT`.
*/
public function __construct($type)
{
if ($type === Database::TYPE_STRUCT) {
throw new \InvalidArgumentException(
'`Database::TYPE_STRUCT` is not a valid array type. ' .
'Please use `Google\Cloud\Spanner\StructType` instead.'
);
}
$structType = null;
if ($type instanceof StructType) {
$structType = $type;
$type = Database::TYPE_STRUCT;
}
if ($type && !in_array($type, ValueMapper::$allowedTypes)) {
throw new \InvalidArgumentException(sprintf(
'Type %s is not an allowed type.',
$type
));
}
if ($type === Database::TYPE_ARRAY) {
throw new \InvalidArgumentException(
'Arrays may not contain arrays.'
);
}
$this->type = $type;
$this->structType = $structType;
}
/**
* Get the array value type.
*
* @access private
* @return int|null
*/
public function type()
{
return $this->type;
}
/**
* Get the nested struct parameter type.
*
* @access private
* @return StructType|null
*/
public function structType()
{
return $this->structType;
}
}