class ContentHelpController in Content Synchronization 3.0.x

Provides route responses for content_sync help.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\content_sync\Controller\ContentHelpController implements ContainerInjectionInterface

File

src/Controller/ContentHelpController.php, line 15

Namespace

Drupal\content_sync\Controller

class ContentHelpController extends ControllerBase implements ContainerInjectionInterface {

  /**
   * The help manager.
   *
   * @var \Drupal\Component\Plugin\PluginManagerInterface
   */
  protected $helpManager;

  /**
   * Constructs a ContentSyncHelpController object.
   *
   * @param \Drupal\content_sync\ContentSyncHelpManagerInterface $help_manager
   *   The help manager.
   */
  public function __construct(ContentSyncHelpManagerInterface $help_manager) {
    $this->helpManager = $help_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('content_sync.help_manager'));
  }

  /**
   * Returns dedicated help about (aka How can we help you?) page.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   *
   * @return array
   *   A renderable array containing a help about (aka How can we help you?) page.
   */
  public function about(Request $request) {
    $build = $this->helpManager
      ->buildAbout();
    unset($build['title']);
    $build += [
      '#prefix' => '<div class="content_sync-help">',
      '#suffix' => '</div>',
    ];
    $build['#attached']['library'][] = 'content_sync/content_sync.help';
    return $build;
  }

  /**
   * Returns dedicated help video page.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   * @param string $id
   *   The video id.
   *
   * @return array
   *   A renderable array containing a help video player page.
   */
  public function video(Request $request, $id) {
    $id = str_replace('-', '_', $id);
    $video = $this->helpManager
      ->getVideo($id);
    if (!$video) {
      throw new NotFoundHttpException();
    }
    $build = [];
    if (is_array($video['content'])) {
      $build['content'] = $video['content'];
    }
    else {
      $build['content'] = [
        '#markup' => $video['content'],
      ];
    }
    if ($video['youtube_id']) {
      $build['video'] = [
        '#theme' => 'content_sync_help_video_youtube',
        '#youtube_id' => $video['youtube_id'],
      ];
    }
    return $build;
  }

  /**
   * Route video title callback.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   * @param string $id
   *   The id of the dedicated help section.
   *
   * @return string
   *   The help video's title.
   */
  public function videoTitle(Request $request, $id) {
    $id = str_replace('-', '_', $id);
    $video = $this->helpManager
      ->getVideo($id);
    return isset($video) ? $video['title'] : $this
      ->t('Watch video');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ContentHelpController::$helpManager	protected	property	The help manager.
ContentHelpController::about	public	function	Returns dedicated help about (aka How can we help you?) page.
ContentHelpController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
ContentHelpController::video	public	function	Returns dedicated help video page.
ContentHelpController::videoTitle	public	function	Route video title callback.
ContentHelpController::__construct	public	function	Constructs a ContentSyncHelpController object.
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::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.
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.