contenido\classes\UrlBuilder\Contenido_UrlBuilder_CustomPath.class.php

Show: PublicProtectedPrivateinherited
Table of Contents
Project: Contenido Content Management System

Description: Implementation of IContenido_Frontend_Navigation_UrlBuilder to build URL in style index-a-1.html with category path (/category/subcategory/index-a-1.html).

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-19 modified 2008-02-28 Changed to using Config for URL style @todo Somehow get around using prCreateURLNameLocationString() $Id: Contenido_UrlBuilder_CustomPath.class.php 738 2008-08-27 10:21:19Z timo.trautmann $: }}  
Package
Contenido Backend classes  
Version
1.0.0  

\Contenido_UrlBuilder_CustomPath

Package: Default
Parent(s)
\Contenido_UrlBuilder

Properties

>VPropertyprivate$_instance
static
Details
Type
n/a
>VPropertyprivate$aConfig
Details
Type
n/a
>VPropertyprotectedstring $sHttpBasePath
Details
Type
string
Access
protected  
Desc
Holds URL that is used as base for an absolute path, e.g. http://contenido.org/  
Inherited_from
\Contenido_UrlBuilder::$$sHttpBasePath  
>VPropertyprotectedstring $sUrl
inherited
Inherited from: \Contenido_UrlBuilder::$$sUrl
Details
Type
string
Access
protected  
Desc
Holds final value of built URL  
Inherited_from
\Contenido_UrlBuilder::$$sUrl  

Methods

methodprivate__construct() : void

Constructor

Details
Access
private  
Author
Rudi Bieller  
methodpublicbuildUrl(array $aParams, boolean $bUseAbsolutePath = false, array $aConfig = array()) : void

Builds a URL in index-a-1.html style.

Index keys of $aParams will be used as "a", corresponding values as "1" in this sample. For creating the location string $aParams needs to have keys idcat, level, lang and at least one custom key. If level is not set, level 0 will be used as default.

Parameters
NameTypeDescription
$aParamsarray

Required keys are: idcat, level, lang and at least one custom key.

$bUseAbsolutePathboolean
$aConfigarray

If not set, will use UrlBuilderConfig::getConfig()

Throws
ExceptionDescription
\InvalidArgumentException
\Exception
Details
Author
Rudi Bieller  
Todo
Somehow get around using prCreateURLNameLocationString()  
methodpublicgetHttpBasePath() : string
inherited

Return http base path, e.g.

Inherited from: \Contenido_UrlBuilder::getHttpBasePath()

http://contenido.org/

Returns
TypeDescription
string
methodpublicgetInstance() : \obj
static

Get instance of Contenido_UrlBuilder_Frontcontent

Get instance of concrete Contenido_UrlBuilder_XYZ

Returns
TypeDescription
\objContenido_UrlBuilder_Frontcontent
Details
Access
public  
Author
Rudi Bieller  
methodpublicgetUrl() : string
inherited

Return built URL

Inherited from: \Contenido_UrlBuilder::getUrl()
Returns
TypeDescription
string
Details
Access
public  
Author
Rudi Bieller  
methodpublicsetHttpBasePath( $sBasePath) : void
inherited

Set http base path, e.g.

Inherited from: \Contenido_UrlBuilder::setHttpBasePath()

http://contenido.org/

Parameters
NameTypeDescription
$sBasePath
Details
Access
public  
Author
Rudi Bieller  
Documentation was generated by phpDocumentor 2.0.0a12.