PHP Class CampURITemplatePath

Inheritance: extends CampURI
Mostrar archivo Open project: sourcefabric/newscoop

Public Methods

Method Description
__construct ( string $p_uri = null ) Class constructor
getFormParameters ( ) : array
getQueryArray ( array $p_keepParameters = [], array $p_removeParameters = [] ) fn __construct
isRestrictedParameter ( string $p_parameterName ) : boolean Returns true if the given parameter is restricted and can not be set from outside the URL object.

Protected Methods

Method Description
buildURI ( array &$p_params = [], boolean $p_preview = false ) : void Sets the URI path and query values based on given parameters.

Private Methods

Method Description
buildPath ( $p_template ) fn buildURI
getURIArticle ( ) : string Gets the article URI query path.
getURIIssue ( ) : string Gets the issue URI query path.
getURILanguage ( ) : string Gets the language URI query path.
getURIPublication ( ) : string Gets the publication URI query path.
getURISection ( ) : string Gets the section URI query path.
readTemplate ( ) : null | string Returns the template name from URI.
setURL ( ) : void Sets the URL values.

Method Details

__construct() public method

Class constructor
public __construct ( string $p_uri = null )
$p_uri string The requested URI

buildURI() protected method

Sets the URI path and query values based on given parameters.
protected buildURI ( array &$p_params = [], boolean $p_preview = false ) : void
$p_params array An array of valid URL parameters
$p_preview boolean If true, will keep the preview parameters in the URL
return void

getFormParameters() public method

public getFormParameters ( ) : array
return array An array containing all the form parameters to print out

getQueryArray() public method

fn __construct
public getQueryArray ( array $p_keepParameters = [], array $p_removeParameters = [] )
$p_keepParameters array
$p_removeParameters array

isRestrictedParameter() public method

Returns true if the given parameter is restricted and can not be set from outside the URL object.
public isRestrictedParameter ( string $p_parameterName ) : boolean
$p_parameterName string
return boolean