• Accueil
• CampURI

PHP Class CampURI

Afficher le fichier Open project: sourcefabric/newscoop Class Usage Examples

Protected Properties

Свойство	Type	Description
$_themePath		The theme path storage
$m_article	MetaArticle	Article object
$m_buildPath	string
$m_buildQuery	string
$m_buildQueryArray	array
$m_config	object
$m_errorCode	integer	Holds the URL process error code; null if no error
$m_fragment	string
$m_host	string
$m_issue	MetaIssue	Issue object
$m_language	MetaLanguage	Language object
$m_objects
$m_parts	array	The URI parts
$m_password	string
$m_path	string
$m_port	integer
$m_preview	boolean	True if in preview mode
$m_previewParameters	array	The list of parameters used in preview mode
$m_publication	MetaPublication	Publication object
$m_query	string
$m_scheme	string
$m_section	MetaSection	Section object
$m_template	MetaTemplate	Template object
$m_type	integer	The URI type It can be either: Template Path = 1 Short Names = 2
$m_uri	string	The URI value
$m_user	MetaUser
$m_validURI	boolean	Whether the URI is valid or not

Méthodes publiques

Méthode	Description
GetPreviewParameters ( )
__construct ( string $p_uri = 'SELF' )	Class constructor
__get ( string $p_property ) : boolean	Sets an object property
__set ( string $p_property, mixed $p_value ) : boolean	Sets an object property
getBase ( ) : string	Gets the URI base, it is the scheme, host and (if exists) port.
getBasePath ( ) : string	Gets the base plus the path from the current URI.
getCampsiteVector ( ) : array	Returns campsite params: language, publication, issue, section, article.
getErrorCode ( ) : integer	Returns the URL processing error code
getFragment ( ) : string	Gets the fragment part from the current URI.
getHost ( ) : string	Gets the host part from the current URI.
getPassword ( ) : string	Gets the password part from the current URI.
getPath ( ) : string	Gets the path part from the current URI.
getPort ( ) : integer	Gets the port part from the current URI.
getQuery ( ) : string	Gets the query part from the current URI.
getQueryArray ( array $p_keepParameters = [], array $p_removeParameters = [] ) : array	Gets the array containing the query variables.
getQueryVar ( string $p_varName ) : string	Gets the given variable from the URI query.
getRelativeBase ( ) : string	Gets the relative URI base, it is '//', host and (if exists) port.
getRequestURI ( ) : string	Gets the requested URI.
getScheme ( ) : string	Gets the scheme part from the current URI.
getTemplate ( $p_templateIdOrName = null )
getThemePath ( )
getURI ( string $p_param = null, boolean $p_preview = false ) : string	Returns the URI string based on given URL parameter.
getURIPath ( string $p_param = null, boolean $p_preview = false ) : string	Returns the URI path based on given URL parameter.
getURL ( ) : string	Gets the URL from the object attributes.
getURLParameters ( string $p_param = null, boolean $p_preview = false ) : string	Returns the URI query parameters based on given URL parameter.
getURLType ( ) : integer	Gets the URL type.
getUser ( ) : string	Returns the user part from the current URI.
isRestrictedParameter ( string $p_parameterName ) : boolean	Returns true if the given parameter is restricted and can not be set from outside the URL object.
isSSL ( ) : boolean	Returns whether the site is running over SSL or not.
setFragment ( string $p_fragment ) : void	Sets the URI fragment.
setHost ( string $p_host ) : void	Sets the URI host.
setPassword ( $p_password ) : void	Sets the URI password part.
setPath ( string $p_path ) : void	Sets the URI path.
setPort ( integer $p_port ) : void	Sets the URI port.
setQuery ( $p_query ) : void	Gets the query part from the current URI.
setQueryVar ( string $p_varName, string $p_value = null ) : void	Sets the given URI query variable.
setScheme ( string $p_scheme ) : void	Sets the URI scheme.
setUser ( string $p_user ) : void	Sets the URI user part.

Méthodes protégées

Méthode	Description
QueryArrayToString ( array $p_queryArray, $p_HTMLEscape = true ) : string	Builds a URI query string from the given query array.
addToQuery ( &$p_query, array $p_parameters )	Adds the given parameters to the query array
buildURI ( array &$p_params = [], boolean $p_preview = false ) : void	Sets the URI path and query values based on given parameters.
clearParams ( array $parameters )
isValidCache ( ) : boolean	Returns the cache valid state
isValidTemplate ( string $p_templateName ) : boolean	Returns whether the template name given is a valid template resource.
render ( array $p_parts = [] ) : string	Builds a URI string from the given parts.
resetList ( $listIdPrefix )
setURLType ( integer $p_type ) : void	Sets the URL type.
validateCache ( boolean $p_valid )	Sets the cache validation for URI rendering

Private Methods

Méthode	Description
parse ( string $p_uri ) : boolean	Parses the given URI.
processImageOptions ( integer &$p_imageNo, array $p_params )	Process the image options given in the new format: where may be one of: number, ratio, width, height and an integer
processOldImageOptions ( integer &$p_imageNo, array $p_params )	Process the image options given in the old format (for compatibility): [ []] or: [ [width | height ]
readUser ( )

Method Details

Property Details