You are here

class FlagListsActionsController in Flag Lists 4.0.x

Class FlagListsActionsController.

Handle adding and deletion of Flagging Collections actions.

Hierarchy

Expanded class hierarchy of FlagListsActionsController

2 files declare their use of FlagListsActionsController
flag_lists_actions.install in modules/flag_lists_actions/flag_lists_actions.install
Contains install and updates for the flag_lists_actions.
flag_lists_actions.module in modules/flag_lists_actions/flag_lists_actions.module
Contains flag_lists_actions.module.

File

modules/flag_lists_actions/src/Controller/FlagListsActionsController.php, line 15

Namespace

Drupal\flag_lists_actions\Controller
View source
class FlagListsActionsController extends ControllerBase implements ContainerInjectionInterface {

  /**
   * Add Flag Lists Actions.
   *
   * @param Drupal\Core\Entity\EntityInterface $entity
   *   The entity to create the Actions for.
   */
  public static function createActions(EntityInterface $entity) {
    $flag = $entity
      ->getRelatedFlag();

    // Add the flag/unflag actions for this flag and entity combination.
    $flag_id = 'flag_action.' . $flag
      ->id() . '_flag';
    if (!Action::load($flag_id)) {
      $action = Action::create([
        'id' => $flag_id,
        'type' => $flag
          ->getFlaggableEntityTypeId(),
        'label' => \Drupal::token()
          ->replace($flag
          ->getShortText('flag'), [
          'flagging_collection' => $entity,
        ], [
          'clear',
        ]),
        'plugin' => 'flag_action:' . $flag
          ->id() . '_flag',
        'configuration' => [
          'flag_id' => $flag
            ->id(),
          'flag_action' => 'flag',
        ],
      ]);
      $action
        ->trustData()
        ->save();
    }
    $unflag_id = 'flag_action.' . $flag
      ->id() . '_unflag';
    if (!Action::load($unflag_id)) {
      $action = Action::create([
        'id' => $unflag_id,
        'type' => $flag
          ->getFlaggableEntityTypeId(),
        'label' => \Drupal::token()
          ->replace($flag
          ->getShortText('unflag'), [
          'flagging_collection' => $entity,
        ], [
          'clear',
        ]),
        'plugin' => 'flag_action:' . $flag
          ->id() . '_unflag',
        'configuration' => [
          'flag_id' => $flag
            ->id(),
          'flag_action' => 'unflag',
        ],
      ]);
      $action
        ->trustData()
        ->save();
    }
  }

  /**
   * Delete Flag Lists Actions.
   *
   * @param Drupal\Core\Entity\EntityInterface $entity
   *   The entity to delete the Actions for.
   */
  public static function deleteActions(EntityInterface $entity) {
    $flag = $entity
      ->getRelatedFlag();
    $actions = Action::loadMultiple([
      'flag_action.' . $flag
        ->id() . '_flag',
      'flag_action.' . $flag
        ->id() . '_unflag',
    ]);

    // Remove the flag/unflag actions for this flag and entity combination.
    foreach ($actions as $action) {
      $action
        ->delete();
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 46
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route.
ControllerBase::state protected function Returns the state storage service.
FlagListsActionsController::createActions public static function Add Flag Lists Actions.
FlagListsActionsController::deleteActions public static function Delete Flag Lists Actions.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.