class Acquiadam in Media: Acquia DAM 8
Same name in this branch
- 8 src/Acquiadam.php \Drupal\media_acquiadam\Acquiadam
- 8 src/Plugin/EntityBrowser/Widget/Acquiadam.php \Drupal\media_acquiadam\Plugin\EntityBrowser\Widget\Acquiadam
Uses a view to provide entity listing in a browser's widget.
Plugin annotation
@EntityBrowserWidget(
id = "acquiadam",
label = @Translation("Acquia DAM"),
description = @Translation("Acquia DAM asset browser"),
auto_select = FALSE
)
Hierarchy
- class \Drupal\media_acquiadam\Plugin\EntityBrowser\Widget\Acquiadam extends \Drupal\entity_browser\WidgetBase
Expanded class hierarchy of Acquiadam
File
- src/
Plugin/ EntityBrowser/ Widget/ Acquiadam.php, line 37
Namespace
Drupal\media_acquiadam\Plugin\EntityBrowser\WidgetView source
class Acquiadam extends WidgetBase {
/**
* The dam interface.
*
* @var \Drupal\media_acquiadam\AcquiadamInterface
*/
protected $acquiadam;
/**
* The current user account.
*
* @var \Drupal\Core\Session\AccountInterface
*/
protected $user;
/**
* The current user account.
*
* @var \Drupal\Core\Language\LanguageManagerInterface
*/
protected $languageManager;
/**
* A module handler object.
*
* @var \Drupal\Core\Extension\ModuleHandlerInterface
*/
protected $moduleHandler;
/**
* A media source manager.
*
* @var \Drupal\media\MediaSourceManager
*/
protected $sourceManager;
/**
* An entity field manager.
*
* @var \Drupal\Core\Entity\EntityFieldManagerInterface
*/
protected $entityFieldManager;
/**
* User data manager.
*
* @var \Drupal\user\UserDataInterface
*/
protected $userData;
/**
* Drupal RequestStack service.
*
* @var \Symfony\Component\HttpFoundation\RequestStack
*/
protected $requestStack;
/**
* Acquiadam constructor.
*
* {@inheritdoc}
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, EventDispatcherInterface $event_dispatcher, EntityTypeManagerInterface $entity_type_manager, EntityFieldManagerInterface $entity_field_manager, WidgetValidationManager $validation_manager, AcquiadamInterface $acquiadam, AccountInterface $account, LanguageManagerInterface $languageManager, ModuleHandlerInterface $moduleHandler, MediaSourceManager $sourceManager, UserDataInterface $userData, RequestStack $requestStack, ConfigFactoryInterface $config) {
parent::__construct($configuration, $plugin_id, $plugin_definition, $event_dispatcher, $entity_type_manager, $validation_manager);
$this->acquiadam = $acquiadam;
$this->user = $account;
$this->languageManager = $languageManager;
$this->moduleHandler = $moduleHandler;
$this->sourceManager = $sourceManager;
$this->entityFieldManager = $entity_field_manager;
$this->userData = $userData;
$this->requestStack = $requestStack;
$this->config = $config;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container
->get('event_dispatcher'), $container
->get('entity_type.manager'), $container
->get('entity_field.manager'), $container
->get('plugin.manager.entity_browser.widget_validation'), $container
->get('media_acquiadam.acquiadam_user_creds'), $container
->get('current_user'), $container
->get('language_manager'), $container
->get('module_handler'), $container
->get('plugin.manager.media.source'), $container
->get('user.data'), $container
->get('request_stack'), $container
->get('config.factory'));
}
/**
* {@inheritdoc}
*
* @todo Add more settings for configuring this widget.
*/
public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
$form = parent::buildConfigurationForm($form, $form_state);
$media_type_options = [];
$media_types = $this->entityTypeManager
->getStorage('media_type')
->loadByProperties([
'source' => 'acquiadam_asset',
]);
foreach ($media_types as $media_type) {
$media_type_options[$media_type
->id()] = $media_type
->label();
}
if (empty($media_type_options)) {
$url = Url::fromRoute('entity.media_type.add_form')
->toString();
$form['media_type'] = [
'#markup' => $this
->t("You don't have media type of the Acquia DAM asset type. You should <a href='!link'>create one</a>", [
'!link' => $url,
]),
];
}
else {
$form['media_type'] = [
'#type' => 'select',
'#title' => $this
->t('Media type'),
'#default_value' => $this->configuration['media_type'],
'#options' => $media_type_options,
];
}
return $form;
}
/**
* {@inheritdoc}
*/
public function defaultConfiguration() {
return [
'media_type' => NULL,
'submit_text' => $this
->t('Select assets'),
] + parent::defaultConfiguration();
}
/**
* {@inheritdoc}
*/
public function getForm(array &$original_form, FormStateInterface $form_state, array $additional_widget_parameters) {
$config = $this->config
->get('media_acquiadam.settings');
$media_type_storage = $this->entityTypeManager
->getStorage('media_type');
/** @var \Drupal\media\MediaTypeInterface $media_type */
if (!$this->configuration['media_type'] || !($media_type = $media_type_storage
->load($this->configuration['media_type']))) {
return [
'#markup' => $this
->t('The media type is not configured correctly.'),
];
}
elseif ($media_type
->getSource()
->getPluginId() != 'acquiadam_asset') {
return [
'#markup' => $this
->t('The configured media type is not using the acquiadam_asset plugin.'),
];
}
elseif ($this
->uuid() != $form_state
->getStorage()['entity_browser_current_widget']) {
// Return an empty array.
return [];
}
$auth = $this->acquiadam
->getAuthState();
if (empty($auth['valid_token'])) {
try {
$auth = $this->acquiadam
->checkAuth();
if (!empty($auth['valid_token'])) {
$this->userData
->set('media_acquiadam', $this->user
->id(), 'acquiadam_access_token', $auth['access_token']);
$this->userData
->set('media_acquiadam', $this->user
->id(), 'acquiadam_access_token_expiration', $auth['access_token_expiry']);
$this->userData
->set('media_acquiadam', $this->user
->id(), 'acquiadam_refresh_token', $auth['refresh_token']);
}
} catch (InvalidCredentialsException $x) {
$message = '';
if ($config
->get('samesite_cookie_disable') || $this->requestStack
->getCurrentRequest()
->getScheme() == "http") {
$message = $this
->t("You are not authenticated. %authenticate first, then re-open this modal to browse Acquia DAM assets..", [
'%authenticate' => Link::createFromRoute('authenticate', 'media_acquiadam.auth_start', [], [
'attributes' => [
'target' => '_blank',
],
])
->toString(),
]);
}
else {
$message = $this
->t('You are not authenticated. Please %authenticate to browse Acquia DAM assets.', [
'%authenticate' => Link::createFromRoute('authenticate', 'media_acquiadam.auth_start', [
'auth_finish_redirect' => $this->requestStack
->getCurrentRequest()
->getRequestUri(),
])
->toString(),
]);
}
$form['message'] = [
'#theme' => 'asset_browser_message',
'#message' => $message,
'#attached' => [
'library' => [
'media_acquiadam/asset_browser',
],
],
];
return $form;
}
}
// Start by inheriting parent form.
$form = parent::getForm($original_form, $form_state, $additional_widget_parameters);
// Attach the modal library.
$form['#attached']['library'][] = 'core/drupal.dialog.ajax';
// This form is submitted and rebuilt when a folder is clicked.
// The triggering element identifies which folder button was clicked.
$trigger_elem = $form_state
->getTriggeringElement();
// Initialize current_folder.
$current_folder = new Folder();
// Default current folder id to zero which represents the root folder.
$current_folder->id = 0;
// Default current folder parent id to zero which represents root folder.
$current_folder->parent = 0;
// Default current folder name to 'Home' which represents the root folder.
$current_folder->name = 'Home';
// Default current page to first page.
$page = 0;
// Number of assets to show per page.
$num_per_page = $config
->get('num_images_per_page') ?? AcquiadamConfig::NUM_IMAGES_PER_PAGE;
// Initial breadcrumb array representing the root folder only.
$breadcrumbs = [
'0' => 'Home',
];
// If the form state contains the widget AND the reset button hadn't been
// clicked then pull values for the current form state.
if (isset($form_state
->getCompleteForm()['widget']) && isset($trigger_elem) && $trigger_elem['#name'] != 'filter_sort_reset') {
// Assign $widget for convenience.
$widget = $form_state
->getCompleteForm()['widget'];
if (isset($widget['pager-container']) && is_numeric($widget['pager-container']['#page'])) {
// Set the page number to the value stored in the form state.
$page = intval($widget['pager-container']['#page']);
}
if (isset($widget['asset-container']) && is_numeric($widget['asset-container']['#acquiadam_folder_id'])) {
// Set current folder id to the value stored in the form state.
$current_folder->id = $widget['asset-container']['#acquiadam_folder_id'];
}
if (isset($widget['breadcrumb-container']) && is_array($widget['breadcrumb-container']['#breadcrumbs'])) {
// Set the breadcrumbs to the value stored in the form state.
$breadcrumbs = $widget['breadcrumb-container']['#breadcrumbs'];
}
if ($form_state
->getValue('assets')) {
$current_selections = $form_state
->getValue('current_selections', []) + array_filter($form_state
->getValue('assets', []));
$form['current_selections'] = [
'#type' => 'value',
'#value' => $current_selections,
];
}
}
// If the form has been submitted.
if (isset($trigger_elem)) {
// If a folder button has been clicked.
if ($trigger_elem['#name'] == 'acquiadam_folder') {
// Set the current folder id to the id of the folder that was clicked.
$current_folder->id = intval($trigger_elem['#acquiadam_folder_id']);
// Reset page to zero if we have navigated to a new folder.
$page = 0;
}
// If a pager button has been clicked.
if ($trigger_elem['#name'] == 'acquiadam_pager') {
// Set the current folder id to the id of the folder that was clicked.
$page = intval($trigger_elem['#acquiadam_page']);
}
// If the filter/sort submit button has been clicked.
if ($trigger_elem['#name'] == 'filter_sort_submit') {
// Reset page to zero.
$page = 0;
}
// If the reset submit button has been clicked.
if ($trigger_elem['#name'] == 'filter_sort_reset') {
// Fetch the user input.
$user_input = $form_state
->getUserInput();
// Fetch clean values keys (system related, not user input).
$clean_val_key = $form_state
->getCleanValueKeys();
// Loop through user inputs.
foreach ($user_input as $key => $item) {
// Unset only the User Input values.
if (!in_array($key, $clean_val_key)) {
unset($user_input[$key]);
}
}
// Reset the user input.
$form_state
->setUserInput($user_input);
// Set values to user input.
$form_state
->setValues($user_input);
// Rebuild the form state values.
$form_state
->setRebuild();
// Get back to first page.
$page = 0;
}
}
// Offset used for pager.
$offset = $num_per_page * $page;
// Parameters for searching, sorting, and filtering.
$params = [
'limit' => $num_per_page,
'offset' => $offset,
'sortby' => $form_state
->getValue('sortby'),
'sortdir' => $form_state
->getValue('sortdir'),
'types' => $form_state
->getValue('types'),
'query' => $form_state
->getValue('query'),
'folderid' => $current_folder->id,
];
// If the current folder is not zero then fetch information about
// the sub folder being rendered.
if ($current_folder->id) {
// Fetch the folder object.
$current_folder = $this->acquiadam
->getFolder($current_folder->id);
// Store the list of folders for rendering later.
$folders = $current_folder->folders;
// Fetch a list of assets for the folder.
$folder_assets = $this->acquiadam
->getFolderAssets($current_folder->id, $params);
// We need to override this because getFolder only counts active assets.
$current_folder->numassets = $folder_assets->total_count;
// If there is a filter applied for the file type.
if (!empty($params['types'])) {
// Override number of assets on current folder to make number of search
// results so pager works correctly.
$current_folder->numassets = $folder_assets->facets->types->{$params['types']};
}
// Set items to array of assets in the current folder.
$items = $folder_assets->items;
}
else {
// The root folder is fetched differently because it can only
// contain subfolders (not assets)
$folders = $this->acquiadam
->getTopLevelFolders();
}
// If searching by keyword.
if (!empty($params['query'])) {
// Fetch search results.
$search_results = $this->acquiadam
->searchAssets($params);
// Override number of assets on current folder to make number of
// search results so pager works correctly.
$current_folder->numassets = $search_results['total_count'];
// Set items to array of assets in the search result.
$items = isset($search_results['assets']) ? $search_results['assets'] : [];
}
// Add the filter and sort options to the form.
$form += $this
->getFilterSort();
// Add the breadcrumb to the form.
$form += $this
->getBreadcrumb($current_folder, $breadcrumbs);
// Add container for assets (and folder buttons)
$form['asset-container'] = [
'#type' => 'container',
// Store the current folder id in the form so it can be retrieved
// from the form state.
'#acquiadam_folder_id' => $current_folder->id,
'#attributes' => [
'class' => [
'acquiadam-asset-browser',
],
],
];
// Get module path to create URL for background images.
$modulePath = $this->moduleHandler
->getModule('media_acquiadam')
->getPath();
// If no search terms, display folders.
if (empty($params['query'])) {
// Add folder buttons to form.
foreach ($folders as $folder) {
$form['asset-container']['folders'][$folder->name] = [
'#type' => 'container',
'#attributes' => [
'class' => [
'acquiadam-browser-folder-link',
],
'style' => 'background-image:url("/' . $modulePath . '/img/folder.png")',
],
];
// Use folder thumbnail to generate inline style, if present.
$backgroundImageStyle = '';
if (isset($folder->thumbnailurls) && !empty($folder->thumbnailurls[0]->url)) {
$backgroundImageStyle .= 'background-image:url("' . $folder->thumbnailurls[0]->url . '")';
}
$form['asset-container']['folders'][$folder->name][$folder->id] = [
'#type' => 'button',
'#value' => $folder->name,
'#name' => 'acquiadam_folder',
'#acquiadam_folder_id' => $folder->id,
'#acquiadam_parent_folder_id' => $current_folder->parent,
'#attributes' => [
'class' => [
'acquiadam-folder-link-button',
],
'style' => $backgroundImageStyle,
],
];
$form['asset-container']['folders'][$folder->name]['title'] = [
'#type' => 'html_tag',
'#tag' => 'p',
'#value' => $folder->name,
];
}
}
// Assets are rendered as #options for a checkboxes element.
// Start with an empty array.
$assets = [];
$assets_status = [];
// Add to the assets array.
if (isset($items)) {
foreach ($items as $folder_item) {
$assets_status[$folder_item->id]['#disabled'] = $folder_item->status !== 'active';
$assets[$folder_item->id] = $this
->layoutMediaEntity($folder_item);
}
}
// Add assets to form.
// IMPORTANT: Do not add #title or #description properties.
// This will wrap elements in a fieldset and will cause styling problems.
// See: \core\lib\Drupal\Core\Render\Element\CompositeFormElementTrait.php.
$form['asset-container']['assets'] = [
'#type' => 'checkboxes',
'#theme_wrappers' => [
'checkboxes__acquiadam_assets',
],
'#title_display' => 'invisible',
'#options' => $assets,
'#attached' => [
'library' => [
'media_acquiadam/asset_browser',
],
],
] + $assets_status;
// If the number of assets in the current folder is greater than
// the number of assets to show per page.
if ($current_folder->numassets > $num_per_page) {
// Add the pager to the form.
$form['actions'] += $this
->getPager($current_folder, $page, $num_per_page);
}
return $form;
}
/**
* {@inheritdoc}
*
* Create form elements for sorting and filtering/searching.
*/
public function getFilterSort() {
// Add container for pager.
$form['filter-sort-container'] = [
'#type' => 'container',
'#attributes' => [
'class' => [
'filter-sort-container',
],
],
];
// Add dropdown for sort by.
$form['filter-sort-container']['sortby'] = [
'#type' => 'select',
'#title' => 'Sort by',
'#options' => [
'filename' => 'File name',
'filesize' => 'File size',
'datecreated' => 'Date created',
'datemodified' => 'Date modified',
],
'#default_value' => 'datecreated',
];
// Add dropdown for sort direction.
$form['filter-sort-container']['sortdir'] = [
'#type' => 'select',
'#title' => 'Sort direction',
'#options' => [
'asc' => 'Ascending',
'desc' => 'Descending',
],
'#default_value' => 'asc',
];
// Add dropdown for filtering on asset type.
$form['filter-sort-container']['types'] = [
'#type' => 'select',
'#title' => 'File type',
'#options' => [
'' => 'All',
'image' => 'Image',
'audiovideo' => 'Audio/Video',
'document' => 'Document',
'presentation' => 'Presentation',
'other' => 'Other',
],
'#default_value' => '',
];
// Add textfield for keyword search.
$form['filter-sort-container']['query'] = [
'#type' => 'textfield',
'#title' => 'Search',
'#size' => 24,
];
// Add submit button to apply sort/filter criteria.
$form['filter-sort-container']['filter-sort-submit'] = [
'#type' => 'button',
'#value' => 'Apply',
'#name' => 'filter_sort_submit',
];
// Add form reset button.
$form['filter-sort-container']['filter-sort-reset'] = [
'#type' => 'button',
'#value' => 'Reset',
'#name' => 'filter_sort_reset',
];
return $form;
}
/**
* {@inheritdoc}
*/
public function getBreadcrumb(Folder $current_folder, array $breadcrumbs = []) {
// If the folder being rendered is already in the breadcrumb trail
// and the breadcrumb trail is longer than 1 (i.e. root folder only)
if (array_key_exists($current_folder->id, $breadcrumbs) && count($breadcrumbs) > 1) {
// This indicates that the user has navigated "Up" the folder structure
// 1 or more levels.
do {
// Go to the end of the breadcrumb array.
end($breadcrumbs);
// Fetch the folder id of the last breadcrumb.
$id = key($breadcrumbs);
// If current folder id doesn't match the folder id of last breadcrumb.
if ($id != $current_folder->id && count($breadcrumbs) > 1) {
// Remove the last breadcrumb since the user has navigated "Up"
// at least 1 folder.
array_pop($breadcrumbs);
}
// If the folder id of the last breadcrumb does not equal the current
// folder id then keep removing breadcrumbs from the end.
} while ($id != $current_folder->id && count($breadcrumbs) > 1);
}
// If the parent folder id of the current folder is in the breadcrumb trail
// then the user MIGHT have navigated down into a subfolder.
if (is_object($current_folder) && property_exists($current_folder, 'parent') && array_key_exists($current_folder->parent, $breadcrumbs)) {
// Go to the end of the breadcrumb array.
end($breadcrumbs);
// If the last folder id in the breadcrumb equals the parent folder id of
// the current folder the the user HAS navigated down into a subfolder.
if (key($breadcrumbs) == $current_folder->parent) {
// Add the current folder to the breadcrumb.
$breadcrumbs[$current_folder->id] = $current_folder->name;
}
}
// Reset the breadcrumb array so that it can be rendered in order.
reset($breadcrumbs);
// Create a container for the breadcrumb.
$form['breadcrumb-container'] = [
'#type' => 'container',
// Custom element property to store breadcrumbs array.
// This is fetched from the form state every time the form is rebuilt
// due to navigating between folders.
'#breadcrumbs' => $breadcrumbs,
'#attributes' => [
'class' => [
'breadcrumb acquiadam-browser-breadcrumb-container',
],
],
];
// Add the breadcrumb buttons to the form.
foreach ($breadcrumbs as $folder_id => $folder_name) {
$form['breadcrumb-container'][$folder_id] = [
'#type' => 'button',
'#value' => $folder_name,
'#name' => 'acquiadam_folder',
'#acquiadam_folder_id' => $folder_id,
'#acquiadam_parent_folder_id' => $folder_name,
'#prefix' => '<li>',
'#suffix' => '</li>',
'#attributes' => [
'class' => [
'acquiadam-browser-breadcrumb',
],
],
];
}
return $form;
}
/**
* Format display of one asset in media browser.
*
* @return string
* Element HTML markup.
*
* @var \cweagans\webdam\Entity\Asset $acquiadamAsset
*/
public function layoutMediaEntity(Asset $acquiadamAsset) {
$modulePath = $this->moduleHandler
->getModule('media_acquiadam')
->getPath();
$assetName = $acquiadamAsset->status !== 'active' ? "{$acquiadamAsset->name} ({$acquiadamAsset->status})" : $acquiadamAsset->name;
if (!empty($acquiadamAsset->thumbnailurls)) {
$thumbnail = '<div class="acquiadam-asset-thumb"><img src="' . $acquiadamAsset->thumbnailurls[2]->url . '" alt="' . $assetName . '" /></div>';
}
else {
$thumbnail = '<span class="acquiadam-browser-empty">No preview available.</span>';
}
$element = '<div class="acquiadam-asset-checkbox">' . $thumbnail . '<div class="acquiadam-asset-details"><a href="/acquiadam/asset/' . $acquiadamAsset->id . '" class="use-ajax" data-dialog-type="modal"><img src="/' . $modulePath . '/img/ext-link.png" alt="Folder link" class="acquiadam-asset-browser-icon" /></a><p class="acquiadam-asset-filename">' . $assetName . '</p></div></div>';
return $element;
}
/**
* {@inheritdoc}
*
* Create a custom pager.
*/
public function getPager(Folder $current_folder, $page, $num_per_page) {
// Add container for pager.
$form['pager-container'] = [
'#type' => 'container',
// Store page number in container so it can be retrieved from form state.
'#page' => $page,
'#attributes' => [
'class' => [
'acquiadam-asset-browser-pager',
],
],
];
// If not on the first page.
if ($page > 0) {
// Add a button to go to the first page.
$form['pager-container']['first'] = [
'#type' => 'button',
'#value' => '<<',
'#name' => 'acquiadam_pager',
'#acquiadam_page' => 0,
'#attributes' => [
'class' => [
'page-button',
'page-first',
],
],
];
// Add a button to go to the previous page.
$form['pager-container']['previous'] = [
'#type' => 'button',
'#value' => '<',
'#name' => 'acquiadam_pager',
'#acquiadam_page' => $page - 1,
'#attributes' => [
'class' => [
'page-button',
'page-previous',
],
],
];
}
// Last available page based on number of assets in folder
// divided by number of assets to show per page.
$last_page = floor(($current_folder->numassets - 1) / $num_per_page);
// First page to show in the pager.
// Try to put the button for the current page in the middle by starting at
// the current page number minus 4.
$start_page = max(0, $page - 4);
// Last page to show in the pager. Don't go beyond the last available page.
$end_page = min($start_page + 9, $last_page);
// Create buttons for pages from start to end.
for ($i = $start_page; $i <= $end_page; $i++) {
$form['pager-container']['page_' . $i] = [
'#type' => 'button',
'#value' => $i + 1,
'#name' => 'acquiadam_pager',
'#acquiadam_page' => $i,
'#attributes' => [
'class' => [
$i == $page ? 'page-current' : '',
'page-button',
],
],
];
}
// If not on the last page.
if ($end_page > $page) {
// Add a button to go to the next page.
$form['pager-container']['next'] = [
'#type' => 'button',
'#value' => '>',
'#name' => 'acquiadam_pager',
'#acquiadam_page' => $page + 1,
'#attributes' => [
'class' => [
'page-button',
'page-next',
],
],
];
// Add a button to go to the last page.
$form['pager-container']['last'] = [
'#type' => 'button',
'#value' => '>>',
'#name' => 'acquiadam_pager',
'#acquiadam_page' => $last_page,
'#attributes' => [
'class' => [
'page-button',
'page-last',
],
],
];
}
return $form;
}
/**
* {@inheritdoc}
*/
public function validate(array &$form, FormStateInterface $form_state) {
// If the primary submit button was clicked to select assets.
if (!empty($form_state
->getTriggeringElement()['#eb_widget_main_submit'])) {
// The media bundle.
$media_bundle = $this->entityTypeManager
->getStorage('media_type')
->load($this->configuration['media_type']);
// Load the field definitions for this bundle.
$field_definitions = $this->entityFieldManager
->getFieldDefinitions('media', $media_bundle
->id());
// Load the file settings to validate against.
$field_map = $media_bundle
->getFieldMap();
if (!isset($field_map['file'])) {
$message = $this
->t('Missing file mapping. Check your media configuration.');
$form_state
->setError($form['widget']['asset-container']['assets'], $message);
return;
}
$file_extensions = $field_definitions[$field_map['file']]
->getItemDefinition()
->getSetting('file_extensions');
$supported_extensions = explode(',', preg_replace('/,?\\s/', ',', $file_extensions));
// The form input uses checkboxes which returns zero for unchecked assets.
// Remove these unchecked assets.
$assets = array_filter($form_state
->getValue('assets'));
// Fetch assets.
$dam_assets = $this->acquiadam
->getAssetMultiple($assets);
// Get the cardinality for the media field that is being populated.
$field_cardinality = $form_state
->get([
'entity_browser',
'validators',
'cardinality',
'cardinality',
]);
if (!count($assets)) {
$form_state
->setError($form['widget']['asset-container'], $this
->t('Please select an asset.'));
}
// If the field cardinality is limited and the number of assets selected
// is greater than the field cardinality.
if ($field_cardinality > 0 && count($assets) > $field_cardinality) {
// Format the error message for singular or plural
// depending on cardinality.
$message = $this
->formatPlural($field_cardinality, 'You can not select more than 1 entity.', 'You can not select more than @count entities.');
// Set the error message on the form.
$form_state
->setError($form['widget']['asset-container']['assets'], $message);
}
// If the asset's file type does not match allowed file types.
foreach ($dam_assets as $asset) {
$filetype = $asset->filetype;
$type_is_supported = in_array($filetype, $supported_extensions);
if (!$type_is_supported) {
$message = $this
->t('Please make another selection. The "@filetype" file type is not one of the supported file types (@supported_types).', [
'@filetype' => $filetype,
'@supported_types' => implode(', ', $supported_extensions),
]);
// Set the error message on the form.
$form_state
->setError($form['widget']['asset-container']['assets'], $message);
}
}
}
}
/**
* {@inheritdoc}
*/
public function submit(array &$element, array &$form, FormStateInterface $form_state) {
$assets = [];
if (!empty($form_state
->getTriggeringElement()['#eb_widget_main_submit'])) {
$assets = $this
->prepareEntities($form, $form_state);
}
$this
->selectEntities($assets, $form_state);
}
/**
* {@inheritdoc}
*/
protected function prepareEntities(array $form, FormStateInterface $form_state) {
// Get asset id's from form state.
$asset_ids = $form_state
->getValue('current_selections', []) + array_filter($form_state
->getValue('assets', []));
// Load type information.
/** @var \Drupal\media\MediaTypeInterface $media_type */
$media_type = $this->entityTypeManager
->getStorage('media_type')
->load($this->configuration['media_type']);
// Get the source field for this type which stores the asset id.
$source_field = $media_type
->getSource()
->getSourceFieldDefinition($media_type)
->getName();
// Query for existing entities.
$existing_ids = $this->entityTypeManager
->getStorage('media')
->getQuery()
->condition('bundle', $media_type
->id())
->condition($source_field, $asset_ids, 'IN')
->execute();
// Load the entities found.
$entities = $this->entityTypeManager
->getStorage('media')
->loadMultiple($existing_ids);
// Loop through the existing entities.
foreach ($entities as $entity) {
// Set the asset id of the current entity.
$asset_id = $entity
->get($source_field)->value;
// If the asset id of the entity is in the list of asset id's selected.
if (in_array($asset_id, $asset_ids)) {
// Remove the asset id from the input so it does not get fetched
// and does not get created as a duplicate.
unset($asset_ids[$asset_id]);
}
}
// Fetch the assets.
$assets = $this->acquiadam
->getAssetMultiple($asset_ids);
// Loop through the returned assets.
foreach ($assets as $asset) {
// Initialize entity values.
$entity_values = [
'bundle' => $media_type
->id(),
// This should be the current user id.
'uid' => $this->user
->id(),
// This should be the current language code.
'langcode' => $this->languageManager
->getCurrentLanguage()
->getId(),
// This should map the asset status to the drupal entity status.
'status' => $asset->status === 'active',
// Set the entity name to the asset name.
'name' => $asset->name,
// Set the chosen source field for this entity to the asset id.
$source_field => $asset->id,
];
// Create a new entity to represent the asset.
$entity = $this->entityTypeManager
->getStorage('media')
->create($entity_values);
// Save the entity.
$entity
->save();
// Reload the entity to make sure we have everything populated properly.
$entity = $this->entityTypeManager
->getStorage('media')
->load($entity
->id());
// Add the new entity to the array of returned entities.
$entities[] = $entity;
}
// Return the entities.
return $entities;
}
}Members
Name |
Modifiers | Type | Description | Overrides |
|---|---|---|---|---|
|
Acquiadam:: |
protected | property | The dam interface. | |
|
Acquiadam:: |
protected | property | An entity field manager. | |
|
Acquiadam:: |
protected | property | The current user account. | |
|
Acquiadam:: |
protected | property | A module handler object. | |
|
Acquiadam:: |
protected | property | Drupal RequestStack service. | |
|
Acquiadam:: |
protected | property | A media source manager. | |
|
Acquiadam:: |
protected | property | The current user account. | |
|
Acquiadam:: |
protected | property | User data manager. | |
|
Acquiadam:: |
public | function | @todo Add more settings for configuring this widget. | |
|
Acquiadam:: |
public static | function | ||
|
Acquiadam:: |
public | function | ||
|
Acquiadam:: |
public | function | ||
|
Acquiadam:: |
public | function | Create form elements for sorting and filtering/searching. | |
|
Acquiadam:: |
public | function | ||
|
Acquiadam:: |
public | function | Create a custom pager. | |
|
Acquiadam:: |
public | function | Format display of one asset in media browser. | |
|
Acquiadam:: |
protected | function | ||
|
Acquiadam:: |
public | function | ||
|
Acquiadam:: |
public | function | ||
|
Acquiadam:: |
public | function | Acquiadam constructor. |