PHP Class Sulu\Component\Webspace\Manager\WebspaceCollection

Inheritance: implements IteratorAggregate
Datei anzeigen Open project: sulu/sulu Class Usage Examples

Public Methods

Method Description
addResource ( Symfony\Component\Config\Resource\FileResource $resource ) Adds a new FileResource, which is required to determine if the cache is fresh.
getIterator ( ) : Traversable (PHP 5 >= 5.0.0)
Retrieve an external iterator.
getPortal ( $key ) : Portal Returns the portal with the given index.
getPortalInformations ( $environment, array | null $types = null ) : PortalInformation[] Returns the portal informations for the given environment.
getPortals ( ) : Portal[] Returns all the portals of this collection.
getResources ( ) : array Returns the resources used to build this collection.
getWebspace ( $key ) : Webspace Returns the webspace with the given key.
getWebspaces ( ) : Webspace[]
length ( ) : integer Returns the length of the collection.
setPortalInformations ( array $portalInformations ) Sets the portal Information for this collection.
setPortals ( Portal[] $portals ) Sets the portals for this collection.
setWebspaces ( Webspace[] $webspaces )
toArray ( ) : array Returns the content of these portals as array.

Method Details

addResource() public method

Adds a new FileResource, which is required to determine if the cache is fresh.
public addResource ( Symfony\Component\Config\Resource\FileResource $resource )
$resource Symfony\Component\Config\Resource\FileResource

getIterator() public method

(PHP 5 >= 5.0.0)
Retrieve an external iterator.
See link: http://php.net/manual/en/iteratoraggregate.getiterator.php
public getIterator ( ) : Traversable
return Traversable An instance of an object implementing Iterator or Traversable

getPortal() public method

Returns the portal with the given index.
public getPortal ( $key ) : Portal
$key string The index of the portal
return Sulu\Component\Webspace\Portal

getPortalInformations() public method

Returns the portal informations for the given environment.
public getPortalInformations ( $environment, array | null $types = null ) : PortalInformation[]
$environment string The environment to deliver
$types array | null Defines which typr of portals are requested (null for all)
return Sulu\Component\Webspace\PortalInformation[]

getPortals() public method

Returns all the portals of this collection.
public getPortals ( ) : Portal[]
return Sulu\Component\Webspace\Portal[]

getResources() public method

Returns the resources used to build this collection.
public getResources ( ) : array
return array The resources build to use this collection

getWebspace() public method

Returns the webspace with the given key.
public getWebspace ( $key ) : Webspace
$key string The key of the webspace
return Sulu\Component\Webspace\Webspace

getWebspaces() public method

public getWebspaces ( ) : Webspace[]
return Sulu\Component\Webspace\Webspace[]

length() public method

Returns the length of the collection.
public length ( ) : integer
return integer

setPortalInformations() public method

Sets the portal Information for this collection.
public setPortalInformations ( array $portalInformations )
$portalInformations array

setPortals() public method

Sets the portals for this collection.
public setPortals ( Portal[] $portals )
$portals Sulu\Component\Webspace\Portal[]

setWebspaces() public method

public setWebspaces ( Webspace[] $webspaces )
$webspaces Sulu\Component\Webspace\Webspace[]

toArray() public method

Returns the content of these portals as array.
public toArray ( ) : array
return array