class WebformHelpVideoForm in Webform 6.x
Same name and namespace in other branches
- 8.5 src/Form/WebformHelpVideoForm.php \Drupal\webform\Form\WebformHelpVideoForm
Help video form.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\webform\Form\WebformHelpVideoForm uses WebformDialogFormTrait
Expanded class hierarchy of WebformHelpVideoForm
1 string reference to 'WebformHelpVideoForm'
File
- src/
Form/ WebformHelpVideoForm.php, line 14
Namespace
Drupal\webform\FormView source
class WebformHelpVideoForm extends FormBase {
use WebformDialogFormTrait;
/**
* The webform help manager.
*
* @var \Drupal\Component\Plugin\PluginManagerInterface
*/
protected $helpManager;
/**
* The id of the current video.
*
* @var string
*/
protected $videoId;
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'webform_help_video_form';
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
$instance = parent::create($container);
$instance->helpManager = $container
->get('webform.help_manager');
return $instance;
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state, $id = NULL) {
$this->videoId = str_replace('-', '_', $id);
$video = $this->helpManager
->getVideo($this->videoId);
if (!$video) {
throw new NotFoundHttpException();
}
$form['#title'] = $video['title'];
// Content.
if (is_array($video['content'])) {
$form['content'] = $video['content'];
}
else {
$form['content'] = [
'#markup' => $video['content'],
];
}
// Video.
if ($video['youtube_id']) {
$form['video'] = [
'#theme' => 'webform_help_video_youtube',
'#youtube_id' => $video['youtube_id'],
];
}
// Related resources.
if ($video_links = $this->helpManager
->getVideoLinks($this->videoId)) {
$form['resources'] = [
'#type' => 'details',
'#title' => $this
->t('Additional resources'),
'links' => [
'#theme' => 'links',
'#links' => $video_links,
],
];
}
// Actions.
if ($this
->isDialog()) {
$form['modal_actions'] = [
'#type' => 'actions',
];
$form['modal_actions']['close'] = [
'#type' => 'submit',
'#value' => $this
->t('Close'),
'#ajax' => [
'callback' => '::closeDialog',
'event' => 'click',
],
'#attributes' => [
'class' => [
'button',
'button--primary',
],
],
];
if ($this
->getRequest()->query
->get('more') && $this
->currentUser()
->hasPermission('access webform help')) {
$form['modal_actions']['more'] = [
'#type' => 'link',
'#title' => $this
->t('▶ Watch more videos'),
'#url' => Url::fromRoute('webform.help'),
'#attributes' => [
'class' => [
'button',
],
],
];
}
}
$form['#attached']['library'][] = 'webform/webform.help';
return $form;
}
/**
* {@inheritdoc}
*/
public function validateForm(array &$form, FormStateInterface $form_state) {
if ($this
->isDialog()) {
$form_state
->clearErrors();
}
else {
parent::validateForm($form, $form_state);
}
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
// Do nothing.
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormBase:: |
protected | property | The config factory. | 3 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Retrieves a configuration object. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 3 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
FormBase:: |
protected | function | Returns a redirect response object for the specified route. | |
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
WebformAjaxFormTrait:: |
protected | function | Queue announcement with Ajax response. | |
WebformAjaxFormTrait:: |
protected | function | Add Ajax support to a form. | |
WebformAjaxFormTrait:: |
protected | function | Create an AjaxResponse or WebformAjaxResponse object. | |
WebformAjaxFormTrait:: |
protected | function | Get announcements. | |
WebformAjaxFormTrait:: |
protected | function | Get default ajax callback settings. | 1 |
WebformAjaxFormTrait:: |
protected | function | Get redirect URL from the form's state. | |
WebformAjaxFormTrait:: |
protected | function | Get the form's Ajax wrapper id. | 1 |
WebformAjaxFormTrait:: |
protected | function | Determine if Ajax callback is callable. | |
WebformAjaxFormTrait:: |
protected | function | Is the current request for an Ajax modal/dialog. | |
WebformAjaxFormTrait:: |
protected | function | Is the current request for an off canvas dialog. | |
WebformAjaxFormTrait:: |
protected | function | Handle missing Ajax callback. | |
WebformAjaxFormTrait:: |
protected | function | Replace form via an Ajax response. | 1 |
WebformAjaxFormTrait:: |
protected | function | Reset announcements. | |
WebformAjaxFormTrait:: |
protected | function | Set announcements. | |
WebformAjaxFormTrait:: |
public | function | Submit form #ajax callback. | 1 |
WebformAjaxFormTrait:: |
public | function | Validate form #ajax callback. | 1 |
WebformDialogFormTrait:: |
protected | function | Add modal dialog support to a confirm form. | |
WebformDialogFormTrait:: |
protected | function | Build webform dialog delete link. | |
WebformDialogFormTrait:: |
protected | function | Add modal dialog support to a form. | |
WebformDialogFormTrait:: |
public | function |
Cancel form #ajax callback. Overrides WebformAjaxFormTrait:: |
1 |
WebformDialogFormTrait:: |
public | function | Close dialog. | |
WebformDialogFormTrait:: |
protected | function |
Returns if webform is using Ajax. Overrides WebformAjaxFormTrait:: |
1 |
WebformDialogFormTrait:: |
public | function |
Empty submit callback used to only have the submit button to use an #ajax submit callback. Overrides WebformAjaxFormTrait:: |
|
WebformDialogFormTrait:: |
public | function | Validate callback to clear validation errors. | 2 |
WebformHelpVideoForm:: |
protected | property | The webform help manager. | |
WebformHelpVideoForm:: |
protected | property | The id of the current video. | |
WebformHelpVideoForm:: |
public | function |
Form constructor. Overrides FormInterface:: |
|
WebformHelpVideoForm:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
WebformHelpVideoForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
WebformHelpVideoForm:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
WebformHelpVideoForm:: |
public | function |
Form validation handler. Overrides FormBase:: |