ExtensionCatalogueInterface
The catalogue of extensions offered for installation, as the "Get Extensions" module browses it: one page of the list at a time, the search, the versions of a single extension and the distributions.
Resolving a specific package for download is deliberately not part of this contract - that is a different concern with a different set of callers.
Implementations do not filter extensions marked as insecure, this has to happen on a different level when needed.
This interface is a specific ExtensionManager implementation and is not part of the Public TYPO3 API.
Table of Contents
Methods
- countAll() : int
- The number of extensions {@see findAll} pages through.
- countByTitleOrAuthorNameOrExtensionKey() : int
- The number of extensions {@see findByTitleOrAuthorNameOrExtensionKey} pages through.
- findAll() : Extension[]
- One page of the catalogue, newest extension first.
- findAllCommunityDistributions() : Extension[]
- The distributions published by anyone else.
- findAllOfficialDistributions() : Extension[]
- The distributions published by the TYPO3 CMS team.
- findByExtensionKeyOrderedByVersion() : Extension[]
- All versions of a single extension, highest version first.
- findByTitleOrAuthorNameOrExtensionKey() : Extension[]
- One page of the extensions matching a search term, most relevant first.
- findOneByCurrentVersionByExtensionKey() : Extension|null
- The version of an extension that is currently offered for installation, or null if the catalogue does not know the extension.
Methods
countAll()
The number of extensions {@see findAll} pages through.
public
countAll() : int
Return values
intcountByTitleOrAuthorNameOrExtensionKey()
The number of extensions {@see findByTitleOrAuthorNameOrExtensionKey} pages through.
public
countByTitleOrAuthorNameOrExtensionKey(string $searchString) : int
Parameters
- $searchString : string
Return values
intfindAll()
One page of the catalogue, newest extension first.
public
findAll(int $offset, int $limit) : Extension[]
Parameters
- $offset : int
- $limit : int
Return values
Extension[]findAllCommunityDistributions()
The distributions published by anyone else.
public
findAllCommunityDistributions([bool $showUnsuitableDistributions = false ]) : Extension[]
Parameters
- $showUnsuitableDistributions : bool = false
Return values
Extension[]findAllOfficialDistributions()
The distributions published by the TYPO3 CMS team.
public
findAllOfficialDistributions([bool $showUnsuitableDistributions = false ]) : Extension[]
Parameters
- $showUnsuitableDistributions : bool = false
Return values
Extension[]findByExtensionKeyOrderedByVersion()
All versions of a single extension, highest version first.
public
findByExtensionKeyOrderedByVersion(string $extensionKey) : Extension[]
Parameters
- $extensionKey : string
Return values
Extension[]findByTitleOrAuthorNameOrExtensionKey()
One page of the extensions matching a search term, most relevant first.
public
findByTitleOrAuthorNameOrExtensionKey(string $searchString, int $offset, int $limit) : Extension[]
Parameters
- $searchString : string
- $offset : int
- $limit : int
Return values
Extension[]findOneByCurrentVersionByExtensionKey()
The version of an extension that is currently offered for installation, or null if the catalogue does not know the extension.
public
findOneByCurrentVersionByExtensionKey(string $extensionKey) : Extension|null
Parameters
- $extensionKey : string