PHP Class Sulu\Component\Webspace\PortalInformation

Inheritance: implements Sulu\Component\Util\ArrayableInterface
Show file Open project: sulu/sulu Class Usage Examples

Public Methods

Method Description
__construct ( $type, Webspace $webspace = null, Portal $portal = null, Localization $localization = null, $url = null, Segment $segment = null, $redirect = null, $analyticsKey = null, $main = false, $urlExpression = null, $priority )
getAnalyticsKey ( ) : string Returns the analytics key of this Portalinformation.
getHost ( ) : string Returns the host including the domain for the PortalInformation.
getLocale ( ) : string Returns the localization for this PortalInformation.
getLocalization ( ) : Localization Returns the localization for this PortalInformation.
getPortal ( ) : Portal Returns the portal for this PortalInformation.
getPortalKey ( ) Returns key of portal.
getPrefix ( ) : string Returns the prefix (the url without the host) for this PortalInformation.
getPriority ( ) : integer
getRedirect ( ) : string Returns the redirect for the PortalInformation.
getSegment ( ) : Segment Returns the segment for the PortalInformation.
getType ( ) : integer Returns the match type of this PortalInformation.
getUrl ( ) : string Returns the URL of this Portalinformation.
getUrlExpression ( ) : string Returns expression for url.
getWebspace ( ) : Webspace Returns the webspace for this PortalInformation.
getWebspaceKey ( ) Returns key of webspace.
isMain ( ) : boolean Returns true if url is main.
setAnalyticsKey ( string $analyticsKey ) Sets the analytics key of this Portalinformation.
setLocalization ( Localization $localization ) Sets the localization for this PortalInformation.
setMain ( boolean $main ) Sets true if url is main.
setPortal ( Portal $portal ) Sets the portal for this PortalInformation.
setPriority ( integer $priority )
setRedirect ( string $redirect ) Sets the redirect for the PortalInformation.
setSegment ( Segment $segment ) Sets the segment for the PortalInformation.
setType ( integer $type ) Sets the match type of this PortalInformation.
setUrl ( string $url ) Sets the URL of this Portalinformation.
setUrlExpression ( string $urlExpression ) Sets expression for url.
setWebspace ( Webspace $webspace ) Sets the webspace for this PortalInformation.
toArray ( $depth = null )

Private Methods

Method Description
getHostLength ( ) : integer Calculate the length of the host part of the URL.

Method Details

__construct() public method

public __construct ( $type, Webspace $webspace = null, Portal $portal = null, Localization $localization = null, $url = null, Segment $segment = null, $redirect = null, $analyticsKey = null, $main = false, $urlExpression = null, $priority )
$webspace Webspace
$portal Portal
$localization Sulu\Component\Localization\Localization
$segment Segment

getAnalyticsKey() public method

Returns the analytics key of this Portalinformation.
public getAnalyticsKey ( ) : string
return string

getHost() public method

Returns the host including the domain for the PortalInformation.
public getHost ( ) : string
return string

getLocale() public method

Returns the localization for this PortalInformation.
public getLocale ( ) : string
return string

getLocalization() public method

Returns the localization for this PortalInformation.
public getLocalization ( ) : Localization
return Sulu\Component\Localization\Localization

getPortal() public method

Returns the portal for this PortalInformation.
public getPortal ( ) : Portal
return Portal

getPortalKey() public method

Returns key of portal.
public getPortalKey ( )

getPrefix() public method

Returns the prefix (the url without the host) for this PortalInformation.
public getPrefix ( ) : string
return string

getPriority() public method

public getPriority ( ) : integer
return integer

getRedirect() public method

Returns the redirect for the PortalInformation.
public getRedirect ( ) : string
return string

getSegment() public method

Returns the segment for the PortalInformation.
public getSegment ( ) : Segment
return Segment

getType() public method

Returns the match type of this PortalInformation.
public getType ( ) : integer
return integer

getUrl() public method

Returns the URL of this Portalinformation.
public getUrl ( ) : string
return string

getUrlExpression() public method

Returns expression for url.
public getUrlExpression ( ) : string
return string

getWebspace() public method

Returns the webspace for this PortalInformation.
public getWebspace ( ) : Webspace
return Webspace

getWebspaceKey() public method

Returns key of webspace.
public getWebspaceKey ( )

isMain() public method

Returns true if url is main.
public isMain ( ) : boolean
return boolean

setAnalyticsKey() public method

Sets the analytics key of this Portalinformation.
public setAnalyticsKey ( string $analyticsKey )
$analyticsKey string

setLocalization() public method

Sets the localization for this PortalInformation.
public setLocalization ( Localization $localization )
$localization Sulu\Component\Localization\Localization

setMain() public method

Sets true if url is main.
public setMain ( boolean $main )
$main boolean

setPortal() public method

Sets the portal for this PortalInformation.
public setPortal ( Portal $portal )
$portal Portal

setPriority() public method

public setPriority ( integer $priority )
$priority integer

setRedirect() public method

Sets the redirect for the PortalInformation.
public setRedirect ( string $redirect )
$redirect string

setSegment() public method

Sets the segment for the PortalInformation.
public setSegment ( Segment $segment )
$segment Segment

setType() public method

Sets the match type of this PortalInformation.
public setType ( integer $type )
$type integer

setUrl() public method

Sets the URL of this Portalinformation.
public setUrl ( string $url )
$url string

setUrlExpression() public method

Sets expression for url.
public setUrlExpression ( string $urlExpression )
$urlExpression string

setWebspace() public method

Sets the webspace for this PortalInformation.
public setWebspace ( Webspace $webspace )
$webspace Webspace

toArray() public method

public toArray ( $depth = null )