PHP Class Sulu\Bundle\MediaBundle\Api\Collection

Inheritance: extends Sulu\Component\Rest\ApiWrapper
Show file Open project: sulu/sulu Class Usage Examples

Protected Properties

Property Type Description
$breadcrumb array
$children Collection[]
$entity Sulu\Bundle\MediaBundle\Entity\CollectionInterface
$mediaCount integer
$parent Collection
$preview array
$properties array
$subCollectionCount integer

Public Methods

Method Description
__construct ( Sulu\Bundle\MediaBundle\Entity\CollectionInterface $collection, $locale )
addChild ( Collection $child ) Add child to resource.
getBreadcrumb ( ) : array
getChanged ( ) : string
getChanger ( ) : string
getChildren ( ) : Collection[] Returns children of resource.
getCreated ( ) : string
getCreator ( ) : string
getDescription ( ) : string
getHasSub ( ) : boolean Indicates if sub collections exists.
getId ( ) : integer
getKey ( ) : string
getLocale ( ) : mixed
getLocked ( ) : string
getMediaCount ( ) : integer
getObjectCount ( ) : integer
getParent ( ) : Collection
getPreview ( ) : array
getProperties ( ) : array
getStyle ( ) : array
getSubCollectionCount ( ) : integer
getTitle ( ) : string
getType ( ) : CollectionType
setBreadcrumb ( array $breadcrumb )
setChanger ( Sulu\Component\Security\Authentication\UserInterface $changer )
setChildren ( Collection[] $children ) Set children of resource.
setCreator ( Sulu\Component\Security\Authentication\UserInterface $creator )
setDescription ( string $description )
setKey ( string $key )
setMediaCount ( integer $mediaCount )
setParent ( Collection $parent )
setPreview ( array $preview )
setProperties ( array $properties )
setStyle ( array $style )
setSubCollectionCount ( integer $subCollectionCount )
setTitle ( string $title )
setType ( CollectionType $type )

Private Methods

Method Description
getMeta ( boolean $create = false ) : CollectionMeta

Method Details

__construct() public method

public __construct ( Sulu\Bundle\MediaBundle\Entity\CollectionInterface $collection, $locale )
$collection Sulu\Bundle\MediaBundle\Entity\CollectionInterface

addChild() public method

Add child to resource.
public addChild ( Collection $child )
$child Collection

getBreadcrumb() public method

public getBreadcrumb ( ) : array
return array

getChanged() public method

public getChanged ( ) : string
return string

getChanger() public method

public getChanger ( ) : string
return string

getChildren() public method

Returns children of resource.
public getChildren ( ) : Collection[]
return Collection[]

getCreated() public method

public getCreated ( ) : string
return string

getCreator() public method

public getCreator ( ) : string
return string

getDescription() public method

public getDescription ( ) : string
return string

getHasSub() public method

Indicates if sub collections exists.
public getHasSub ( ) : boolean
return boolean

getId() public method

public getId ( ) : integer
return integer

getKey() public method

public getKey ( ) : string
return string

getLocale() public method

public getLocale ( ) : mixed
return mixed

getLocked() public method

public getLocked ( ) : string
return string

getMediaCount() public method

public getMediaCount ( ) : integer
return integer The number of media contained by the collection

getObjectCount() public method

public getObjectCount ( ) : integer
return integer

getParent() public method

public getParent ( ) : Collection
return Collection

getPreview() public method

public getPreview ( ) : array
return array

getProperties() public method

public getProperties ( ) : array
return array

getStyle() public method

public getStyle ( ) : array
return array

getSubCollectionCount() public method

public getSubCollectionCount ( ) : integer
return integer The number of sub collections contained by the collection

getTitle() public method

public getTitle ( ) : string
return string

getType() public method

public getType ( ) : CollectionType
return Sulu\Bundle\MediaBundle\Entity\CollectionType

setBreadcrumb() public method

public setBreadcrumb ( array $breadcrumb )
$breadcrumb array

setChanger() public method

public setChanger ( Sulu\Component\Security\Authentication\UserInterface $changer )
$changer Sulu\Component\Security\Authentication\UserInterface

setChildren() public method

Set children of resource.
public setChildren ( Collection[] $children )
$children Collection[]

setCreator() public method

public setCreator ( Sulu\Component\Security\Authentication\UserInterface $creator )
$creator Sulu\Component\Security\Authentication\UserInterface

setDescription() public method

public setDescription ( string $description )
$description string

setKey() public method

public setKey ( string $key )
$key string

setMediaCount() public method

public setMediaCount ( integer $mediaCount )
$mediaCount integer The new number of media

setParent() public method

public setParent ( Collection $parent )
$parent Collection

setPreview() public method

public setPreview ( array $preview )
$preview array

setProperties() public method

public setProperties ( array $properties )
$properties array

setStyle() public method

public setStyle ( array $style )
$style array

setSubCollectionCount() public method

public setSubCollectionCount ( integer $subCollectionCount )
$subCollectionCount integer The new number of sub collections

setTitle() public method

public setTitle ( string $title )
$title string

setType() public method

public setType ( CollectionType $type )
$type Sulu\Bundle\MediaBundle\Entity\CollectionType

Property Details

$breadcrumb protected property

protected array $breadcrumb
return array

$children protected property

protected Collection[],Sulu\Bundle\MediaBundle\Api $children
return Collection[]

$entity protected property

protected CollectionInterface,Sulu\Bundle\MediaBundle\Entity $entity
return Sulu\Bundle\MediaBundle\Entity\CollectionInterface

$mediaCount protected property

protected int $mediaCount
return integer

$parent protected property

protected Collection,Sulu\Bundle\MediaBundle\Api $parent
return Collection

$preview protected property

protected array $preview
return array

$properties protected property

protected array $properties
return array

$subCollectionCount protected property

protected int $subCollectionCount
return integer