IUrl.php
2.89 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
<?php
/**
* LICENSE: Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* PHP version 5
*
* @category Microsoft
* @package WindowsAzure\Common\Internal\Http
* @author Azure PHP SDK <azurephpsdk@microsoft.com>
* @copyright 2012 Microsoft Corporation
* @license http://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0
* @link https://github.com/windowsazure/azure-sdk-for-php
*/
namespace WindowsAzure\Common\Internal\Http;
/**
* Defines what are main url functionalities that should be supported
*
* @category Microsoft
* @package WindowsAzure\Common\Internal\Http
* @author Azure PHP SDK <azurephpsdk@microsoft.com>
* @copyright 2012 Microsoft Corporation
* @license http://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0
* @version Release: 0.4.1_2015-03
* @link https://github.com/windowsazure/azure-sdk-for-php
*/
interface IUrl
{
/**
* Returns the query portion of the url
*
* @return string
*/
public function getQuery();
/**
* Returns the query portion of the url in array form
*
* @return array
*/
public function getQueryVariables();
/**
* Sets a an existing query parameter to value or creates a new one if the $key
* doesn't exist.
*
* @param string $key query parameter name.
* @param string $value query value.
*
* @return none.
*/
public function setQueryVariable($key, $value);
/**
* Gets actual URL string.
*
* @return string.
*/
public function getUrl();
/**
* Sets url path
*
* @param string $urlPath url path to set.
*
* @return none.
*/
public function setUrlPath($urlPath);
/**
* Appends url path
*
* @param string $urlPath url path to append.
*
* @return none.
*/
public function appendUrlPath($urlPath);
/**
* Gets actual URL string.
*
* @return string.
*/
public function __toString();
/**
* Makes deep copy from the current object.
*
* @return WindowsAzure\Common\Internal\Http\Url
*/
public function __clone();
/**
* Sets the query string to the specified variables in $array
*
* @param array $array key/value representation of query variables.
*
* @return none.
*/
public function setQueryVariables($array);
}