← Back to branch summary

~ballot/wordpress/openstack-objectstorage-breaking-insight

« back to all changes in this revision

Viewing changes to vendor/guzzlehttp/streams/src/MetadataStreamInterface.php

  • Committer: Jacek Nykis
  • Date: 2015-02-11 15:35:31 UTC
  • Revision ID: jacek.nykis@canonical.com-20150211153531-hmy6zi0ov2qfkl0b
Initial commit

Show diffs side-by-side

added added

removed removed

Lines of Context:
vendor/guzzlehttp/streams/src/MetadataStreamInterface.php
 
1
<?php
 
2
namespace GuzzleHttp\Stream;
 
3
 
 
4
/**
 
5
 * Represents a stream that contains metadata
 
6
 */
 
7
interface MetadataStreamInterface extends StreamInterface
 
8
{
 
9
    /**
 
10
     * Get stream metadata as an associative array or retrieve a specific key.
 
11
     *
 
12
     * The keys returned are identical to the keys returned from PHP's
 
13
     * stream_get_meta_data() function.
 
14
     *
 
15
     * @param string $key Specific metadata to retrieve.
 
16
     *
 
17
     * @return array|mixed|null Returns an associative array if no key is
 
18
     *                          no key is provided. Returns a specific key
 
19
     *                          value if a key is provided and the value is
 
20
     *                          found, or null if the key is not found.
 
21
     * @see http://php.net/manual/en/function.stream-get-meta-data.php
 
22
     */
 
23
    public function getMetadata($key = null);
 
24
}