Skip to content

Commit ee61b22

Browse files
author
Bulat Shakirzyanov
committed
fix doc blocks
1 parent 5d9b9b6 commit ee61b22

File tree

9 files changed

+86
-6
lines changed

9 files changed

+86
-6
lines changed

ext/doc/Cassandra/DefaultCluster.php

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,19 @@ final class DefaultCluster implements Cluster
2828
{
2929
/**
3030
* {@inheritDoc}
31+
*
32+
* @param string $keyspace Optional keyspace name
33+
*
34+
* @return Session Session instance
3135
*/
3236
public function connect($keyspace = null) {}
3337

3438
/**
3539
* {@inheritDoc}
40+
*
41+
* @param string $keyspace Optional keyspace name
42+
*
43+
* @return Future A Future Session instance
3644
*/
3745
public function connectAsync($keyspace = null) {}
3846
}

ext/doc/Cassandra/DefaultSession.php

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,31 +27,60 @@ final class DefaultSession implements Session
2727
{
2828
/**
2929
* {@inheritDoc}
30+
*
31+
* @throws Exception
32+
*
33+
* @param Statement $statement statement to be executed
34+
* @param ExecutionOptions $options execution options (optional)
35+
*
36+
* @return Rows execution result
3037
*/
3138
public function execute(Statement $statement, ExecutionOptions $options = null) {}
3239

3340
/**
3441
* {@inheritDoc}
42+
*
43+
* @param Statement $statement statement to be executed
44+
* @param ExecutionOptions|null $options execution options (optional)
45+
*
46+
* @return Future future result
3547
*/
3648
public function executeAsync(Statement $statement, ExecutionOptions $options = null) {}
3749

3850
/**
3951
* {@inheritDoc}
52+
*
53+
* @throws Exception
54+
*
55+
* @param string $cql CQL statement string
56+
* @param ExecutionOptions|null $options execution options (optional)
57+
*
58+
* @return PreparedStatement prepared statement
4059
*/
4160
public function prepare($cql, ExecutionOptions $options = null) {}
4261

4362
/**
4463
* {@inheritDoc}
64+
*
65+
* @param string $cql CQL string to be prepared
66+
* @param ExecutionOptions|null $options preparation options
67+
*
68+
* @return Future statement
4569
*/
4670
public function prepareAsync($cql, ExecutionOptions $options = null) {}
4771

4872
/**
4973
* {@inheritDoc}
74+
*
75+
* @param float|null $timeout Timeout to wait for closure in seconds
76+
* @return void
5077
*/
5178
public function close($timeout = null) {}
5279

5380
/**
5481
* {@inheritDoc}
82+
*
83+
* @return Future future
5584
*/
5685
public function closeAsync() {}
5786
}

ext/doc/Cassandra/FutureClose.php

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,13 @@ final class FutureClose implements Future
2727
{
2828
/**
2929
* {@inheritDoc}
30+
*
31+
* @throws Cassandra\Exception\InvalidArgumentException
32+
* @throws Cassandra\Exception\TimeoutException
33+
*
34+
* @param float|null $timeout
35+
*
36+
* @return mixed a value that the future has been resolved with
3037
*/
3138
public function get($timeout = null) {}
3239
}

ext/doc/Cassandra/FutureException.php

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,13 @@ final class FutureException implements Future
2525
{
2626
/**
2727
* {@inheritDoc}
28+
*
29+
* @throws Cassandra\Exception\InvalidArgumentException
30+
* @throws Cassandra\Exception\TimeoutException
31+
*
32+
* @param float|null $timeout
33+
*
34+
* @return mixed a value that the future has been resolved with
2835
*/
2936
public function get($timeout = null) {}
3037
}

ext/doc/Cassandra/FuturePreparedStatement.php

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,13 @@ final class FuturePreparedStatement implements Future
2828
{
2929
/**
3030
* {@inheritDoc}
31+
*
32+
* @throws Cassandra\Exception\InvalidArgumentException
33+
* @throws Cassandra\Exception\TimeoutException
34+
*
35+
* @param float|null $timeout
36+
*
37+
* @return mixed a value that the future has been resolved with
3138
*/
3239
public function get($timeout = null) {}
3340
}

ext/doc/Cassandra/FutureRows.php

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,13 @@ final class FutureRows implements Future
2727
{
2828
/**
2929
* {@inheritDoc}
30+
*
31+
* @throws Cassandra\Exception\InvalidArgumentException
32+
* @throws Cassandra\Exception\TimeoutException
33+
*
34+
* @param float|null $timeout
35+
*
36+
* @return mixed a value that the future has been resolved with
3037
*/
3138
public function get($timeout = null) {}
3239
}

ext/doc/Cassandra/FutureSession.php

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,13 @@ final class FutureSession implements Future
2727
{
2828
/**
2929
* {@inheritDoc}
30+
*
31+
* @throws Cassandra\Exception\InvalidArgumentException
32+
* @throws Cassandra\Exception\TimeoutException
33+
*
34+
* @param float|null $timeout
35+
*
36+
* @return mixed a value that the future has been resolved with
3037
*/
3138
public function get($timeout = null) {}
3239
}

ext/doc/Cassandra/FutureValue.php

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,13 @@ final class FutureValue implements Future
2525
{
2626
/**
2727
* {@inheritDoc}
28+
*
29+
* @throws Cassandra\Exception\InvalidArgumentException
30+
* @throws Cassandra\Exception\TimeoutException
31+
*
32+
* @param float|null $timeout
33+
*
34+
* @return mixed a value that the future has been resolved with
2835
*/
2936
public function get($timeout = null) {}
3037
}

ext/doc/Cassandra/Session.php

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ interface Session
3535
*
3636
* @return Rows execution result
3737
*/
38-
public function Rows execute(Statement $statement, ExecutionOptions $options = null);
38+
public function execute(Statement $statement, ExecutionOptions $options = null);
3939

4040
/**
4141
* Executes a given statement and returns a future result.
@@ -48,7 +48,7 @@ public function Rows execute(Statement $statement, ExecutionOptions $options = n
4848
*
4949
* @return Future future result
5050
*/
51-
public function Future executeAsync(Statement $statement, ExecutionOptions $options = null);
51+
public function executeAsync(Statement $statement, ExecutionOptions $options = null);
5252

5353
/**
5454
* Creates a prepared statement from a given CQL string.
@@ -63,7 +63,7 @@ public function Future executeAsync(Statement $statement, ExecutionOptions $opti
6363
*
6464
* @return PreparedStatement prepared statement
6565
*/
66-
public function PreparedStatement prepare($cql, ExecutionOptions $options = null);
66+
public function prepare($cql, ExecutionOptions $options = null);
6767

6868
/**
6969
* Asynchronously prepares a statement and returns a future prepared statement.
@@ -75,19 +75,20 @@ public function PreparedStatement prepare($cql, ExecutionOptions $options = null
7575
*
7676
* @return Future statement
7777
*/
78-
public function Future prepareAsync($cql, ExecutionOptions $options = null);
78+
public function prepareAsync($cql, ExecutionOptions $options = null);
7979

8080
/**
8181
* Closes current session and all of its connections.
8282
*
8383
* @param float|null $timeout Timeout to wait for closure in seconds
84+
* @return void
8485
*/
85-
public function void close($timeout = null);
86+
public function close($timeout = null);
8687

8788
/**
8889
* Asynchronously closes current session once all pending requests have finished.
8990
*
9091
* @return Future future
9192
*/
92-
public function Future closeAsync();
93+
public function closeAsync();
9394
}

0 commit comments

Comments
 (0)