| 1 |
<?php |
| 2 |
|
| 3 |
namespace Dudlewebs\WPMCS\s3\Aws; |
| 4 |
|
| 5 |
/** |
| 6 |
* Represents an AWS result object that is returned from executing an operation. |
| 7 |
*/ |
| 8 |
interface ResultInterface extends \ArrayAccess, \IteratorAggregate, \Countable |
| 9 |
{ |
| 10 |
/** |
| 11 |
* Provides debug information about the result object |
| 12 |
* |
| 13 |
* @return string |
| 14 |
*/ |
| 15 |
public function __toString(); |
| 16 |
/** |
| 17 |
* Convert the result to an array. |
| 18 |
* |
| 19 |
* @return array |
| 20 |
*/ |
| 21 |
public function toArray(); |
| 22 |
/** |
| 23 |
* Check if the model contains a key by name |
| 24 |
* |
| 25 |
* @param string $name Name of the key to retrieve |
| 26 |
* |
| 27 |
* @return bool |
| 28 |
*/ |
| 29 |
public function hasKey($name); |
| 30 |
/** |
| 31 |
* Get a specific key value from the result model. |
| 32 |
* |
| 33 |
* @param string $key Key to retrieve. |
| 34 |
* |
| 35 |
* @return mixed|null Value of the key or NULL if not found. |
| 36 |
*/ |
| 37 |
public function get($key); |
| 38 |
/** |
| 39 |
* Returns the result of executing a JMESPath expression on the contents |
| 40 |
* of the Result model. |
| 41 |
* |
| 42 |
* $result = $client->execute($command); |
| 43 |
* $jpResult = $result->search('foo.*.bar[?baz > `10`]'); |
| 44 |
* |
| 45 |
* @param string $expression JMESPath expression to execute |
| 46 |
* |
| 47 |
* @return mixed Returns the result of the JMESPath expression. |
| 48 |
* @link http://jmespath.readthedocs.org/en/latest/ JMESPath documentation |
| 49 |
*/ |
| 50 |
public function search($expression); |
| 51 |
} |
| 52 |
|
