Класс FinderIndexerAdapter

Наследует от:

JObject
    └─JEvent
       └─JPlugin
          └─FinderIndexerAdapter

public abstract class FinderIndexerAdapter

Прототип класса адаптера для индексатора Умного поиска.

Свойства класса:

protected string $context	Контекст назначается произвольно, но он должен быть уникальным или будет конфликт при управлении состоянием плагина/индексации.
protected object $db	Объект базы данных.
protected string $extension	Имя расширения.
protected FinderIndexer $indexer	Объект индексации.
protected string $layout	Подсхема представления, используется для рендеринга результатов.
protected string $mime	Тип MIME содержания индекса адаптера.
protected integer $old_access	Уровень доступа элемента перед сохранением.
protected integer $old_cataccess	Уровень доступа категории перед сохранением.
protected string $state_field	Поле, в котором запомнено опубликованное состояние.
protected string $table	Имя таблицы.
protected integer $type_id	Идентификатор типа контента.
protected string $type_title	Тип контента.

Конструктор:

void __construct(mixed subject, array config, object &$subject, mixed properties)

Метод для создания экземпляра адаптера индексатора.

Методы:

boolean onStartIndex()	Метод, для получения состояние адаптера и помесщения его в индексатор.
boolean onBeforeIndex()	Метод, вызываемый перед запуском индексации.
boolean onBuildIndex()	Метод для групповой индексации элементов контента.
protected boolean change(string id, string property, integer value)	Метод для изменения значения свойства элемента контента в таблице ссылок.
protected abstract boolean index(FinderIndexerResult item)	Метод для индексации элемента.
protected boolean reindex(integer id)	Метод, чтобы повторно индексировать элемент.
protected boolean remove(string id)	Метод для удаления элемента из индекса.
protected abstract boolean setup()	Метод для настройки адаптера перед индексации.
protected void categoryAccessChange(JTable row)	Метод для обновления данных индекса на изменения уровня доступа к категории
protected void categoryStateChange(array pks, integer value)	Метод для обновление индекса данных при изменении уровня доступа категории
protected void checkItemAccess(JTable row)	Метод, чтобы проверить существующий уровень доступа для категорий
protected void checkItemAccess(JTable row)	Метод, чтобы проверить существующий уровень доступа для элементов
protected integer getContentCount()	Метод, чтобы получить количество элементов контента доступны для индекса.
protected FinderIndexerResult getItem(integer id)	Метод, чтобы получить элемент контента для индексации.
protected array getItems(integer offset, integer limit, JDatabaseQuery sql)	Метод, чтобы получить список элементов контента для индексирования.
protected JDatabaseQuery getListQuery(mixed sql)	Метод, чтобы получить запрос SQL, используемый для получения списка элементов контента.
protected string getPluginType(integer id)	Метод для получения типа плагина
protected JDatabaseQuery getStateQuery()	Метод, чтобы получить SQL запрос, чтобы загрузить опубликованность и права доступа для статьи и категории.
protected JDatabaseQuery getUpdateQueryByTime(string time)	Метод, чтобы получить предложение запроса для получения элементов для обновления по времени.
protected JDatabaseQuery getUpdateQueryByIds(array ids)	Метод, чтобы получить предложение запроса для получения элементов для обновления по идентификатору.
protected integer getTypeId()	Метод, чтобы получить type id для содержимого адаптера.
protected string getURL(integer id, string extension, string view)	Метод для получения URL-адреса для элемента.
protected mixed getItemMenuTitle(string url)	Метод, чтобы получить заголовок страницы любого пункта меню, который связан с элементом контента, если он существует, и устанавливается.
protected void itemAccessChange(JTable row)	Метод для обновления данных индекса на изменения уровня доступа
protected void itemStateChange(array pks, integer value)	Метод для обновления данных индекса на изменения состояния публикации
protected void pluginDisable(array pks)	Метод обновить данные индекса, когда плагин отключен
protected integer translateState(integer item, integer category)	Метод, чтобы перевести местные состояния контента в состояния для использования в индексации .

Методы, унаследованные от Joomla.Platform \ Plugin

__construct, loadLanguage

Методы, унаследованные от Joomla.Platform \ JEvents

__construct, update

Методы, унаследованные от Joomla.Platform \ JObject

__construct, __toString, def, get, getError, getErrors, getProperties, set, setError, setProperties

Подробности полей:

context

protected string $context

Контекст отчасти произволен но это должно быть уникально или будут конфликты, когда руководящее состояние вставного/индексатора. Хорошая лучшая практика - использовать суффикс вставного имени в качестве контекста. Например, если дополнение к программе есть названый 'Plgfindercontent', контекст смог быть 'Content'.

db

protected object $db

Объект базы данных.

extension

protected string $extension

Имя расширения.

indexer

protected FinderIndexer $indexer

Объект индексации.

layout

protected string $layout

Sublayout использовать при визуализации результатов.

mime

protected string $mime

Тип MIME контента адаптера индексирования.

old_access

protected integer $old_access

Уровень доступа элемента перед сохранением.

old_cataccess

protected integer $old_cataccess

Уровень доступа категории перед сохранением.

state_field

protected string $state_field = 'state'

Поле, в котором сохраняется состояние опубликованности.

table

protected string $table

Имя таблицы.

type_id

protected integer $type_id

Идентификатор типа контента.

type_title

protected string $type_title

Тип содержимого адаптера индексации

Подробности Конструктора:

__construct

public void __construct(mixed subject, array config, object &$subject, mixed properties)

Метод, чтобы получить состояние адаптера и поместить это в индексатор.

Параметры:

&$subject -Объект для наблюдения.

config - Массив, который содержит конфигурацию плагина.

Подробности Методов:

onStartIndex

public boolean onStartIndex()

Метод, чтобы получить состояние адаптера и поместить это в индексатор.

Возвращает:

True в случае успеха.

Исключение - в случае ошибки.

onBeforeIndex

public boolean onBeforeIndex()

Метод, чтобы подготовиться к индексации для запуска. Этот метод часто будет использоваться, чтобы включить зависимостей и вещи той природы.

Возвращает:

True в случае успеха.

Исключение - в случае ошибки.

onBuildIndex

public boolean onBuildIndex()

Метод групповой индексации элементов контента. Этот метод может быть вызван индексацию много раз на протяжении всего процесса индексации в зависимости от того, сколько контента доступно для индексации. Важно отслеживать ход правильно, чтобы отображать его пользование.

Возвращает:

True в случае успеха.

Исключение - в случае ошибки.

change

protected boolean change(string id, string property, integer value)

Метод для изменения значение свойства содержимого элемента в таблице ссылки. Это используется для синхронизации прав доступа к состояния опубликованности, которые изменились, когда элемент не редактировался непосредственно.

Параметры:

id - ID элемента для изменения.

property - Свойство, которое изменяется.

value - Новое значение этого свойства.

Возвращает:

True в случае успеха.

Исключение - в случае ошибки.

index

protected abstract boolean index(FinderIndexerResult item)

Метод, для индексации элемента.

Параметры:

item - Элемент, чтобы индексировать как объект Finderindexerresult.

Возвращает:

True в случае успеха.

Исключение - в случае ошибки базы данных.

remove

protected boolean remove(string id)

Метод удаления элемента из индекса.

Параметры:

id - ID элемента для удаления.

Возвращает:

True в случае успеха.

Исключение - в случае ошибки базы данных.

setup

protected abstract boolean setup()

Метод, чтобы установить адаптер перед индексацией.

Возвращает:

True в случае успеха, false при сбое.

Исключение - в случае ошибки базы данных.

categoryAccessChange

protected void categoryAccessChange(JTable row)

Метод для обновления данных индекса на изменения уровня доступа к категории

Параметры:

row - JTable объект

categoryStateChange

protected void categoryStateChange(array pks, integer value)

Метод для обновления данных индекса в случае изменения уровня доступа к категории

Параметры:

pks - Список первичных ключевых идентификаторов содержимого, которое изменилось состояние.

value -Значение состояния, к которому содержимое было изменено.

checkCategoryAccess

protected void checkCategoryAccess(JTable row)

Метод для проверки существующих уровень доступа для категорий

Параметры:

row - JTable объект

checkItemAccess

protected void checkItemAccess(JTable row)

Метод, чтобы проверить существующий уровень доступа для элементов

Параметры:

row - JTable объект

getContentCount

protected integer getContentCount()

Метод, для получения количества доступных для индексирования элементов контента .

Возвращает:

Количество доступных для индексирования контента элементов.

Исключение - в случае ошибки базы данных.

getItem

protected FinderIndexerResult getItem(integer id)

Метод, чтобы получить элемент контента для индексации.

Параметры:

ID - Идентификатор элемента контента в индексе.

Возвращает:

Объект Finderindexerresult.

Исключение - в случае ошибки базы данных.

getItems

protected array getItems(integer offset, integer limit, JDatabaseQuery sql)

Метод, для получения списка элементов контента в индексе.

Параметры:

offset - Смещение списка.

limit -Ограничение списка.

sql -Объект Jdatabasequery. [необязательный]

Возвращает:

Массив объектов FinderIndexerResult.

Исключение - в случае ошибки базы данных.

getListQuery

protected JDatabaseQuery getListQuery(mixed sql)

Метод для получения запроса SQL, используемого для получения списка элементов контента.

Параметры:

sql -Объект Jdatabasequery. [необязательный]

Возвращает:

Объект базы данных.

getPluginType

protected string getPluginType(integer id)

Метод для получения тип плагина

Параметры:

id - Плагин ID

Возвращает:

Тип плагина

getStateQuery

protected JDatabaseQuery getStateQuery()

Метод для получения SQL-запроса для загрузки опубликованности и прав доступа для статьи и категории.

Возвращает:

Объект базы данных.

getUpdateQueryByTime

protected JDatabaseQuery getUpdateQueryByTime(string time)

Метод, чтобы получить предложение запроса для получения элементов для обновления по времени.

Параметры:

time - Отметки времени изменения.

Возвращает:

Объект базы данных.

getUpdateQueryByIds

protected JDatabaseQuery getUpdateQueryByIds(array ids)

Метод, чтобы получить предложение запроса для получения элементов для обновления по идентификатору.

Параметры:

ids - Идентификаторы для загрузки.

Возвращает:

Объект базы данных.

getTypeId

protected integer getTypeId()

Метод, чтобы получить идентификатор типа для содержания адаптера.

Возвращает:

Числовой id типа для содержимого.

Исключение - в случае ошибки базы данных.

getURL

protected string getURL(integer id, string extension, string view)

Метод, чтобы получить URL для элемента. URL-адрес, как мы смотрим на ссылку в Finder индексе.

Параметры:

id - Id элемента.

extension -Расширение, в котором категория находится.

view - Представление для URL.

Возвращает:

URL-адрес пункта.

getItemMenuTitle

protected mixed getItemMenuTitle(string url)

Метод, чтобы получить заголовок страницы любого пункта меню, который связан с элементом контента, если он существует, и устанавливается.

Параметры:

url - URL-адрес пункта.

Возвращает:

Имя при успехе, null, если не найдено.

Исключение - в случае ошибки базы данных.

itemAccessChange

protected void itemAccessChange(JTable row)

Метод обновление индекса данных при изменениях уровня доступа.

Параметры:

row - JTable объект.

itemStateChange

protected void itemStateChange(array pks, integer value)

Метод для обновления данных индекса при изменении состояния опубликованности.

Параметры:

pks - Список первичных ключевых идентификаторов содержимого, которые изменяют состояние.

value - Значение состояния, к которому содержимое было изменено.

pluginDisable

protected void pluginDisable(array pks)

Метод для обновления данные индекса, когда плагин отключен.

Параметры:

pks - список первоначального ключевого ids содержимого, которое изменило состояние.

translateState

protected integer translateState(integer item, integer category)

Метод, для перевода собственного состояния контента на состояние, которое можно использовать в индексе.

Параметры:

item - Состояние элемента.

category - Состояние категории. [необязательный]

Возвращает:

Переведенное состояние индексатора.

__construct, update