Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/StreamWrapper/StreamWrapperInterface.php

	Code Coverage
	Classes and Traits		Functions and Methods				Lines
Total	100.00% covered (success)	0 / 0	100.00% covered (success)	100.00%	0 / 0	CRAP	100.00% covered (success)	100.00%	0 / 0

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Core\StreamWrapper\StreamWrapperInterface.
6	*
7	* Provides a Drupal interface and classes to implement PHP stream wrappers for
8	* public, private, and temporary files.
9	*
10	* A stream wrapper is an abstraction of a file system that allows Drupal to
11	* use the same set of methods to access both local files and remote resources.
12	*
13	* Note that PHP 5.2 fopen() only supports URIs of the form "scheme://target"
14	* despite the fact that according to RFC 3986 a URI's scheme component
15	* delimiter is in general just ":", not "://". Because of this PHP limitation
16	* and for consistency Drupal will only accept URIs of form "scheme://target".
17	*
18	* @see http://www.faqs.org/rfcs/rfc3986.html
19	* @see http://bugs.php.net/bug.php?id=47070
20	*/
21
22	namespace Drupal\Core\StreamWrapper;
23
24	/**
25	* Defines a Drupal stream wrapper extension.
26	*
27	* Extends the StreamWrapperInterface with methods expected by Drupal stream
28	* wrapper classes.
29	*/
30	interface StreamWrapperInterface extends PhpStreamWrapperInterface {
31
32	/**
33	* Stream wrapper bit flags that are the basis for composite types.
34	*
35	* Note that 0x0002 is skipped, because it was the value of a constant that
36	* has since been removed.
37	*/
38
39	/**
40	* A filter that matches all wrappers.
41	*/
42	const ALL = 0x0000;
43
44	/**
45	* Refers to a local file system location.
46	*/
47	const LOCAL = 0x0001;
48
49	/**
50	* Wrapper is readable (almost always true).
51	*/
52	const READ = 0x0004;
53
54	/**
55	* Wrapper is writeable.
56	*/
57	const WRITE = 0x0008;
58
59	/**
60	* Exposed in the UI and potentially web accessible.
61	*/
62	const VISIBLE = 0x0010;
63
64	/**
65	* Composite stream wrapper bit flags that are usually used as the types.
66	*/
67
68	/**
69	* Defines the stream wrapper bit flag for a hidden file.
70	*
71	* This is not visible in the UI or accessible via web, but readable and
72	* writable; for instance, the temporary directory for file uploads.
73	*/
74	const HIDDEN = 0x000C;
75
76	/**
77	* Hidden, readable and writeable using local files.
78	*/
79	const LOCAL_HIDDEN = 0x000D;
80
81	/**
82	* Visible, readable and writeable.
83	*/
84	const WRITE_VISIBLE = 0x001C;
85
86	/**
87	* Visible and read-only.
88	*/
89	const READ_VISIBLE = 0x0014;
90
91	/**
92	* This is the default 'type' falg. This does not include
93	* StreamWrapperInterface::LOCAL, because PHP grants a greater trust level to
94	* local files (for example, they can be used in an "include" statement,
95	* regardless of the "allow_url_include" setting), so stream wrappers need to
96	* explicitly opt-in to this.
97	*/
98	const NORMAL = 0x001C;
99
100	/**
101	* Visible, readable and writeable using local files.
102	*/
103	const LOCAL_NORMAL = 0x001D;
104
105	/**
106	* Returns the type of stream wrapper.
107	*
108	* @return int
109	*/
110	public static function getType();
111
112	/**
113	* Returns the name of the stream wrapper for use in the UI.
114	*
115	* @return string
116	* The stream wrapper name.
117	*/
118	public function getName();
119
120	/**
121	* Returns the description of the stream wrapper for use in the UI.
122	*
123	* @return string
124	* The stream wrapper description.
125	*/
126	public function getDescription();
127
128	/**
129	* Sets the absolute stream resource URI.
130	*
131	* This allows you to set the URI. Generally is only called by the factory
132	* method.
133	*
134	* @param string $uri
135	* A string containing the URI that should be used for this instance.
136	*/
137	public function setUri($uri);
138
139	/**
140	* Returns the stream resource URI.
141	*
142	* @return string
143	* Returns the current URI of the instance.
144	*/
145	public function getUri();
146
147	/**
148	* Returns a web accessible URL for the resource.
149	*
150	* This function should return a URL that can be embedded in a web page
151	* and accessed from a browser. For example, the external URL of
152	* "youtube://xIpLd0WQKCY" might be
153	* "http://www.youtube.com/watch?v=xIpLd0WQKCY".
154	*
155	* @return string
156	* Returns a string containing a web accessible URL for the resource.
157	*/
158	public function getExternalUrl();
159
160	/**
161	* Returns canonical, absolute path of the resource.
162	*
163	* Implementation placeholder. PHP's realpath() does not support stream
164	* wrappers. We provide this as a default so that individual wrappers may
165	* implement their own solutions.
166	*
167	* @return string
168	* Returns a string with absolute pathname on success (implemented
169	* by core wrappers), or FALSE on failure or if the registered
170	* wrapper does not provide an implementation.
171	*/
172	public function realpath();
173
174	/**
175	* Gets the name of the directory from a given path.
176	*
177	* This method is usually accessed through drupal_dirname(), which wraps
178	* around the normal PHP dirname() function, which does not support stream
179	* wrappers.
180	*
181	* @param string $uri
182	* An optional URI.
183	*
184	* @return string
185	* A string containing the directory name, or FALSE if not applicable.
186	*
187	* @see drupal_dirname()
188	*/
189	public function dirname($uri = NULL);
190
191	}