Create ListTermsTrait.php

Bugfixed version of Bulk Exporter v.3.4.15 file.

ListTermsTrait.php

@@ -0,0 +1,242 @@
+<?php declare(strict_types=1);
+
+namespace BulkExport\Traits;
+
+trait ListTermsTrait
+{
+    /**
+     * @var array
+     */
+    protected $propertiesByTerm;
+
+    /**
+     * @var array
+     */
+    protected $resourceClassesByTerm;
+
+    /**
+     * @var array
+     */
+    protected $propertyLabelsByTerm;
+
+    /**
+     * @var array
+     */
+    protected $resourceClassLabelsByTerm;
+
+    /**
+     * To be prepared ouside.
+     *
+     * @var \Laminas\Mvc\I18n\Translator
+     */
+    protected $translator;
+
+    /**
+     * @return array
+     */
+    protected function getPropertiesByTerm(): array
+    {
+        if ($this->propertiesByTerm) {
+            return $this->propertiesByTerm;
+        }
+
+        /** @var \Doctrine\DBAL\Connection $connection */
+        $connection = $this->getServiceLocator()->get('Omeka\Connection');
+        $qb = $connection->createQueryBuilder();
+        $qb
+            ->select(
+                "DISTINCT CONCAT(vocabulary.prefix, ':', property.local_name) AS term",
+                'property.id AS id',
+                // Only the two first selects are needed, but some databases
+                // require "order by" or "group by" value to be in the select.
+                'vocabulary.id'
+            )
+            ->from('property', 'property')
+            ->innerJoin('property', 'vocabulary', 'vocabulary', 'property.vocabulary_id = vocabulary.id')
+            ->orderBy('vocabulary.id', 'asc')
+            ->addOrderBy('property.id', 'asc')
+            ->addGroupBy('property.id')
+        ;
+        $terms = $connection->executeQuery($qb)->fetchAllKeyValue();
+        $this->propertiesByTerm = array_map('intval', $terms);
+        return $this->propertiesByTerm;
+    }
+
+    /**
+     * @return array
+     */
+    protected function getResourceClassesByTerm(): array
+    {
+        if ($this->resourceClassesByTerm) {
+            return $this->resourceClassesByTerm;
+        }
+
+        /** @var \Doctrine\DBAL\Connection $connection */
+        $connection = $this->getServiceLocator()->get('Omeka\Connection');
+        $qb = $connection->createQueryBuilder();
+        $qb
+            ->select(
+                "DISTINCT CONCAT(vocabulary.prefix, ':', resource_class.local_name) AS term",
+                'resource_class.id AS id',
+                // Only the two first selects are needed, but some databases
+                // require "order by" or "group by" value to be in the select.
+                'vocabulary.id'
+            )
+            ->from('resource_class', 'resource_class')
+            ->innerJoin('resource_class', 'vocabulary', 'vocabulary', 'resource_class.vocabulary_id = vocabulary.id')
+            ->orderBy('vocabulary.id', 'asc')
+            ->addOrderBy('resource_class.id', 'asc')
+            ->addGroupBy('resource_class.id')
+        ;
+        $terms = $connection->executeQuery($qb)->fetchAllKeyValue();
+        $this->resourceClassesByTerm = array_map('intval', $terms);
+        return $this->resourceClassesByTerm;
+    }
+
+    /**
+     * @todo Replace by an option to getPropertiesByTerm.
+     *
+     * @param array $options Associative array:
+     * - entity_classes (array): limit properties to entity classes.
+     * - min_size (int): property is removed if one value is smaller than it.
+     * - max_size (int): property is removed if one value is larger than it.
+     * @return array
+     */
+    protected function getUsedPropertiesByTerm(array $options = []): array
+    {
+        $options += [
+            'entity_classes' => [],
+            'min_size' => 0,
+            'max_size' => 0,
+        ];
+
+        /** @var \Doctrine\DBAL\Connection $connection */
+        $connection = $this->getServiceLocator()->get('Omeka\Connection');
+
+        // List only properties that are used.
+        // TODO Limit with the query (via adapter).
+        $qb = $connection->createQueryBuilder();
+        $expr = $qb->expr();
+        $qb
+            ->select(
+                "DISTINCT(CONCAT(vocabulary.prefix, ':', property.local_name)) AS term",
+                'property.id AS id',
+                // Only the two first selects are needed, but some databases
+                // require "order by" or "group by" value to be in the select.
+                'vocabulary.id'
+            )
+            ->from('value', 'value')
+            ->innerJoin('value', 'property', 'property', 'property.id = value.property_id')
+            ->innerJoin('property', 'vocabulary', 'vocabulary', 'vocabulary.id = property.vocabulary_id')
+            // Order by vocabulary and by property id, because Omeka orders them
+            // with Dublin Core first.
+            ->orderBy('vocabulary.id')
+            ->addOrderBy('property.id')
+        ;
+
+        $bind = [];
+        $types = [];
+        if (count($options['entity_classes']) && !in_array(\Omeka\Entity\Resource::class, $options['entity_classes'])) {
+            $qb
+                ->innerJoin('value', 'resource', 'resource', 'resource.id = value.resource_id')
+                ->andWhere($expr->in('resource.resource_type', ':entity_classes'))
+            ;
+            $bind['entity_classes'] = array_unique($options['entity_classes']);
+            $types['entity_classes'] = \Doctrine\DBAL\Connection::PARAM_STR_ARRAY;
+        }
+
+        if ((int) $options['min_size'] > 0) {
+            $qb
+                ->andWhere('CHAR_LENGTH(`value`.`value`) >= ' . (int) $options['min_size']);
+        }
+
+        if ((int) $options['max_size'] > 0) {
+            $qb
+                ->andWhere($expr->orX(
+                    '`value`.`value` IS NULL',
+                    'CHAR_LENGTH(`value`.`value`) <= ' . (int) $options['max_size']
+                ));
+        }
+
+        $terms = $connection->executeQuery($qb, $bind, $types)->fetchAllKeyValue();
+        return array_map('intval', $terms);
+    }
+
+    /**
+     * @return array
+     */
+    protected function getPropertyLabelsByTerm(): array
+    {
+        if ($this->propertyLabelsByTerm) {
+            return $this->propertyLabelsByTerm;
+        }
+
+        /** @var \Doctrine\DBAL\Connection $connection */
+        $connection = $this->getServiceLocator()->get('Omeka\Connection');
+        $qb = $connection->createQueryBuilder();
+        $qb
+            ->select(
+                "DISTINCT CONCAT(vocabulary.prefix, ':', property.local_name) AS term",
+                'property.label AS label',
+                // Only the two first selects are needed, but some databases
+                // require "order by" or "group by" value to be in the select.
+                'vocabulary.id',
+                'property.id'
+            )
+            ->from('property', 'property')
+            ->innerJoin('property', 'vocabulary', 'vocabulary', 'property.vocabulary_id = vocabulary.id')
+            ->orderBy('vocabulary.id', 'asc')
+            ->addOrderBy('property.id', 'asc')
+            ->addGroupBy('property.id')
+        ;
+        $this->propertyLabelsByTerm = $connection->executeQuery($qb)->fetchAllKeyValue();
+        return $this->propertyLabelsByTerm;
+    }
+
+    /**
+     * @return array
+     */
+    protected function getResourceClassLabelsByTerm(): array
+    {
+        if ($this->resourceClassLabelsByTerm) {
+            return $this->resourceClassLabelsByTerm;
+        }
+
+        /** @var \Doctrine\DBAL\Connection $connection */
+        $connection = $this->getServiceLocator()->get('Omeka\Connection');
+        $qb = $connection->createQueryBuilder();
+        $qb
+            ->select(
+                "DISTINCT CONCAT(vocabulary.prefix, ':', resource_class.local_name) AS term",
+                'resource_class.label AS label',
+                // Only the two first selects are needed, but some databases
+                // require "order by" or "group by" value to be in the select.
+                'vocabulary.id',
+                'resource_class.id'
+            )
+            ->from('resource_class', 'resource_class')
+            ->innerJoin('resource_class', 'vocabulary', 'vocabulary', 'resource_class.vocabulary_id = vocabulary.id')
+            ->orderBy('vocabulary.id', 'asc')
+            ->addOrderBy('resource_class.id', 'asc')
+            ->addGroupBy('resource_class.id')
+        ;
+        $this->resourceClassLabelsByTerm = $connection->executeQuery($qb)->fetchAllKeyValue();
+        return $this->resourceClassLabelsByTerm;
+    }
+
+    protected function translateProperty($property): string
+    {
+        $labels = $this->getPropertyLabelsByTerm();
+        return ucfirst(isset($labels[$property])
+            ? $this->translator->translate($labels[$property])
+            : $property);
+    }
+
+    protected function translateResourceClass($resourceClass): string
+    {
+        $labels = $this->getResourceClassLabelsByTerm();
+        return ucfirst(isset($labels[$resourceClass])
+            ? $this->translator->translate($labels[$resourceClass])
+            : $resourceClass);
+    }
+}