PHP Interface Sulu\Component\Webspace\Manager\WebspaceManagerInterface

Inheritance: extends Sulu\Component\Localization\Provider\LocalizationProviderInterface
ファイルを表示 Open project: sulu/sulu Interface Usage Examples

Public Methods

Method Description
findPortalByKey ( string $key ) : Portal Returns the portal with the given key.
findPortalInformationByUrl ( string $url, string $environment ) : PortalInformation | null Returns the portal with the given url (which has not necessarily to be the main url).
findPortalInformationsByPortalKeyAndLocale ( string $portalKey, string $locale, string $environment ) : PortalInformation[] Returns all portal which matches the given portal-key and locale.
findPortalInformationsByUrl ( string $url, string $environment ) : PortalInformation[] Returns all portal which matches the given url (which has not necessarily to be the main url).
findPortalInformationsByWebspaceKeyAndLocale ( string $webspaceKey, string $locale, string $environment ) : PortalInformation[] Returns all portal which matches the given webspace-key and locale.
findUrlByResourceLocator ( string $resourceLocator, string $environment, string $languageCode, null | string $webspaceKey = null, null | string $domain = null, string $scheme = 'http' ) : string Returns the main url for resourcelocator.
findUrlsByResourceLocator ( string $resourceLocator, string $environment, string $languageCode, null | string $webspaceKey = null, null | string $domain = null, string $scheme = 'http' ) : array Returns all possible urls for resourcelocator.
findWebspaceByKey ( $key ) : Webspace Returns the webspace with the given key.
getAllLocalesByWebspaces ( ) : array For all available webspaces provide all their possible locales. Moreover for each website the default locale is provided. The default locales of the webspaces are always on the first position.
getPortalInformations ( string $environment ) : PortalInformation[] Returns the portal informations managed by this WebspaceManger.
getPortalInformationsByWebspaceKey ( string $environment, $webspaceKey ) : PortalInformation[] Returns the portal informations for the given webspace managed by this WebspaceManager.
getPortals ( ) : Portal[] Returns all portals managed by this webspace manager.
getUrls ( string $environment ) : string[] Returns all URLs in the given environment managed by this WebspaceManager.
getWebspaceCollection ( ) : WebspaceCollection Returns all the webspaces managed by this specific instance.

Method Details

findPortalByKey() public method

Returns the portal with the given key.
public findPortalByKey ( string $key ) : Portal
$key string The key to search for
return Sulu\Component\Webspace\Portal

findPortalInformationByUrl() public method

Returns the portal with the given url (which has not necessarily to be the main url).
public findPortalInformationByUrl ( string $url, string $environment ) : PortalInformation | null
$url string The url to search for
$environment string The environment in which the url should be searched
return Sulu\Component\Webspace\PortalInformation | null

findPortalInformationsByPortalKeyAndLocale() public method

Returns all portal which matches the given portal-key and locale.
public findPortalInformationsByPortalKeyAndLocale ( string $portalKey, string $locale, string $environment ) : PortalInformation[]
$portalKey string The portal-key which the portal should match
$locale string The locale which the portal should match
$environment string The environment in which the url should be searched
return Sulu\Component\Webspace\PortalInformation[]

findPortalInformationsByUrl() public method

Returns all portal which matches the given url (which has not necessarily to be the main url).
public findPortalInformationsByUrl ( string $url, string $environment ) : PortalInformation[]
$url string The url to search for
$environment string The environment in which the url should be searched
return Sulu\Component\Webspace\PortalInformation[]

findPortalInformationsByWebspaceKeyAndLocale() public method

Returns all portal which matches the given webspace-key and locale.
public findPortalInformationsByWebspaceKeyAndLocale ( string $webspaceKey, string $locale, string $environment ) : PortalInformation[]
$webspaceKey string The webspace-key which the portal should match
$locale string The locale which the portal should match
$environment string The environment in which the url should be searched
return Sulu\Component\Webspace\PortalInformation[]

findUrlByResourceLocator() public method

Returns the main url for resourcelocator.
public findUrlByResourceLocator ( string $resourceLocator, string $environment, string $languageCode, null | string $webspaceKey = null, null | string $domain = null, string $scheme = 'http' ) : string
$resourceLocator string
$environment string
$languageCode string
$webspaceKey null | string
$domain null | string
$scheme string
return string

findUrlsByResourceLocator() public method

Returns all possible urls for resourcelocator.
public findUrlsByResourceLocator ( string $resourceLocator, string $environment, string $languageCode, null | string $webspaceKey = null, null | string $domain = null, string $scheme = 'http' ) : array
$resourceLocator string
$environment string
$languageCode string
$webspaceKey null | string
$domain null | string
$scheme string
return array

findWebspaceByKey() public method

Returns the webspace with the given key.
public findWebspaceByKey ( $key ) : Webspace
$key string The key to search for
return Sulu\Component\Webspace\Webspace

getAllLocalesByWebspaces() public method

For all available webspaces provide all their possible locales. Moreover for each website the default locale is provided. The default locales of the webspaces are always on the first position.
public getAllLocalesByWebspaces ( ) : array
return array

getPortalInformations() public method

Returns the portal informations managed by this WebspaceManger.
public getPortalInformations ( string $environment ) : PortalInformation[]
$environment string
return Sulu\Component\Webspace\PortalInformation[]

getPortalInformationsByWebspaceKey() public method

Returns the portal informations for the given webspace managed by this WebspaceManager.
public getPortalInformationsByWebspaceKey ( string $environment, $webspaceKey ) : PortalInformation[]
$environment string
return Sulu\Component\Webspace\PortalInformation[]

getPortals() public method

Returns all portals managed by this webspace manager.
public getPortals ( ) : Portal[]
return Sulu\Component\Webspace\Portal[]

getUrls() public method

Returns all URLs in the given environment managed by this WebspaceManager.
public getUrls ( string $environment ) : string[]
$environment string
return string[]

getWebspaceCollection() public method

Returns all the webspaces managed by this specific instance.
public getWebspaceCollection ( ) : WebspaceCollection
return WebspaceCollection