PHP Класс MetaModels\BackendIntegration\SearchablePages

Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$configs array A list with all settings from the database.
$foundPages array A list with all pages found by Contao.

Открытые методы

Метод Описание
__construct ( ) Construct.
addPages ( array $pages, integer | null $rootPage = null, boolean | null $fromSiteMap = false, string | null $language = null ) : array Start point for the hook getSearchablePages.
setFilterParameters ( string $filterId, string[] $presets, string[] $values ) : array Set parameters.

Защищенные методы

Метод Описание
getAttributeFactory ( ) : MetaModels\Attribute\IAttributeFactory Get the attribute Factory.
getEventDispatcher ( ) : Symfony\Component\EventDispatcher\EventDispatcherInterface Get the event Dispatcher.
getFilterSettings ( mixed $identifier ) : MetaModels\Filter\Setting\ICollection Get a filter based on the id.
getJumpTosFor ( array $availableLanguages, MetaModels\IMetaModel $metaModels, MetaModels\Filter\IFilter $filter, MetaModels\Render\Setting\ICollection $view, string | null $rootPage = null ) : array Get the list of jumpTos based on the items.
getLanguage ( string $singleLanguage, MetaModels\IMetaModel $metaModels ) : string[] Get the language.
getMetaModel ( string | integer $identifier, boolean $ignoreError ) : MetaModels\IMetaModel | null Get a MetaModels by name or id.
getMetaModelsFactory ( ) : MetaModels\IFactory Get the MetaModels Factory.
getServiceContainer ( ) : MetaModels\IMetaModelsServiceContainer Retrieve the service container.
getView ( string | integer $identifier, integer $view ) : MetaModels\Render\Setting\ICollection Get the view for a MetaModels.
removeEmptyDetailPages ( array $jumpTos ) : void Remove all empty detail pages.

Приватные методы

Метод Описание
getBaseUrl ( string[] $pageDetails, null | string $path = null, boolean $ignoreSSL = false ) : ContaoCommunityAlliance\UrlBuilder\UrlBuilder Get the base URL.
getMetaModelsPages ( array $config, string | null $rootPage = null, string | null $language = null ) : void Get a MetaModels, a filter and a renderSetting. Get all items based on the filter and build the jumpTo urls.

Описание методов

__construct() публичный Метод

Construct.
public __construct ( )

addPages() публичный Метод

Start point for the hook getSearchablePages.
См. также: RebuildIndex::run()
См. также: Automator::generateSitemap()
public addPages ( array $pages, integer | null $rootPage = null, boolean | null $fromSiteMap = false, string | null $language = null ) : array
$pages array List with all pages.
$rootPage integer | null ID of the root page.
$fromSiteMap boolean | null True when called from sitemap generator, null otherwise.
$language string | null The current language.
Результат array

getAttributeFactory() защищенный Метод

Get the attribute Factory.
protected getAttributeFactory ( ) : MetaModels\Attribute\IAttributeFactory
Результат MetaModels\Attribute\IAttributeFactory

getEventDispatcher() защищенный Метод

Get the event Dispatcher.
protected getEventDispatcher ( ) : Symfony\Component\EventDispatcher\EventDispatcherInterface
Результат Symfony\Component\EventDispatcher\EventDispatcherInterface

getFilterSettings() защищенный Метод

Get a filter based on the id.
protected getFilterSettings ( mixed $identifier ) : MetaModels\Filter\Setting\ICollection
$identifier mixed Id of the filter.
Результат MetaModels\Filter\Setting\ICollection The filter

getJumpTosFor() защищенный Метод

Get the list of jumpTos based on the items.
protected getJumpTosFor ( array $availableLanguages, MetaModels\IMetaModel $metaModels, MetaModels\Filter\IFilter $filter, MetaModels\Render\Setting\ICollection $view, string | null $rootPage = null ) : array
$availableLanguages array List of languages to be used.
$metaModels MetaModels\IMetaModel The MetaModels to be used.
$filter MetaModels\Filter\IFilter The filter to be used.
$view MetaModels\Render\Setting\ICollection The view to be used.
$rootPage string | null The root page id or null if there is no root page.
Результат array A list of urls for the jumpTos

getLanguage() защищенный Метод

First check the overwrite language. Then check if the MetaModels is translated and get all languages from it. Use the current language as fallback.
protected getLanguage ( string $singleLanguage, MetaModels\IMetaModel $metaModels ) : string[]
$singleLanguage string The language with the overwrite.
$metaModels MetaModels\IMetaModel The MetaModels for the check.
Результат string[] A list with all languages or null.

getMetaModel() защищенный Метод

Get a MetaModels by name or id.
protected getMetaModel ( string | integer $identifier, boolean $ignoreError ) : MetaModels\IMetaModel | null
$identifier string | integer The Name or ID of a MetaModels.
$ignoreError boolean If true ignore errors like the MetaModels was not found.
Результат MetaModels\IMetaModel | null

getMetaModelsFactory() защищенный Метод

Get the MetaModels Factory.
protected getMetaModelsFactory ( ) : MetaModels\IFactory
Результат MetaModels\IFactory

getServiceContainer() защищенный Метод

Retrieve the service container.
protected getServiceContainer ( ) : MetaModels\IMetaModelsServiceContainer
Результат MetaModels\IMetaModelsServiceContainer

getView() защищенный Метод

Get the view for a MetaModels.
protected getView ( string | integer $identifier, integer $view ) : MetaModels\Render\Setting\ICollection
$identifier string | integer ID/Name of the MetaModels.
$view integer ID of the view.
Результат MetaModels\Render\Setting\ICollection

removeEmptyDetailPages() защищенный Метод

Remove all empty detail pages.
protected removeEmptyDetailPages ( array $jumpTos ) : void
$jumpTos array A list with the jumpTo pages.
Результат void

setFilterParameters() публичный Метод

Set parameters.
public setFilterParameters ( string $filterId, string[] $presets, string[] $values ) : array
$filterId string The id of the filter.
$presets string[] The parameter preset values to use.
$values string[] The dynamic parameter values that may be used.
Результат array

Описание свойств

$configs защищенное свойство

A list with all settings from the database.
protected array $configs
Результат array

$foundPages защищенное свойство

A list with all pages found by Contao.
protected array $foundPages
Результат array