class WorkspaceController in Workspace 8

WorkspaceController class.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\workspace\Controller\WorkspaceController

1 file declares its use of WorkspaceController

WorkspaceControllerTest.php in tests/src/Functional/WorkspaceControllerTest.php

File

src/Controller/WorkspaceController.php, line 16

Namespace

Drupal\workspace\Controller

class WorkspaceController extends ControllerBase {

  /**
   * Property definition.
   *
   * @var \Drupal\Core\Config\Config|\Drupal\Core\Config\ImmutableConfig
   */
  protected $workspaceSettings;

  /**
   * {@inheritdoc}
   */
  public function __construct() {
    $this->workspaceSettings = \Drupal::configFactory()
      ->getEditable('workspace.settings');
  }

  /**
   * {@inheritdoc}
   */
  public function add() {
    $types = WorkspaceType::loadMultiple();
    if ($types && count($types) == 1) {
      $type = reset($types);
      return $this
        ->addForm($type);
    }
    if (count($types) === 0) {
      return [
        '#markup' => $this
          ->t('You have not created any Workspace types yet. Go to the <a href=":url">Workspace type creation page</a> to add a new Workspace type.', [
          ':url' => Url::fromRoute('entity.workspace_type.add')
            ->toString(),
        ]),
      ];
    }
    return [
      '#theme' => 'workspace_add_list',
      '#content' => $types,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function addForm(WorkspaceTypeInterface $workspace_type) {
    $upstream_id = $this->workspaceSettings
      ->get('upstream');
    if (!$upstream_id) {
      $upstream_id = $this
        ->getDefaultWorkspacePointer()
        ->id();
    }
    $workspace = Workspace::create([
      'type' => $workspace_type
        ->id(),
      'upstream' => $upstream_id,
      'pull_replication_settings' => $this->workspaceSettings
        ->get('pull_replication_settings', ''),
      'push_replication_settings' => $this->workspaceSettings
        ->get('push_replication_settings', ''),
    ]);
    return $this
      ->entityFormBuilder()
      ->getForm($workspace);
  }

  /**
   * {@inheritdoc}
   */
  public function getAddFormTitle(WorkspaceTypeInterface $workspace_type) {
    return $this
      ->t('Add %type workspace', [
      '%type' => $workspace_type
        ->label(),
    ]);
  }

  /**
   * View a list of conflicts for a workspace.
   *
   * @param string $workspace
   *   The workspace ID to get conflicts for.
   *
   * @return array
   *   The render array to display for the page.
   */
  public function viewConflicts($workspace) {
    $container = \Drupal::getContainer();
    $builder = ConflictListBuilder::createInstance($container);
    return $builder
      ->buildList($workspace);
  }

  /**
   * Get the page title for the list of conflicts page.
   *
   * @return string
   *   The page title.
   */
  public function getViewConflictsTitle() {
    return 'Workspace Conflicts';
  }

  /**
   * Returns the upstream for the given workspace.
   */
  protected function getDefaultWorkspacePointer() {
    $workspace_id = $this
      ->getDefaultWorkspaceId();
    $workspace = Workspace::load($workspace_id);
    return WorkspacePointer::loadFromWorkspace($workspace);
  }

  /**
   * {@inheritdoc}
   */
  public static function getDefaultWorkspaceId() {
    return \Drupal::getContainer()
      ->getParameter('workspace.default');
  }

}

Members

Name	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::$entityManager	protected	property	The entity manager.
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	40
ControllerBase::currentUser	protected	function	Returns the current user.	1
ControllerBase::entityFormBuilder	protected	function	Retrieves the entity form builder.
ControllerBase::entityManager Deprecated	protected	function	Retrieves the entity manager service.
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. Overrides UrlGeneratorTrait::redirect
ControllerBase::state	protected	function	Returns the state storage service.
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
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.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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.	1
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.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.
WorkspaceController::$workspaceSettings	protected	property	Property definition.
WorkspaceController::add	public	function
WorkspaceController::addForm	public	function
WorkspaceController::getAddFormTitle	public	function
WorkspaceController::getDefaultWorkspaceId	public static	function
WorkspaceController::getDefaultWorkspacePointer	protected	function	Returns the upstream for the given workspace.
WorkspaceController::getViewConflictsTitle	public	function	Get the page title for the list of conflicts page.
WorkspaceController::viewConflicts	public	function	View a list of conflicts for a workspace.
WorkspaceController::__construct	public	function