Skip to content

Migrate the Language Restriction feature to SiteLanguage #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Konafets wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Migrate the Language Restriction feature to SiteLanguage #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions Classes/Constants.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,5 @@ class Constants

public const L10NMGR_CONFIGURATION_INCLUDE = 3;

public const L10NMGR_LANGUAGE_RESTRICTION_FOREIGN_TABLENAME = 'sys_language';

public const L10NMGR_LANGUAGE_RESTRICTION_MM_TABLENAME = 'sys_language_l10nmgr_language_restricted_record_mm';

public const L10NMGR_LANGUAGE_RESTRICTION_FIELDNAME = 'l10nmgr_language_restriction';
}
233 changes: 60 additions & 173 deletions Classes/LanguageRestriction/Collection/LanguageRestrictionCollection.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,22 @@
* The TYPO3 project - inspiring people to share!
*/

use Doctrine\DBAL\DBALException;
use Doctrine\DBAL\Driver\Exception as DBALDriverException;
use Localizationteam\L10nmgr\Constants;
use PDO;
use RuntimeException;
use SplDoublyLinkedList;
use TYPO3\CMS\Core\Collection\AbstractRecordCollection;
use TYPO3\CMS\Core\Collection\CollectionInterface;
use TYPO3\CMS\Core\Collection\EditableCollectionInterface;
use TYPO3\CMS\Core\Database\ConnectionPool;
use TYPO3\CMS\Core\Database\Query\QueryBuilder;
use TYPO3\CMS\Core\Database\Query\Restriction\DeletedRestriction;
use TYPO3\CMS\Core\Exception\SiteNotFoundException;
use TYPO3\CMS\Core\Site\Entity\NullSite;
use TYPO3\CMS\Core\Site\Entity\Site;
use TYPO3\CMS\Core\Site\Entity\SiteLanguage;
use TYPO3\CMS\Core\Site\SiteFinder;
use TYPO3\CMS\Core\Utility\GeneralUtility;

/**
Expand All @@ -35,104 +41,49 @@
class LanguageRestrictionCollection extends AbstractRecordCollection implements EditableCollectionInterface
{
/**
* The table name collections are stored to
* The table name collections are stored to, must be defined in the subclass
*
* @var string
*/
protected static $storageTableName = Constants::L10NMGR_LANGUAGE_RESTRICTION_FOREIGN_TABLENAME;
protected static $storageTableName = 'pages';

/**
* Name of the language-restrictions-relation field (used in the MM_match_fields/fieldname property of the TCA)
* Contrary to the originally idea of collections, we do not load a record from the database here.
* Instead we get the language by its ID. This is the key for our restriction collection
*
* @var string
*/
protected string $relationFieldName = Constants::L10NMGR_LANGUAGE_RESTRICTION_FIELDNAME;

/**
* Creates this object.
*
* @param string|null $tableName Name of the table to be working on
* @param string|null $fieldName Name of the field where the language restriction relations are defined
* @throws RuntimeException
*/
public function __construct(string $tableName = null, string $fieldName = null)
{
parent::__construct();
if (!empty($tableName)) {
$this->setItemTableName($tableName);
} elseif (empty($this->itemTableName)) {
throw new RuntimeException(self::class . ' needs a valid itemTableName.', 1341826168);
}
if (!empty($fieldName)) {
$this->setRelationFieldName($fieldName);
}
}

/**
* Loads the collections with the given id from persistence
* For memory reasons, per default only f.e. title, database-table,
* identifier (what ever static data is defined) is loaded.
* Entries can be load on first access.
*
* @param int $id Id of database record to be loaded
* @param int $languageId Id of the language to be loaded
* @param bool $fillItems Populates the entries directly on load, might be bad for memory on large collections
* @param string $tableName Name of table from which entries should be loaded
* @param string $fieldName Name of the language restrictions relation field
* @param string $pageId ID of the page
* @return CollectionInterface
* @throws \Doctrine\DBAL\DBALException
*/
public static function load($id, $fillItems = false, string $tableName = '', string $fieldName = ''): CollectionInterface
public static function load($languageId, $fillItems = false, string $tableName = '', int $pageId = 0): CollectionInterface
{
/** @var QueryBuilder $queryBuilder */
$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
->getQueryBuilderForTable(static::$storageTableName);
$queryBuilder->getRestrictions()->removeAll()->add(GeneralUtility::makeInstance(DeletedRestriction::class));

$collectionRecord = $queryBuilder->select('*')
->from(static::$storageTableName)
->where(
$queryBuilder->expr()->eq('uid', $queryBuilder->createNamedParameter($id, PDO::PARAM_INT))
)
->setMaxResults(1)
->execute()
->fetch();
try {
$language = self::getLanguage($pageId, $languageId);
$collectionRecord['uid'] = $language->getLanguageId();
$collectionRecord['title'] = $language->getTitle();
} catch (\RuntimeException $exception) {
$collectionRecord['uid'] = 0;
$collectionRecord['title'] = '';
}

$collectionRecord['description'] = 'Restriction Collection';
$collectionRecord['table_name'] = $tableName;
$collectionRecord['field_name'] = $fieldName;

return self::create($collectionRecord, $fillItems);
}

/**
* Creates a new collection objects and reconstitutes the
* given database record to the new object.
*
* @param array $collectionRecord Database record
* @param bool $fillItems Populates the entries directly on load, might be bad for memory on large collections
* @return LanguageRestrictionCollection
*/
public static function create(array $collectionRecord, $fillItems = false): LanguageRestrictionCollection
{
/** @var LanguageRestrictionCollection $collection */
$collection = GeneralUtility::makeInstance(
self::class,
$collectionRecord['table_name'],
$collectionRecord['field_name']
);
$collection->fromArray($collectionRecord);
if ($fillItems) {
$collection->loadContents();
}
return $collection;
}

/**
* Populates the content-entries of the storage
* Queries the underlying storage for entries of the collection
* and adds them to the collection data.
* If the content entries of the storage had not been loaded on creation
* ($fillItems = false) this function is to be used for loading the contents
* afterwards.
*
* @throws DBALException|DBALDriverException
*/
public function loadContents()
{
Expand All @@ -144,96 +95,27 @@ public function loadContents()
}

/**
* Gets the collected records in this collection, by
* using <getCollectedRecordsQueryBuilder>.
* Gets the collected records in this collection
*
* @return array
* @throws \Doctrine\DBAL\DBALException
* @throws DBALException|DBALDriverException
*/
protected function getCollectedRecords(): array
{
$relatedRecords = [];

$queryBuilder = $this->getCollectedRecordsQueryBuilder();
$result = $queryBuilder->execute();

while ($record = $result->fetch()) {
$relatedRecords[] = $record;
}

return $relatedRecords;
}

/**
* Selects the collected records in this collection, by
* looking up the MM relations of this record to the
* table name defined in the local field 'table_name'.
*
* @return QueryBuilder
*/
protected function getCollectedRecordsQueryBuilder(): QueryBuilder
{
/** @var QueryBuilder $queryBuilder */
$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
->getQueryBuilderForTable(static::$storageTableName);
$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable(self::getCollectionDatabaseTable());
$queryBuilder->getRestrictions()->removeAll()->add(GeneralUtility::makeInstance(DeletedRestriction::class));

$queryBuilder->select($this->getItemTableName() . '.*')
->from(static::$storageTableName)
->join(
static::$storageTableName,
Constants::L10NMGR_LANGUAGE_RESTRICTION_MM_TABLENAME,
Constants::L10NMGR_LANGUAGE_RESTRICTION_MM_TABLENAME,
$queryBuilder->expr()->eq(
'sys_language_l10nmgr_language_restricted_record_mm.uid_local',
$queryBuilder->quoteIdentifier(static::$storageTableName . '.uid')
)
)
->join(
Constants::L10NMGR_LANGUAGE_RESTRICTION_MM_TABLENAME,
$this->getItemTableName(),
$this->getItemTableName(),
$queryBuilder->expr()->eq(
Constants::L10NMGR_LANGUAGE_RESTRICTION_MM_TABLENAME . '.uid_foreign',
$queryBuilder->quoteIdentifier($this->getItemTableName() . '.uid')
)
)
$result = $queryBuilder->select('*')
->from(self::getCollectionDatabaseTable())
->where(
$queryBuilder->expr()->eq(
static::$storageTableName . '.uid',
$queryBuilder->createNamedParameter($this->getIdentifier(), PDO::PARAM_INT)
),
$queryBuilder->expr()->eq(
Constants::L10NMGR_LANGUAGE_RESTRICTION_MM_TABLENAME . '.tablenames',
$queryBuilder->createNamedParameter($this->getItemTableName())
),
$queryBuilder->expr()->eq(
Constants::L10NMGR_LANGUAGE_RESTRICTION_MM_TABLENAME . '.fieldname',
$queryBuilder->createNamedParameter($this->getRelationFieldName())
$queryBuilder->expr()->inSet(
Constants::L10NMGR_LANGUAGE_RESTRICTION_FIELDNAME,
$queryBuilder->createNamedParameter($this->uid, PDO::PARAM_INT)
)
);
)->execute();

return $queryBuilder;
}

/**
* Gets the name of the language restrictions relation field
*
* @return string
*/
public function getRelationFieldName(): string
{
return $this->relationFieldName;
}

/**
* Sets the name of the language restrictions relation field
*
* @param string $field
*/
public function setRelationFieldName(string $field)
{
$this->relationFieldName = $field;
return $result->fetchAllAssociative();
}

/**
Expand All @@ -255,26 +137,6 @@ public function add($data)
$this->storage->push($data);
}

/**
* Getter for the storage table name
*
* @return string
*/
public static function getStorageTableName(): string
{
return self::$storageTableName;
}

/**
* Getter for the storage items field
*
* @return string
*/
public static function getStorageItemsField(): string
{
return self::$storageItemsField;
}

/**
* Adds a set of entries to the collection
*
Expand Down Expand Up @@ -350,4 +212,29 @@ protected function getPersistableDataArray(): array
'items' => $this->getItemUidList(),
];
}

/**
* @param int $pageId
* @return Site|NullSite
*/
protected static function getSiteByPageId(int $pageId)
{
try {
$site = GeneralUtility::makeInstance(SiteFinder::class)->getSiteByPageId($pageId);
} catch (SiteNotFoundException $exception) {
$site = new NullSite();
}

return $site;
}

protected static function getLanguage(int $pageId, $languageId): SiteLanguage
{
$site = self::getSiteByPageId($pageId);
if ($site instanceof Site) {
return $site->getLanguageById($languageId);
}

throw new \RuntimeException();
}
}
Loading