PHP Класс eZ\Publish\Core\Persistence\Legacy\Content\UrlAlias\Gateway\DoctrineDatabase

Наследование: extends eZ\Publish\Core\Persistence\Legacy\Content\UrlAlias\Gateway
Показать файл Открыть проект

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

Свойство Тип Описание
$columns array Columns of database tables.
$dbHandler eZ\Publish\Core\Persistence\Database\DatabaseHandler Doctrine database handler.
$languageMaskGenerator eZ\Publish\Core\Persistence\Legacy\Content\Language\MaskGenerator Language mask generator.
$table string Main URL database table name.

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

Метод Описание
__construct ( eZ\Publish\Core\Persistence\Database\DatabaseHandler $dbHandler, MaskGenerator $languageMaskGenerator ) Creates a new DoctrineDatabase UrlAlias Gateway.
cleanupAfterPublish ( string $action, mixed $languageId, mixed $newId, mixed $parentId, string $textMD5 ) Downgrades autogenerated entry matched by given $action and $languageId and negatively matched by composite primary key.
getLocationContentMainLanguageId ( $locationId )
getNextId ( ) : mixed Returns next value for "id" column.
historizeBeforeSwap ( $action, $languageMask )
historizeId ( mixed $id, mixed $link ) Marks all entries with given $id as history entries.
insertRow ( array $values ) : mixed Inserts new row in urlalias_ml table.
isRootEntry ( mixed $id ) : boolean Returns boolean indicating if the row with given $id is special root entry.
listGlobalEntries ( string | null $languageCode = null, integer $offset, integer $limit ) : array Loads paged list of global aliases.
loadAutogeneratedEntries ( mixed $parentId, boolean $includeHistory = false ) : array Loads all autogenerated entries with given $parentId with optionally included history entries.
loadAutogeneratedEntry ( string $action, mixed | null $parentId = null ) : array Loads autogenerated entry id by given $action and optionally $parentId.
loadLocationEntries ( mixed $locationId, boolean $custom = false, mixed $languageId = false ) : array Loads list of aliases by given $locationId.
loadPathData ( mixed $id ) : array Loads all data for the path identified by given $id.
loadPathDataByHierarchy ( array $hierarchyData ) : array Loads path data identified by given ordered array of hierarchy data.
loadRow ( mixed $parentId, string $textMD5 ) : array Loads single row data matched by composite primary key.
loadUrlAliasData ( array $urlHashes ) : array Loads complete URL alias data by given array of path hashes.
remove ( mixed $action, mixed | null $id = null ) : boolean Deletes all rows with given $action and optionally $id.
removeCustomAlias ( mixed $parentId, string $textMD5 ) : boolean Deletes single custom alias row matched by composite primary key.
reparent ( mixed $oldParentId, mixed $newParentId ) Updates parent id of autogenerated entries.
setTable ( $name )
updateRow ( mixed $parentId, string $textMD5, array $values ) Updates single row data matched by composite primary key.

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

Метод Описание
historize ( integer $parentId, string $textMD5, integer $newId ) Updates single row matched by composite primary key.
removeTranslation ( mixed $parentId, string $textMD5, mixed $languageId ) Updates single row data matched by composite primary key.
setQueryValues ( eZ\Publish\Core\Persistence\Database\Query $query, array $values ) Sets value for insert or update query.

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

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

Creates a new DoctrineDatabase UrlAlias Gateway.
public __construct ( eZ\Publish\Core\Persistence\Database\DatabaseHandler $dbHandler, MaskGenerator $languageMaskGenerator )
$dbHandler eZ\Publish\Core\Persistence\Database\DatabaseHandler
$languageMaskGenerator eZ\Publish\Core\Persistence\Legacy\Content\Language\MaskGenerator

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

If language mask of the found entry is composite (meaning it consists of multiple language ids) given $languageId will be removed from mask. Otherwise entry will be marked as history.
public cleanupAfterPublish ( string $action, mixed $languageId, mixed $newId, mixed $parentId, string $textMD5 )
$action string
$languageId mixed
$newId mixed
$parentId mixed
$textMD5 string

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

public getLocationContentMainLanguageId ( $locationId )

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

Returns next value for "id" column.
public getNextId ( ) : mixed
Результат mixed

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

Sets "is_original" to 0 thus marking entry as history. Re-links history entries. When location alias is published we need to check for new history entries created with self::downgrade() with the same action and language, update their "link" column with id of the published entry. History entry "id" column is moved to next id value so that all active (non-history) entries are kept under the same id.
protected historize ( integer $parentId, string $textMD5, integer $newId )
$parentId integer
$textMD5 string
$newId integer

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

public historizeBeforeSwap ( $action, $languageMask )

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

This method is used by Handler::locationMoved(). Each row is separately historized because future publishing needs to be able to take over history entries safely.
public historizeId ( mixed $id, mixed $link )
$id mixed
$link mixed

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

Inserts new row in urlalias_ml table.
public insertRow ( array $values ) : mixed
$values array
Результат mixed

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

Special root entry entry will have parentId=0 and text=''. In standard installation this entry will point to location with id=2.
public isRootEntry ( mixed $id ) : boolean
$id mixed
Результат boolean

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

Loads paged list of global aliases.
public listGlobalEntries ( string | null $languageCode = null, integer $offset, integer $limit ) : array
$languageCode string | null
$offset integer
$limit integer
Результат array

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

Loads all autogenerated entries with given $parentId with optionally included history entries.
public loadAutogeneratedEntries ( mixed $parentId, boolean $includeHistory = false ) : array
$parentId mixed
$includeHistory boolean
Результат array

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

Loads autogenerated entry id by given $action and optionally $parentId.
public loadAutogeneratedEntry ( string $action, mixed | null $parentId = null ) : array
$action string
$parentId mixed | null
Результат array

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

Loads list of aliases by given $locationId.
public loadLocationEntries ( mixed $locationId, boolean $custom = false, mixed $languageId = false ) : array
$locationId mixed
$custom boolean
$languageId mixed
Результат array

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

Loads all data for the path identified by given $id.
public loadPathData ( mixed $id ) : array
$id mixed
Результат array

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

The first entry in $hierarchyData corresponds to the top-most path element in the path, the second entry the child of the first path element and so on. This method is faster than self::getPath() since it can fetch all elements using only one query, but can be used only for autogenerated paths.
public loadPathDataByHierarchy ( array $hierarchyData ) : array
$hierarchyData array
Результат array

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

Loads single row data matched by composite primary key.
public loadRow ( mixed $parentId, string $textMD5 ) : array
$parentId mixed
$textMD5 string
Результат array

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

Loads complete URL alias data by given array of path hashes.
public loadUrlAliasData ( array $urlHashes ) : array
$urlHashes array URL string hashes
Результат array

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

If $id is set only autogenerated entries will be removed.
public remove ( mixed $action, mixed | null $id = null ) : boolean
$action mixed
$id mixed | null
Результат boolean

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

Deletes single custom alias row matched by composite primary key.
public removeCustomAlias ( mixed $parentId, string $textMD5 ) : boolean
$parentId mixed
$textMD5 string
Результат boolean

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

Removes given $languageId from entry's language mask
protected removeTranslation ( mixed $parentId, string $textMD5, mixed $languageId )
$parentId mixed
$textMD5 string
$languageId mixed

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

Update includes history entries.
public reparent ( mixed $oldParentId, mixed $newParentId )
$oldParentId mixed
$newParentId mixed

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

Sets value for insert or update query.
protected setQueryValues ( eZ\Publish\Core\Persistence\Database\Query $query, array $values )
$query eZ\Publish\Core\Persistence\Database\Query
$values array

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

public setTable ( $name )

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

Use optional parameter $languageMaskMatch to additionally limit the query match with languages.
public updateRow ( mixed $parentId, string $textMD5, array $values )
$parentId mixed
$textMD5 string
$values array associative array with column names as keys and column values as values

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

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

Columns of database tables.
protected array $columns
Результат array

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

Doctrine database handler.
protected DatabaseHandler,eZ\Publish\Core\Persistence\Database $dbHandler
Результат eZ\Publish\Core\Persistence\Database\DatabaseHandler

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

Language mask generator.
protected MaskGenerator,eZ\Publish\Core\Persistence\Legacy\Content\Language $languageMaskGenerator
Результат eZ\Publish\Core\Persistence\Legacy\Content\Language\MaskGenerator

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

Main URL database table name.
protected string $table
Результат string