1. class
  2. Thelia
  3. Core
  4. Archiver
  5. ArchiverManager

ArchiverManager

class ArchiverManager

Class ArchiverManager

Methods

$this
reset()

Reset manager

array
getArchivers( null|boolean $isAvailable = null)

Get all archivers or only those match availability

boolean
has( string $archiverId, boolean $throwException = false)

Determine if an archiver exists under the given identifier

null|ArchiverInterface
get( string $archiverId, null|boolean $isAvailable = null)

Get an archiver

$this
setArchivers( array $archivers)

Set archivers

$this
add( ArchiverInterface $archiver)

Add an archiver

remove( string $archiverId)

Remove an archiver

Details

at line 33
$this reset()

Reset manager

Return Value

$this Return $this, allow chaining

at line 47
array getArchivers( null|boolean $isAvailable = null)

Get all archivers or only those match availability

Parameters

null|boolean $isAvailable Filter archivers by availability

Return Value

array All, or filtered by availability, archivers

at line 75
boolean has( string $archiverId, boolean $throwException = false)

Determine if an archiver exists under the given identifier

Parameters

string $archiverId An archiver identifier
boolean $throwException Throw exception if archiver doesn't exists or not

Return Value

boolean True if the archiver exists, false otherwise

Exceptions

InvalidArgumentException if the archiver identifier does not exist

at line 101
null|ArchiverInterface get( string $archiverId, null|boolean $isAvailable = null)

Get an archiver

Parameters

string $archiverId An archiver identifier
null|boolean $isAvailable Filter archiver by availability

Return Value

null|ArchiverInterface Return an archiver or null depends on availability

at line 125
$this setArchivers( array $archivers)

Set archivers

Parameters

array $archivers An array of archiver

Return Value

$this Return $this, allow chaining

Exceptions

Exception

at line 147
$this add( ArchiverInterface $archiver)

Add an archiver

Parameters

ArchiverInterface $archiver An archiver

Return Value

$this Return $this, allow chaining

at line 159
remove( string $archiverId)

Remove an archiver

Parameters

string $archiverId An archiver identifier