Skip to content

Commit 2482a6f

Browse files
mpenickmpenick
committed
Added stubs for new metadata types
1 parent 65d7c45 commit 2482a6f

15 files changed

+819
-4
lines changed

Diff for: ‎ext/doc/Cassandra/Aggregate.php

+79
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
<?php
2+
3+
/**
4+
* Copyright 2015-2016 DataStax, Inc.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
namespace Cassandra;
20+
21+
/**
22+
* A PHP representation of an aggregate
23+
*/
24+
interface Aggregate
25+
{
26+
/**
27+
* Returns the full name of the aggregate
28+
* @return string Full name of the aggregate including name and types
29+
*/
30+
function name();
31+
32+
/**
33+
* Returns the simple name of the aggregate
34+
* @return string Simple name of the aggregate
35+
*/
36+
function simpleName();
37+
38+
/**
39+
* Returns the argument types of the aggregate
40+
* @return array Argument types of the aggregate
41+
*/
42+
function argumentTypes();
43+
44+
/**
45+
* Returns the final function of the aggregate
46+
* @return Cassandra\Function Final function of the aggregate
47+
*/
48+
function finalFunction();
49+
50+
/**
51+
* Returns the state function of the aggregate
52+
* @return Cassandra\Function State function of the aggregate
53+
*/
54+
function stateFunction();
55+
56+
/**
57+
* Returns the initial condition of the aggregate
58+
* @return Cassandra\Value Initial condition of the aggregate
59+
*/
60+
function initialCondition();
61+
62+
/**
63+
* Returns the return type of the aggregate
64+
* @return Cassandra\Type Return type of the aggregate
65+
*/
66+
function returnType();
67+
68+
/**
69+
* Returns the state type of the aggregate
70+
* @return Cassandra\Type State type of the aggregate
71+
*/
72+
function stateType();
73+
74+
/**
75+
* Returns the signature of the aggregate
76+
* @return string Signature of the aggregate (same as name())
77+
*/
78+
function signature();
79+
}

Diff for: ‎ext/doc/Cassandra/DefaultAggregate.php

+88
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
<?php
2+
3+
/**
4+
* Copyright 2015-2016 DataStax, Inc.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
namespace Cassandra;
20+
21+
/**
22+
* A PHP representation of an aggregate
23+
*/
24+
final class DefaultAggregate implements Aggregate
25+
{
26+
/**
27+
* {@inheritDoc}
28+
*
29+
* @return string Full name of the aggregate including name and types
30+
*/
31+
public function name() {}
32+
33+
/**
34+
* {@inheritDoc}
35+
*
36+
* @return string Simple name of the aggregate
37+
*/
38+
public function simpleName() {}
39+
40+
/**
41+
* {@inheritDoc}
42+
*
43+
* @return array Argument types of the aggregate
44+
*/
45+
public function argumentTypes() {}
46+
47+
/**
48+
* {@inheritDoc}
49+
*
50+
* @return Cassandra\Function Final public function of the aggregate
51+
*/
52+
public function finalFunction() {}
53+
54+
/**
55+
* {@inheritDoc}
56+
*
57+
* @return Cassandra\Function State public function of the aggregate
58+
*/
59+
public function stateFunction() {}
60+
61+
/**
62+
* {@inheritDoc}
63+
*
64+
* @return Cassandra\Value Initial condition of the aggregate
65+
*/
66+
public function initialCondition() {}
67+
68+
/**
69+
* {@inheritDoc}
70+
*
71+
* @return Cassandra\Type Return type of the aggregate
72+
*/
73+
public function returnType() {}
74+
75+
/**
76+
* {@inheritDoc}
77+
*
78+
* @return Cassandra\Type State type of the aggregate
79+
*/
80+
public function stateType() {}
81+
82+
/**
83+
* {@inheritDoc}
84+
*
85+
* @return string Signature of the aggregate (same as name())
86+
*/
87+
public function signature() {}
88+
}

Diff for: ‎ext/doc/Cassandra/DefaultFunction.php

+81
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
<?php
2+
3+
/**
4+
* Copyright 2015-2016 DataStax, Inc.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License") {}
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
namespace Cassandra {}
20+
21+
/**
22+
* A PHP representation of a public function
23+
*/
24+
final class DefaultFunction implements Function
25+
{
26+
/**
27+
* {@inheritDoc}
28+
*
29+
* @return string Full name of the function including name and types
30+
*/
31+
public public function name() {}
32+
33+
/**
34+
* {@inheritDoc}
35+
*
36+
* @return string Simple name of the function
37+
*/
38+
public function simpleName() {}
39+
40+
/**
41+
* {@inheritDoc}
42+
*
43+
* @return array Arguments of the function
44+
*/
45+
public function arguments() {}
46+
47+
/**
48+
* {@inheritDoc}
49+
*
50+
* @return Cassandra\Type Return type of the function
51+
*/
52+
public function returnType() {}
53+
54+
/**
55+
* {@inheritDoc}
56+
*
57+
* @return string Signature of the function (same as name())
58+
*/
59+
public function signature() {}
60+
61+
/**
62+
* {@inheritDoc}
63+
*
64+
* @return string Language used by the function
65+
*/
66+
public function language() {}
67+
68+
/**
69+
* {@inheritDoc}
70+
*
71+
* @return string Body of the function
72+
*/
73+
public function body() {}
74+
75+
/**
76+
* {@inheritDoc}
77+
*
78+
* @return boolean
79+
*/
80+
public function isCalledOnNullInput() {}
81+
}

Diff for: ‎ext/doc/Cassandra/DefaultIndex.php

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
<?php
2+
3+
/**
4+
* Copyright 2015-2016 DataStax, Inc.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
namespace Cassandra;
20+
21+
/**
22+
* A PHP representation of an index
23+
*/
24+
final class DefaultIndex implements Index
25+
{
26+
/**
27+
* {@inheritDoc}
28+
*
29+
* @return string Name of the index
30+
*/
31+
public function name() {}
32+
33+
/**
34+
* {@inheritDoc}
35+
*
36+
* @return string Kind of the index
37+
*/
38+
public function kind() {}
39+
40+
/**
41+
* {@inheritDoc}
42+
*
43+
* @return string Target column name of the index
44+
*/
45+
public function target() {}
46+
47+
/**
48+
* {@inheritDoc}
49+
*
50+
* @return Cassandra\Value Value of an option by name
51+
*/
52+
public function option($name) {}
53+
54+
/**
55+
* {@inheritDoc}
56+
*
57+
* @return array A dictionary of `string` and `Cassandra\Value pairs of the
58+
* index's options.
59+
*/
60+
public function options() {}
61+
62+
/**
63+
* {@inheritDoc}
64+
*
65+
* @return string Class name of a custom index
66+
*/
67+
public function className() {}
68+
69+
/**
70+
* {@inheritDoc}
71+
*
72+
* @return boolean
73+
*/
74+
public function isCustom() {}
75+
}

0 commit comments

Comments
 (0)