ExpressionEngine Docs

# URI Class

class `URI`

The URI Class provides methods that help you retrieve information from your URI strings. This class is initialized automatically.

- `segment($n[, $no_result = FALSE])`
- `slash_segment($n[, $where = 'trailing'])`
- `uri_to_assoc([$n = 3[, $default = array()]])`
- `associ_to_uri($array)`
- `uri_string()`
- `total_segments()`
- `segment_array()`

### `segment($n[, $no_result = FALSE])`

Parameter | Type | Description
--- | --- | ---
$n | `Integer` | The segment number you want to retrieve
$no_result | `Mixed` | Default to use if the segment does not exist
Returns | `String` | The segment

Permits you to retrieve a specific segment, where `$n` is the segment number you wish to retrieve. Segments are numbered from left to right. For example, if your full URL is this:

    https://example.com/news/local/metro/crime_is_up

The segment numbers would be this:

1. `news`
2. `local`
3. `metro`
4. `crime_is_up`

By default the method returns `FALSE` (boolean) if the segment does not exist. There is an optional second parameter that permits you to set your own default value if the segment is missing. For example, this would tell the method to return the number zero in the event of failure:

    $product_id = ee()->uri->segment(3, 0);

It helps avoid having to write code like this:

    if (ee()->uri->segment(3) === FALSE)
    {
        $product_id = 0;
    }
    else
    {
        $product_id = ee()->uri->segment(3);
    }

### `slash_segment($n[, $where = 'trailing'])`

Parameter | Type | Description
--- | --- | ---
$n | `Integer` | The segment number you want to retrieve
$where | `String` | `'trailing'` if you want the slash at the end, `'leading'` if you want it at the beginning, `'both'` if you want both
Returns | `String` | Segment with a slash

This method is almost identical to `URI::segment` except it adds a trailing and/or leading slash based on the second parameter. If the parameter is not used, a trailing slash added. Examples:

    ee()->uri->slash_segment(3); // returns segment/
    ee()->uri->slash_segment(3, 'leading'); // returns /segment
    ee()->uri->slash_segment(3, 'both'); // returns /segment/

### `uri_to_assoc([$n = 3[, $default = array()]])`

Parameter | Type | Description
--- | --- | ---
$n | `Integer` | Starting segment number
$default | `Array` | Array of default values
Returns | `Array` | Key value pair of the URI

This method lets you turn URI segments into an associative array of key/value pairs. Consider this URI:

    index.php/user/search/name/joe/location/UK/gender/male

Using this method you can turn the URI into an associative array with this prototype:

    [array]
    (
        'name' => 'joe'
        'location'  => 'UK'
        'gender'  => 'male'
    )

The first parameter of the method lets you set an offset. By default it is set to 3 since your URI will normally contain a controller/function in the first and second segments. Example:

    $array = ee()->uri->uri_to_assoc(3);
    echo $array['name'];

The second parameter lets you set default key names, so that the array returned by the method will always contain expected indexes, even if missing from the URI. Example:

    $default = array('name', 'gender', 'location', 'type', 'sort');
    $array = ee()->uri->uri_to_assoc(3, $default);

If the URI does not contain a value in your default, an array index will be set to that name with a value of `FALSE`.

Lastly, if a corresponding value is not found for a given key (if there is an odd number of URI segments) the value will be set to `FALSE` (boolean).

### `associ_to_uri($array)`

Parameter | Type | Description
--- | --- | ---
$array | `Array` | Associative array containing key and value pairs
Returns | `Array` | Joined array

Takes an associative array and generates a URI string from it. The array keys will be included in the string. Example:

    // Produces:  product/shoes/size/large/color/red

    $array = array('product' => 'shoes', 'size' => 'large', 'color' => 'red');
    $str = ee()->uri->assoc_to_uri($array);

### `uri_string()`

Parameter | Type | Description
--- | --- | ---
Returns | `String` | URI String

Returns a string with the complete current URI. For example, if this is your current URL:

    https://example.com/news/local/345

The method would return this:

    /news/local/345

### `total_segments()`

Parameter | Type | Description
--- | --- | ---
Returns | `Integer` | Total number of segments in current URI

Returns the total number of segments in the current URI.

### `segment_array()`

Parameter | Type | Description
--- | --- | ---
Returns | `Array` | Array of current segments

Returns an array containing the URI segments. For example:

    $segs = ee()->uri->segment_array();

    foreach ($segs as $segment)
    {
        echo $segment;
        echo '<br />';
    }