1. class
  2. Drupal
  3. \
  4. media_library
  5. \
  6. MediaLibraryUiBuilder

MediaLibraryUiBuilder

class MediaLibraryUiBuilder (View source)

internal  This service is an internal part of the modal media library dialog and does not provide any extension points.
 

Service which builds the media library.

Traits

StringTranslationTrait

Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.

Properties

protected TranslationInterface $stringTranslation

The string translation service.

 from  StringTranslationTrait
protected FormBuilderInterface $formBuilder

The form builder.
protected EntityTypeManagerInterface $entityTypeManager

The entity type manager.
protected Request $request

The currently active request object.
protected ViewExecutableFactory $viewsExecutableFactory

The views executable factory.
protected OpenerResolverInterface $openerResolver

The media library opener resolver.

Methods

TranslatableMarkup
t(string $string, array $args = [], array $options = [])

Translates a string to the current language or to a given language.

from  StringTranslationTrait
formatPlural($count, $singular, $plural, array $args = [], array $options = [])

Formats a string containing a count of items.

from  StringTranslationTrait
getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

from  StringTranslationTrait
TranslationInterface
getStringTranslation()

Gets the string translation service.

from  StringTranslationTrait
$this
setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

from  StringTranslationTrait
__construct(EntityTypeManagerInterface $entity_type_manager, RequestStack $request_stack, ViewExecutableFactory $views_executable_factory, FormBuilderInterface $form_builder, OpenerResolverInterface $opener_resolver = NULL)

Constructs a MediaLibraryUiBuilder instance.

static array
dialogOptions()

Get media library dialog options.

array
buildUi(MediaLibraryState $state = NULL)

Build the media library UI.

array
buildLibraryContent(MediaLibraryState $state)

Build the media library content area.

AccessResult
checkAccess(AccountInterface $account, MediaLibraryState $state = NULL)

Check access to the media library.

array
buildMediaTypeMenu(MediaLibraryState $state)

Get the media type menu for the media library.

array
buildMediaTypeAddForm(MediaLibraryState $state)

Get the add form for the selected media type.

array
buildMediaLibraryView(MediaLibraryState $state)

Get the media library view.

Details

in StringTranslationTrait at line 70
protected TranslatableMarkup t(string $string, array $args = [], array $options = [])

Translates a string to the current language or to a given language.

See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.

In order for strings to be localized, make them available in one of the ways supported by the

Parameters

string $string

A string containing the English text to translate.
array $args

(optional) An associative array of replacements to make after translation. Based on the first character of the key, the value is escaped and/or themed. See \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for details.
array $options

(optional) An associative array of additional options, with the following elements:

  • 'langcode' (defaults to the current language): A language code, to translate to a language other than what is used to display the page.
  • 'context' (defaults to the empty context): The context the source string belongs to. See the @link i18n Internationalization topic @endlink for more information about string contexts.

Return Value

TranslatableMarkup

An object that, when cast to a string, returns the translated string.

See also

FormattableMarkup::placeholderFormat
TranslatableMarkup::__construct

in StringTranslationTrait at line 79
protected formatPlural($count, $singular, $plural, array $args = [], array $options = [])

Formats a string containing a count of items.

Parameters

$count
$singular
$plural
array $args
array $options

See also

TranslationInterface::formatPlural

in StringTranslationTrait at line 88
protected getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

Parameters

$langcode

See also

PluralFormulaInterface::getNumberOfPlurals

in StringTranslationTrait at line 102
protected TranslationInterface getStringTranslation()

Gets the string translation service.

Return Value

TranslationInterface

The string translation service.

in StringTranslationTrait at line 118
$this setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

Parameters

TranslationInterface $translation

The string translation service.

Return Value

$this

at line 76
__construct(EntityTypeManagerInterface $entity_type_manager, RequestStack $request_stack, ViewExecutableFactory $views_executable_factory, FormBuilderInterface $form_builder, OpenerResolverInterface $opener_resolver = NULL)

Constructs a MediaLibraryUiBuilder instance.

Parameters

EntityTypeManagerInterface $entity_type_manager

The entity type manager.
RequestStack $request_stack

The request stack.
ViewExecutableFactory $views_executable_factory

The views executable factory.
FormBuilderInterface $form_builder

The currently active request object.
OpenerResolverInterface $opener_resolver

The opener resolver.

at line 94
static array dialogOptions()

Get media library dialog options.

Return Value

array

The media library dialog options.

at line 113
array buildUi(MediaLibraryState $state = NULL)

Build the media library UI.

Parameters

MediaLibraryState $state

(optional) The current state of the media library, derived from the current request.

Return Value

array

The render array for the media library.

at line 155
protected array buildLibraryContent(MediaLibraryState $state)

Build the media library content area.

Parameters

MediaLibraryState $state

The current state of the media library, derived from the current request.

Return Value

array

The render array for the media library.

at line 181
AccessResult checkAccess(AccountInterface $account, MediaLibraryState $state = NULL)

Check access to the media library.

Parameters

AccountInterface $account

Run access checks for this account.
MediaLibraryState $state

(optional) The current state of the media library, derived from the current request.

Return Value

AccessResult

The access result.

at line 224
protected array buildMediaTypeMenu(MediaLibraryState $state)

Get the media type menu for the media library.

Parameters

MediaLibraryState $state

The current state of the media library, derived from the current request.

Return Value

array

The render array for the media type menu.

at line 289
protected array buildMediaTypeAddForm(MediaLibraryState $state)

Get the add form for the selected media type.

Parameters

MediaLibraryState $state

The current state of the media library, derived from the current request.

Return Value

array

The render array for the media type add form.

at line 325
protected array buildMediaLibraryView(MediaLibraryState $state)

Get the media library view.

Parameters

MediaLibraryState $state

The current state of the media library, derived from the current request.

Return Value

array

The render array for the media library view.