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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
|
<?php
/**
* File containing the ezcUrlConfiguration class.
*
* @copyright Copyright (C) 2005-2007 eZ systems as. All rights reserved.
* @license http://ez.no/licenses/new_bsd New BSD License
* @version 1.1
* @filesource
* @package Url
*/
/**
* ezcUrlConfiguration makes it possible to use a custom URL form in your application.
*
* Example of use:
* <code>
* // create an ezcUrlConfiguration object
* $urlCfg = new ezcUrlConfiguration();
* // set the basedir and script values
* $urlCfg->basedir = 'mydir';
* $urlCfg->script = 'index.php';
*
* // define delimiters for unordered parameter names
* $urlCfg->unorderedDelimiters = array( '(', ')' );
*
* // define ordered parameters
* $urlCfg->addOrderedParameter( 'section' );
* $urlCfg->addOrderedParameter( 'group' );
* $urlCfg->addOrderedParameter( 'category' );
* $urlCfg->addOrderedParameter( 'subcategory' );
*
* // define unordered parameters
* $urlCfg->addUnorderedParameter( 'game', ezcUrlConfiguration::MULTIPLE_ARGUMENTS );
*
* // create a new ezcUrl object from a string URL and use the above $urlCfg
* $url = new ezcUrl( 'http://www.example.com/mydir/index.php/groups/Games/Adventure/Adult/(game)/Larry/7', $urlCfg );
*
* // to get the parameter values from the URL use $url->getParam():
* $section = $url->getParam( 'section' ); // will be "groups"
* $group = $url->getParam( 'group' ); // will be "Games"
* $category = $url->getParam( 'category' ); // will be "Adventure"
* $subcategory = $url->getParam( 'subcategory' ); // will be "Adult"
* $game = $url->getParam( 'game' ); // will be array( "Larry", "7" )
*
* // to remove parameters from the URL configuration $urlCfg
* $urlCfg->removeOrderedParameter( 'subcategory' );
* $urlCfg->removeUnorderedParameter( 'game' );
*
* // to remove parameters from the URL configuration stored in the URL
* $url->configuration->removeOrderedParameter( 'subcategory' );
* $url->configuration->removeUnorderedParameter( 'game' );
* </code>
*
* @property string $basedir
* The part of the URL after the first slash. It can be null.
* Example: $basedir = shop in http://www.example.com/shop
* @property string $script
* The default php script, which comes after the basedir. Can be null
* if the web server configuration is set to hide it.
* Example: $script = index.php in http://www.example.com/shop/index.php
* @property array $unorderedDelimiters
* The delimiters for the unordered parameters names.
* Example: $unorderedDelimiters = array( '(', ')' ) for
* url = http://www.example.com/doc/(file)/classtrees_Base.html
* @property string $orderedParameters
* The ordered parameters of the URL.
* Example: $orderedParameters = array( 'section' => 0, 'module' => 1, 'view' => 2, 'content' => 3 );
* url = http://www.example.com/doc/components/view/trunk
* The numbers in the array represent the indices for each parameter.
* @property string $unorderedParameters
* The unordered parameters of the URL.
* Example: $unorderedParameters = array( 'file' => SINGLE_ARGUMENT );
* url = http://www.example.com/doc/(file)/classtrees_Base.html
* The keys of the array represent the parameter names, and the values
* in the array represent the types of the parameters.
*
* @package Url
* @version 1.1
*/
class ezcUrlConfiguration
{
/**
* Flag for specifying single arguments for unordered parameters.
*/
const SINGLE_ARGUMENT = 1;
/**
* Flag for specifying multiple arguments for unordered parameters.
*/
const MULTIPLE_ARGUMENTS = 2;
/**
* Holds the properties of this class.
*
* @var array(string=>mixed)
*/
private $properties = array();
/**
* Stores the instance of this class.
*
* @var ezcUrlConfiguration
*/
private static $instance = null;
/**
* Constructs a new ezcUrlConfiguration object.
*
* The properties of the object get default values, which can be changed by
* setting the properties directly, like:
* <code>
* $urlCfg = new ezcUrlConfiguration();
* $urlCfg->basedir = 'mydir';
* $urlCfg->script = 'index.php';
* </code>
*/
public function __construct()
{
$this->basedir = null;
$this->script = null;
$this->unorderedDelimiters = array( '(', ')' );
$this->orderedParameters = array();
$this->unorderedParameters = array();
}
/**
* Returns the instance of the class.
*
* @return ezcUrlConfiguration
*/
public static function getInstance()
{
if ( is_null( self::$instance ) )
{
self::$instance = new ezcUrlConfiguration();
ezcBaseInit::fetchConfig( 'ezcUrlConfiguration', self::$instance );
}
return self::$instance;
}
/**
* Sets the property $name to $value.
*
* @throws ezcBasePropertyNotFoundException
* if the property does not exist.
* @param string $name The name of the property to set
* @param mixed $value The new value of the property
* @ignore
*/
public function __set( $name, $value )
{
switch ( $name )
{
case 'basedir':
case 'script':
case 'unorderedDelimiters':
case 'orderedParameters':
case 'unorderedParameters':
$this->properties[$name] = $value;
break;
default:
throw new ezcBasePropertyNotFoundException( $name );
}
}
/**
* Returns the property $name.
*
* @throws ezcBasePropertyNotFoundException
* if the property does not exist.
* @param string $name The name of the property for which to return the value
* @return mixed
* @ignore
*/
public function __get( $name )
{
switch ( $name )
{
case 'basedir':
case 'script':
case 'unorderedDelimiters':
case 'orderedParameters':
case 'unorderedParameters':
return $this->properties[$name];
default:
throw new ezcBasePropertyNotFoundException( $name );
}
}
/**
* Returns true if the property $name is set, otherwise false.
*
* @param string $name The name of the property to test if it is set
* @return bool
* @ignore
*/
public function __isset( $name )
{
switch ( $name )
{
case 'basedir':
case 'script':
case 'unorderedDelimiters':
case 'orderedParameters':
case 'unorderedParameters':
return isset( $this->properties[$name] );
default:
return false;
}
}
/**
* Adds an ordered parameter to the URL configuration.
*
* @param string $name The name of the ordered parameter to add to the configuration
*/
public function addOrderedParameter( $name )
{
$this->properties['orderedParameters'][$name] = count( $this->properties['orderedParameters'] );
}
/**
* Removes an ordered parameter from the URL configuration.
*
* @param string $name The name of the ordered parameter to remove from the configuration
*/
public function removeOrderedParameter( $name )
{
if ( isset( $this->properties['orderedParameters'][$name] ) )
{
unset( $this->properties['orderedParameters'][$name] );
}
}
/**
* Adds an unordered parameter to the URL configuration.
*
* The default type of the parameter is {@link SINGLE_ARGUMENT}.
*
* Other valid types are {@link MULTIPLE_ARGUMENTS}.
*
* @param string $name The name of the unordered parameter to add to the configuration
* @param int $type The type of the unordered parameter
*/
public function addUnorderedParameter( $name, $type = null )
{
if ( $type == null )
{
$type = self::SINGLE_ARGUMENT;
}
$this->properties['unorderedParameters'][$name] = $type;
}
/**
* Removes an unordered parameter from the URL configuration.
*
* @param string $name The name of the unordered parameter to remove from the configuration
*/
public function removeUnorderedParameter( $name )
{
if ( isset( $this->properties['unorderedParameters'][$name] ) )
{
unset( $this->properties['unorderedParameters'][$name] );
}
}
}
?>
|
