contenido\classes\UrlBuilder\Contenido_UrlBuilderConfig.class.php
Show:
inherited
inherited
Classes
Project:
Contenido Content Management System
Description: Configure UrlBuilder URL style. Per default, configures for style index-a-1.html. If you need another style, extend this class to your needs and pass it to desired UrlBuilder.
Requirements:
- Author
- Rudi Bieller
- Con_php_req
- 5.0
- Copyright
- four for business AG
- License
- http://www.contenido.org/license/LIZENZ.txt
- Link
- http://www.4fb.de
- Link
- {@internal created 2008-02-28 modified 2008-09-29, Murat Purc, added features to set and get configuration $Id: Contenido_UrlBuilderConfig.class.php 885 2008-11-19 23:25:36Z xmurrix $: }}
- Package
- Contenido Backend classes
- Version
- 1.1.0
\Contenido_UrlBuilderConfig
Package: Default
Class to manage UrlBuilder configuration.
The Contenido_UrlBuilderConfig::setConfig() must be called at least once to initialize the desired UrlBuilder.
Usage:
// Example for default front_content UrlBuilder
$myCfg['name'] = 'front_content';
$myCfg['config'] = array();
Contenido_UrlBuilderConfig::setConfig($myCfg);
// Example for CustomPath UrlBuilder
$myCfg['name'] = 'custom_path';
$myCfg['config'] = array('prefix' => 'rocknroll', 'suffix' => '.4fb', 'separator' => ',');
Contenido_UrlBuilderConfig::setConfig($myCfg);
Properties
array $_aUrlBuilderCfg = array('config' => array('prefix' => 'index', 'suffix' => '.html', 'separator' => '-'))static
UrlBuilder configuration array
Default value
array('config' => array('prefix' => 'index', 'suffix' => '.html', 'separator' => '-'))Details- Type
- array
Methods
getConfig() : arraystatic
Returns UrlBuilder configuration
Returns
Throws
| Type | Description |
|---|---|
| array | UrlBuilder configuration |
| Exception | Description |
|---|---|
| \NotInitializedException | If UrlBuilder configuration wasn't initialized before |
getUrlBuilderName() : stringstatic
Returns UrlBuilder name
Returns
Throws
| Type | Description |
|---|---|
| string | UrlBuilder name |
| Exception | Description |
|---|---|
| \NotInitializedException | If UrlBuilder configuration wasn't initialized before |
setConfig(array $cfg) : voidstatic
Set UlrBuilder configuration
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $cfg | array | Assoziative configuration array as follows: - $cfg['name'] = Name of UrlBuilder class to use - $cfg['config'] = UrlBuilder configuration |
| Exception | Description |
|---|---|
| \InvalidArgumentException | If $cfg ist empty, $cfg['name'] is missing or $cfg['config'] exists but is not a array |
\NotInitializedException
Package: Default
- Parent(s)
- \Exception