brandfolder-8.x-1.x-dev/src/Service/BrandfolderGatekeeper.php
src/Service/BrandfolderGatekeeper.php
<?php
namespace Drupal\brandfolder\Service;
use Brandfolder\BrandfolderClient;
use Drupal\brandfolder\Plugin\media\Source\BrandfolderImage;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\Logger\LoggerChannelFactoryInterface;
use Drupal\Core\StringTranslation\StringTranslationTrait;
use Drupal\Core\StringTranslation\TranslationInterface;
use Drupal\media\MediaSourceInterface;
use Drupal\Core\Field\FieldDefinitionInterface;
/**
* Helps determine which Brandfolder entities should be available in a given
* Drupal context.
*/
class BrandfolderGatekeeper {
use StringTranslationTrait;
/**
* Criteria for determining whether Brandfolder entities are valid.
*
* @var array
* Array with the following structure:
*
* ```php
*
* $criteria = [
* 'allowed' => [
* 'collection' => [
* 'abc123def456' => 'abc123def456',
* 'abc123def457' => 'abc123def457',
* ],
* 'label' => [
* 'lmn123lmn987' => 'lmn123lmn987',
* ],
* ],
* 'disallowed' => [
* 'collection' => [
* 'abc123def458' => 'abc123def458',
* ],
* 'section' => [
* 'xyz123abc100' => 'xyz123abc100',
* ],
* ],
* ];
*
* ```
*
* For an entity to be considered valid, it must match at least one of the
* criteria in *each* of the "allowed" criteria sets, and, additionally,
* must not match any of the "disallowed" criteria.
*
* @todo: Consider supporting more complex boolean logic. However, that may be better left to per-site alteration.
*/
protected $criteria = [];
/**
* The config factory service.
*
* @var \Drupal\Core\Config\ConfigFactoryInterface
*/
protected $configFactory;
/**
* Logger.
*
* @var \Drupal\Core\Logger\LoggerChannel
*/
protected $logger;
/**
* All Brandfolder entities for consideration.
*
* @var array
*/
protected $all_bf_entities;
/**
* Valid entities.
*
* @var array
*/
protected $valid_bf_entities;
/**
* Invalid entities.
*
* @var array
*/
protected $invalid_bf_entities;
/**
* Readable message pertaining to validation, etc.
*
* @var string
*/
protected $message;
/**
* Brandfolder API client.
*
* @var BrandfolderClient $bf_client
*/
protected $bf_client;
/**
* The default Brandfolder ID.
*
* @var string
*/
protected $default_brandfolder_id;
/**
* BrandfolderGatekeeper constructor.
*
* @param TranslationInterface $string_translation
* @param LoggerChannelFactoryInterface $logger_factory
* @param ConfigFactoryInterface $config_factory
* @param BrandfolderKeyService $key_service
*
* @throws \Exception
*/
public function __construct(TranslationInterface $string_translation, LoggerChannelFactoryInterface $logger_factory, ConfigFactoryInterface $config_factory, BrandfolderKeyService $key_service) {
$this->stringTranslation = $string_translation;
$this->logger = $logger_factory->get('brandfolder');
$this->configFactory = $config_factory;
$bf_config = $this->configFactory->get('brandfolder.settings');
$api_key = $key_service->getApiKey('admin');
$brandfolder_id = $bf_config->get('brandfolder_id');
if ($api_key && $brandfolder_id) {
$this->default_brandfolder_id = $brandfolder_id;
// @todo: Brandfolder as a service; DI, etc.
$this->bf_client = new BrandfolderClient($api_key, $brandfolder_id);
if ($bf_config->get('verbose_log_mode')) {
$this->bf_client->enableVerboseLogging();
}
}
else {
$msg = 'You must configure an API key and select a Brandfolder. Visit the Brandfolder configuration page (admin/config/media/brandfolder) or request assistance from an administrator.';
$this->logger->error($msg);
}
// Ensure any default baseline criteria are set (even though users of this
// service will typically use a load method that will overwrite/extend the
// defaults).
$this->setCriteria();
}
/**
* Instance creator.
*
* @param TranslationInterface $string_translation
* @param LoggerChannelFactoryInterface $logger_factory
* @param ConfigFactoryInterface $config_factory
* @param BrandfolderKeyService $key_service
*
* @return static
* Returns an instance of this service.
*
* @throws \Exception
*/
public function create(TranslationInterface $string_translation, LoggerChannelFactoryInterface $logger_factory, ConfigFactoryInterface $config_factory, BrandfolderKeyService $key_service): static {
return new static(
$string_translation,
$logger_factory,
$config_factory,
$key_service,
);
}
/**
* Load criteria defined on a media source, to be used when determining
* whether a given set of Brandfolder entities is valid.
*
* @param MediaSourceInterface $source
*/
public function loadFromMediaSource(MediaSourceInterface $source): void {
$criteria = [];
$source_config = $source->getConfiguration();
// @todo: Build on this.
if (!empty($source_config['brandfolder']['bf_entity_criteria'])) {
$criteria = $source_config['brandfolder']['bf_entity_criteria'];
}
// @todo: Expose this in config.
if ($source instanceof BrandfolderImage) {
$criteria['allowed']['filetype'] = [
'jpg',
'png',
'gif',
'tiff',
'svg',
'webp',
];
}
$this->setCriteria($criteria);
}
/**
* Load criteria associated with a Drupal field (e.g. an image or file field).
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
*/
public function loadFromFieldDefinition(FieldDefinitionInterface $field_definition): void {
$criteria = [];
if (method_exists($field_definition, 'getThirdPartySettings')) {
$bf_config = $field_definition->getThirdPartySettings('brandfolder');
if (!empty($bf_config['brandfolder_settings'])) {
$bf_settings_json = $bf_config['brandfolder_settings'];
$bf_settings = json_decode($bf_settings_json, TRUE);
$criteria = $bf_settings['bf_entity_criteria'] ?? [];
}
}
if (method_exists($field_definition, 'getSettings')) {
$field_settings = $field_definition->getSettings();
if (!empty($field_settings['file_extensions'])) {
$extensions_array_raw = explode(' ', $field_settings['file_extensions']);
$trimmed = array_map('trim', $extensions_array_raw);
$criteria['allowed']['filetype'] = $trimmed;
}
$other_settings = [
'min_resolution',
'max_resolution',
];
foreach ($other_settings as $key) {
if (!empty($field_settings[$key])) {
$criteria[$key] = $field_settings[$key];
}
}
}
$this->setCriteria($criteria);
}
/**
* Load criteria from an Entity Browser validators array.
*/
public function loadFromEntityBrowserFileValidators(array $validators): void {
$criteria = [];
if (!empty($validators['file_validate_extensions'][0])) {
$extensions_array_raw = explode(' ', $validators['file_validate_extensions'][0]);
$trimmed = array_map('trim', $extensions_array_raw);
$criteria['allowed']['filetype'] = $trimmed;
}
if (!empty($validators['entity_browser_file_validate_image_resolution'])) {
[$max_resolution, $min_resolution] = $validators['entity_browser_file_validate_image_resolution'];
if (!empty($max_resolution)) {
$criteria['max_resolution'] = $max_resolution;
}
if (!empty($min_resolution)) {
$criteria['min_resolution'] = $min_resolution;
}
}
$this->setCriteria($criteria);
}
/**
* Process a set of Brandfolder entities and see if they are allowed by the
* relevant Drupal configuration/rules.
*
* @param array $bf_entities
* An array with keys corresponding to Brandfolder entity types.
* Current supported keys are "assets" and "attachments." Array values are
* arrays of Brandfolder entity IDs/keys for each type.
*
* @return bool
*
* @todo: Determine whether this validation is really necessary. If so, review uses and look at appropriate user-facing messaging on validation failure.
*/
public function validateBrandfolderEntities(array $bf_entities) {
$this->all_bf_entities = $bf_entities;
$this->invalid_bf_entities = $this->valid_bf_entities = [];
$processing_queue = [];
$api_params = [
'include' => 'collections,section,labels',
// @todo: Consider allowing configuration/rules/restrictions based on tags, at which point we'd need to figure out whether to work with fields:tag_names or relationships:tags, which do not seem to match each other for most attachments returned from API presently. Tag names are probably preferable in order to match user expectations given the fact that multiple tags can exist with the same name, etc.
// 'fields' => 'tag_names'
];
$type_ops = [
'assets' => 'fetchAsset',
'attachments' => 'fetchAttachment',
];
foreach ($type_ops as $bf_entity_type => $fetch_method) {
if (!empty($bf_entities[$bf_entity_type])) {
// @todo: Fetch multiple assets/attachments by ID in a single call now that Brandfolder supports it.
foreach ($bf_entities[$bf_entity_type] as $bf_entity_id) {
if ($bf_entity = $this->bf_client->{$fetch_method}($bf_entity_id, $api_params)) {
$bf_entity_data_for_validation = [
'collection' => isset($bf_entity->included['collections']) ? array_keys($bf_entity->included['collections']) : [],
'section' => isset($bf_entity->included['sections']) ? array_keys($bf_entity->included['sections']) : [],
'label' => isset($bf_entity->included['labels']) ? array_keys($bf_entity->included['labels']) : [],
];
$processing_queue[$bf_entity_type][$bf_entity_id] = $bf_entity_data_for_validation;
}
else {
$this->invalid_bf_entities[$bf_entity_type][$bf_entity_id] = $bf_entity_id;
}
}
}
}
$all_criteria = $this->getCriteria();
// Check each remaining entity against all specified criteria.
foreach ($processing_queue as $bf_entity_type => $bf_entities) {
foreach ($bf_entities as $bf_entity_id => $bf_entity_data) {
$bf_entity_is_valid = TRUE;
foreach ($all_criteria['allowed'] as $criteria_family => $criteria) {
// Check all criteria families except filetype.
// @todo: Consider file type/extension validation here.
if (!empty($criteria) && $criteria_family != 'filetype') {
$qualifying_attributes = array_intersect($criteria, $bf_entity_data[$criteria_family]);
if (count($qualifying_attributes) == 0) {
$this->invalid_bf_entities[$bf_entity_type][$bf_entity_id] = $bf_entity_id;
$bf_entity_is_valid = FALSE;
break;
}
}
}
if ($bf_entity_is_valid) {
foreach ($all_criteria['disallowed'] as $criteria_family => $criteria) {
if (!empty($criteria)) {
$disqualifying_attributes = array_intersect($criteria, $bf_entity_data[$criteria_family]);
if (count($disqualifying_attributes) > 0) {
$this->invalid_bf_entities[$bf_entity_type][$bf_entity_id] = $bf_entity_id;
break;
}
}
}
}
}
}
$bf_entities_are_valid = empty($this->invalid_bf_entities);
// Set validation message.
if ($bf_entities_are_valid) {
$this->message = t('All Brandfolder entities are valid.');
}
else {
$messages = [];
foreach ($this->invalid_bf_entities as $bf_entity_type => $entity_ids) {
$messages[] = $this->t('The following @type are invalid: ', ['@type' => $bf_entity_type]) . implode('|', $entity_ids);
}
$this->message = implode('. ', $messages) . '.';
}
$bf_config = $this->configFactory->get('brandfolder.settings');
if ($bf_config->get('verbose_log_mode')) {
foreach ($this->bf_client->getLogData() as $log_entry) {
$this->logger->debug($log_entry);
}
$this->bf_client->clearLogData();
}
return $bf_entities_are_valid;
}
/**
* Fetch assets from Brandfolder that comply with this gatekeeper's criteria.
*
* @param array $query_params
*
* @return mixed
*/
public function fetchAssets(array $query_params = []) {
$default_params = [
'per' => 100,
'page' => 1,
'fields' => 'cdn_url,availability',
];
$query_params = array_merge($default_params, $query_params);
$search_components = !empty($query_params['search']) ? [$query_params['search']] : [];
// Expanded format is currently unnecessary here (see label-specific logic
// below). Revisit when adding new criteria/config options.
$all_criteria = $this->getCriteria(FALSE);
$boolean_criteria = [
'approved',
'expired',
'unpublished',
];
foreach ($boolean_criteria as $criterion) {
if (isset($all_criteria[$criterion])) {
$search_components[] = $criterion . ':' . ($all_criteria[$criterion] ? 'true' : 'false');
}
}
$key_based_criteria = [
'collection',
'section',
];
foreach ($key_based_criteria as $criterion) {
if (!empty($all_criteria['allowed'][$criterion])) {
$criteria = $all_criteria['allowed'][$criterion];
array_walk($criteria, function (&$item) {
$item = "\"$item\"";
});
$search_components[] = "{$criterion}_key:(" . implode(' OR ', $criteria) . ')';
}
if (!empty($all_criteria['disallowed'][$criterion])) {
$criteria = $all_criteria['disallowed'][$criterion];
array_walk($criteria, function (&$item) {
$item = "\"$item\"";
});
$search_components[] = "NOT {$criterion}_key:(" . implode(' OR ', $criteria) . ')';
}
}
// Labels.
// Note: remember that assets in Brandfolder can belong to multiple labels.
// Note: Brandfolder only supports label searches by human-readable
// name, rather than by key/ID, so we need to map the ID/key-based criteria
// to the corresponding names.
// @todo: Update if/when Brandfolder adds support for key-based search.
// Get all labels that are explicitly allowed, if any, minus any that are
// also disallowed (there is no sense including those in this part of the
// query).
$allowed_labels = $this->getLabels('list', 'difference');
if (!empty($allowed_labels)) {
$quoted_label_names = array_map(function ($label) {
return '"' . $label->attributes->name . '"';
}, $allowed_labels);
$search_components[] = "label:(" . implode(' OR ', $quoted_label_names) . ')';
}
// Get only those labels that are explicitly disallowed, if any.
$disallowed_labels = $this->getLabels('list', 'disallowed_only');
if (!empty($disallowed_labels)) {
$quoted_label_names = array_map(function ($label) {
return '"' . $label->attributes->name . '"';
}, $disallowed_labels);
$search_components[] = "NOT label:(" . implode(' OR ', $quoted_label_names) . ')';
}
if (!empty($all_criteria['allowed']['filetype'])) {
$extension_list = $all_criteria['allowed']['filetype'];
array_walk($extension_list, function (&$criterion) {
$criterion = "\"$criterion\"";
});
$search_components[] = "filetype:(" . implode(' OR ', $extension_list) . ')';
}
// Min and max resolution.
// @todo: Consider streamlining/refactoring this, depending on whether we introduce user-facing resolution filters, etc.
if (!empty($all_criteria['min_resolution'])) {
$width_and_height = explode('x', $all_criteria['min_resolution']);
if (count($width_and_height) == 2) {
[$min_width, $min_height] = $width_and_height;
if ($min_width) {
$search_components[] = 'width:>=' . $min_width;
}
if ($min_height) {
$search_components[] = 'height:>=' . $min_height;
}
}
}
if (!empty($all_criteria['max_resolution'])) {
$width_and_height = explode('x', $all_criteria['max_resolution']);
if (count($width_and_height) == 2) {
[$max_width, $max_height] = $width_and_height;
if ($max_width) {
$search_components[] = 'width:<=' . $max_width;
}
if ($max_height) {
$search_components[] = 'height:<=' . $max_height;
}
}
}
array_walk($search_components, function(&$component) {
$component = "($component)";
});
$query_params['search'] = implode(' AND ', $search_components);
$assets = $this->bf_client->listAssets($query_params, 'all');
$bf_config = $this->configFactory->get('brandfolder.settings');
if ($bf_config->get('verbose_log_mode')) {
foreach ($this->bf_client->getLogData() as $log_entry) {
$this->logger->debug($log_entry);
}
$this->bf_client->clearLogData();
}
return $assets;
}
/**
* Fetch one or more attachments by ID. The given attachments will be returned
* as long as they exist in the Brandfolder associated with this Gatekeeper.
* No other validation will be performed.
*/
public function fetchAttachmentsById(array $attachment_ids, array $query_params = []) {
$default_params = [
'per' => 100,
'page' => 1,
'fields' => 'cdn_url',
'include' => 'asset',
];
$query_params = array_merge($default_params, $query_params);
$quoted_attachment_ids = array_map(function ($id) {
return "\"$id\"";
}, $attachment_ids);
$search_query_components[] = 'attachment_key:(' . implode(' OR ', $quoted_attachment_ids) . ')';
// Assemble the search query string (this pattern makes it easy for us to
// add more query components later as needed).
if (!empty($search_query_components)) {
array_walk($search_query_components, function(&$subquery) {
$subquery = "($subquery)";
});
$query_params['search'] = implode(' AND ', $search_query_components);
}
$result = $this->bf_client->listAttachmentsForBrandfolder($this->default_brandfolder_id, $query_params);
$bf_config = $this->configFactory->get('brandfolder.settings');
if ($bf_config->get('verbose_log_mode')) {
foreach ($this->bf_client->getLogData() as $log_entry) {
$this->logger->debug($log_entry);
}
$this->bf_client->clearLogData();
}
return $result;
}
/**
* Get a list of all valid collections.
*
* @return array
* An array keyed by collection ID whose values are collection names.
*/
public function getCollections(): array {
// Start with all collections in the Brandfolder.
$collections = $this->bf_client->getCollectionsInBrandfolder();
$bf_config = $this->configFactory->get('brandfolder.settings');
if ($bf_config->get('verbose_log_mode')) {
foreach ($this->bf_client->getLogData() as $log_entry) {
$this->logger->debug($log_entry);
}
$this->bf_client->clearLogData();
}
// Return empty array if no collections exist or some error has occurred.
if (empty($collections)) {
return [];
}
// Change $should_expand to TRUE once we support nested collections.
// Also consider only retrieving collection criteria rather than all
// criteria.
$all_criteria = $this->getCriteria(FALSE);
// Reduce the list per allowed/disallowed collection criteria, as
// applicable.
if (!empty($all_criteria['allowed']['collection'])) {
$collections = array_intersect_key($collections, $all_criteria['allowed']['collection']);
}
if (!empty($all_criteria['disallowed']['collection'])) {
$collections = array_diff_key($collections, $all_criteria['disallowed']['collection']);
}
return $collections;
}
/**
* Get a list of all valid sections.
*
* @return array
* An array keyed by section ID whose values are section names.
*/
public function getSections(): array {
// Start with all sections in the Brandfolder.
$sections = $this->bf_client->listAllSectionNamesInBrandfolder();
// Return empty array if no sections exist or some error has occurred.
if (empty($sections)) {
return [];
}
// Reduce the list per allowed/disallowed section criteria, as
// applicable.
if (!empty($this->criteria['allowed']['section'])) {
$sections = array_intersect_key($sections, $this->criteria['allowed']['section']);
}
if (!empty($this->criteria['disallowed']['section'])) {
$sections = array_diff_key($sections, $this->criteria['disallowed']['section']);
}
return $sections;
}
/**
* Get a (potentially multidimensional) array containing all valid labels,
* or a forcibly-flattened version thereof.
*
* @param string $format If "tree" (default), return a multi-dimensional
* array representing item hierarchy. If "list", return a flattened array.
*
* @param string $result_set If "all" (default), return all *eligible* labels.
* If "difference", return only those labels that are explicitly allowed (if
* any) minus any that are explicitly disallowed. If "allowed_only", return
* only those labels that are explicitly allowed. If "disallowed_only",
* return only those labels that are explicitly disallowed.
*
* @return array
* If $format is "tree" (default), an array keyed by label ID whose values
* are objects representing nodes in the label tree. There is no root node.
* Each node has a "label" property containing an object filled with label
* attributes, and a "children" property containing an array of child label
* nodes, if any exist.
* If $format is "list," a flat array keyed by label ID whose values are
* objects filled with label properties.
*/
public function getLabels(string $format = 'tree', string $result_set = 'all'): array {
// Start with all labels in the Brandfolder.
// @todo: Cache this so we only need one of these calls per gatekeeper instance.
$labels = $this->bf_client->listLabelsInBrandfolder();
// Return empty array if no labels exist or some error has occurred.
if (empty($labels)) {
return [];
}
// Reduce the list per allowed/disallowed label criteria, as
// applicable.
// Note: The current logic is for selected labels to also include any of
// their nested, descendant labels. Users should be able to achieve most
// desired outcomes by using a combination of allowed and disallowed
// labels.
$allowed_label_ids = $this->criteria['allowed']['label'] ?? [];
$disallowed_label_ids = $this->criteria['disallowed']['label'] ?? [];
$ids_to_include = [];
$ids_to_exclude = [];
switch ($result_set) {
case 'all':
default:
$ids_to_include = $allowed_label_ids;
$ids_to_exclude = $disallowed_label_ids;
break;
case 'difference':
if (empty($allowed_label_ids)) {
return [];
}
$ids_to_include = $allowed_label_ids;
$ids_to_exclude = $disallowed_label_ids;
break;
case 'allowed_only':
if (empty($allowed_label_ids)) {
return [];
}
$ids_to_include = $allowed_label_ids;
break;
case 'disallowed_only':
if (empty($disallowed_label_ids)) {
return [];
}
$ids_to_include = $disallowed_label_ids;
break;
}
if ($format === 'list') {
$flat_list = [];
$this->pruneTree($labels, 'label', $ids_to_include, $ids_to_exclude, $flat_list);
return $flat_list;
}
else {
$this->pruneTree($labels, 'label', $ids_to_include, $ids_to_exclude);
}
return $labels;
}
/**
* Prune a tree of hierarchical Brandfolder entities
* (e.g. labels, maybe collections, etc.) to only include allowed items and
* their descendants, and to exclude any disallowed items and their
* descendants. Also provide a flattened list of the surviving items if
* desired.
*
* @param array $tree
* @param string $item_type The name of the key in each node that contains the
* data item (e.g. 'label' or 'collection').
* @param array|NULL $ids_to_include
* @param array|NULL $ids_to_exclude
* @param array|NULL $flattened_list An array to be populated with a
* flattened list of all surviving items from the tree.
*
* @return void
*/
protected function pruneTree(array &$tree, string $item_type, array $ids_to_include = NULL, array $ids_to_exclude = NULL, array &$flattened_list = NULL) {
// If our only objective is to prune the tree (not flatten it), and there
// are no whitelisted/blacklisted IDs, then there's nothing to do.
if (is_null($flattened_list) && empty($ids_to_include) && empty($ids_to_exclude)) {
return;
}
foreach ($tree as $id => &$node) {
$should_item_remain = TRUE;
$item = NULL;
if (isset($node->{$item_type})) {
$item = $node->{$item_type};
$item_lineage = $item->attributes->path ?? [];
if (!empty($ids_to_include)) {
// Note: lineage would include the item's own ID, but we still check
// it explicitly so this will work more broadly (for items that may not
// have a path attribute).
$should_item_remain = in_array($id, $ids_to_include) || count(array_intersect($item_lineage, $ids_to_include));
}
if ($should_item_remain && !empty($ids_to_exclude)) {
$should_item_remain = !in_array($id, $ids_to_exclude) && !count(array_intersect($item_lineage, $ids_to_exclude));
}
}
if ($item && $should_item_remain) {
if (!is_null($flattened_list)) {
$flattened_list[$id] = $item;
}
if (!empty($node->children)) {
$this->pruneTree($node->children, $item_type, $ids_to_include, $ids_to_exclude, $flattened_list);
}
}
else {
unset($tree[$id]);
}
}
}
/**
* Retrieve the most recent human-readable message pertaining to validation,
* etc.
*
* @return string
*/
public function getMessage() {
return $this->message ?? '';
}
/**
* Retrieve and process the criteria for eligible Brandfolder entities.
*
* @param bool $should_expand Whether to expand the basic criteria to include
* inferred/calculated criteria (e.g. to include nested items whose parents
* are listed in the basic criteria).
*
* @return array
*
* @see $this->criteria
*
* @todo: Consider adding params to specify more limited criteria to return - e.g. $type ['all', 'label', 'collection', ...].
*/
public function getCriteria($should_expand = TRUE) {
$criteria = $this->criteria ?? [];
if ($should_expand) {
// Expand labels lists to include all descendants of the specified labels.
if (!empty($criteria['allowed']['label'])) {
$all_labels = $this->getLabels('list', 'allowed_only');
$criteria['allowed']['label'] = array_keys($all_labels);
}
if (!empty($criteria['disallowed']['label'])) {
$all_labels = $this->getLabels('list', 'disallowed_only');
$criteria['disallowed']['label'] = array_keys($all_labels);
}
}
return $criteria;
}
/**
* Set criteria.
*
* @param array $criteria
*/
public function setCriteria(array $criteria = []) {
// Default baseline criteria.
// @todo: Consider whether it makes sense to expose this to Drupal config.
$defaults = [
'approved' => true,
'expired' => false,
'unpublished' => false,
];
$criteria = array_merge($defaults, $criteria);
$this->criteria = $criteria;
}
/**
* Get the allowed file types for Brandfolder entities.
*
* @return array
*/
public function getAllowedFiletypes(): array {
return $this->criteria['allowed']['filetype'] ?? [];
}
/**
* Set allowed file types for Brandfolder entities.
*
* @param array $filetypes
*
* @return void
*/
public function setAllowedFiletypes(array $filetypes): void {
if (empty($filetypes)) {
$this->criteria['allowed']['filetype'] = [];
}
else {
$this->criteria['allowed']['filetype'] = array_map('trim', $filetypes);
}
}
/**
* Add elements to a form array to support configuring Brandfolder entity
* rules.
*
* @param array $form
*/
public function buildConfigForm(&$form) {
// @todo: Additional config such as allowed tags, sub-collection differentiation, etc.
$collections_list = $this->bf_client->getCollectionsInBrandfolder();
$sections_list = $this->bf_client->listAllSectionNamesInBrandfolder();
$labels = $this->bf_client->listLabelsInBrandfolder();
$label_options = [];
brandfolder_build_labels_select_list($labels, $label_options);
$form['brandfolder'] = [
'#type' => 'fieldset',
'#title' => 'Brandfolder',
];
$form['brandfolder']['bf_entity_criteria'] = [
'#type' => 'fieldset',
'#title' => $this->t('@brandfolder Entity Criteria', ['@brandfolder' => 'Brandfolder']),
'#description' => $this->t('Control which @brandfolder entities can be used.', ['@brandfolder' => 'Brandfolder']),
];
$form['brandfolder']['bf_entity_criteria']['allowed'] = [
'#type' => 'fieldset',
'#title' => $this->t('Allowed'),
'#description' => $this->t('Only allow @brandfolder entities that meet *all* of these criteria.', ['@brandfolder' => 'Brandfolder']),
];
$form['brandfolder']['bf_entity_criteria']['allowed']['collection'] = [
'#type' => 'select',
'#title' => $this->t('Collections'),
'#options' => $collections_list,
'#multiple' => TRUE,
'#default_value' => $this->criteria['allowed']['collection'] ?? [],
];
$form['brandfolder']['bf_entity_criteria']['allowed']['section'] = [
'#type' => 'select',
'#title' => $this->t('Sections'),
'#options' => $sections_list,
'#multiple' => TRUE,
'#default_value' => $this->criteria['allowed']['section'] ?? [],
];
$form['brandfolder']['bf_entity_criteria']['allowed']['label'] = [
'#type' => 'select',
'#title' => $this->t('Labels'),
'#options' => $label_options,
'#multiple' => TRUE,
'#default_value' => $this->criteria['allowed']['label'] ?? [],
];
$form['brandfolder']['bf_entity_criteria']['disallowed'] = [
'#type' => 'fieldset',
'#title' => $this->t('Disallowed'),
'#description' => $this->t('Do not allow @brandfolder entities that meet *any* of these criteria.', ['@brandfolder' => 'Brandfolder']),
];
$form['brandfolder']['bf_entity_criteria']['disallowed']['collection'] = [
'#type' => 'select',
'#title' => $this->t('Collections'),
'#options' => $collections_list,
'#multiple' => TRUE,
'#default_value' => $this->criteria['disallowed']['collection'] ?? [],
];
$form['brandfolder']['bf_entity_criteria']['disallowed']['section'] = [
'#type' => 'select',
'#title' => $this->t('Sections'),
'#options' => $sections_list,
'#multiple' => TRUE,
'#default_value' => $this->criteria['disallowed']['section'] ?? [],
];
$form['brandfolder']['bf_entity_criteria']['disallowed']['label'] = [
'#type' => 'select',
'#title' => $this->t('Labels'),
'#options' => $label_options,
'#multiple' => TRUE,
'#default_value' => $this->criteria['disallowed']['label'] ?? [],
];
}
// public function configFormValidate(array $form, \Drupal\Core\Form\FormStateInterface $form_state) {
//
// }
// public function configFormSubmit(array $form, \Drupal\Core\Form\FormStateInterface $form_state) {
// }
}
