class PhantomJSCaptureSettingsForm in PhantomJS Capture 8

Class PhantomJSCaptureSettingsForm

Provide a settings form for global settings of PhantomJS Capture.

@package Drupal\phantomjs_capture\Form

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\phantomjs_capture\Form\PhantomJSCaptureSettingsForm

Expanded class hierarchy of PhantomJSCaptureSettingsForm

1 string reference to 'PhantomJSCaptureSettingsForm'

phantomjs_capture.routing.yml in ./phantomjs_capture.routing.yml: phantomjs_capture.routing.yml

File

src/Form/PhantomJSCaptureSettingsForm.php, line 17

Namespace

Drupal\phantomjs_capture\Form

View source

class PhantomJSCaptureSettingsForm extends ConfigFormBase {

  /**
   * PhantomCaptureSettingsForm constructor.
   * @param ConfigFactoryInterface $config_factory
   */
  public function __construct(ConfigFactoryInterface $config_factory) {
    parent::__construct($config_factory);
  }

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

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'phantomjs_capture_settings';
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'phantomjs_capture.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('phantomjs_capture.settings');
    $url = 'http://phantomjs.org';
    $form['binary'] = array(
      '#type' => 'textfield',
      '#required' => TRUE,
      '#title' => $this
        ->t('Path to PhantomJS binary'),
      '#description' => $this
        ->t('This module requires that you install PhantomJS on your server and enter the path to the executable. The program is not include in the module due to licensing and operation system constraints. See <a href=":url">:url</a> for more information about downloading.', array(
        ':url' => $url,
      )),
      '#default_value' => $config
        ->get('binary'),
    );
    $form['destination'] = array(
      '#type' => 'textfield',
      '#required' => TRUE,
      '#title' => $this
        ->t('Default destination'),
      '#description' => $this
        ->t('The default destination for captures with PhantomJS. Do not include public://. Example, "phantomjs" would be stored as public://phantomjs, or private://phantomjs, based on the site file scheme.'),
      '#default_value' => $config
        ->get('destination'),
    );
    $form['script'] = array(
      '#type' => 'textfield',
      '#required' => TRUE,
      '#title' => $this
        ->t('PhantomJS capture script'),
      '#description' => $this
        ->t('The script used by PhantomJS to capture the screen. It captures full HD images (1920 x 1080).'),
      '#default_value' => $config
        ->get('script'),
    );
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();

    // Check that PhantomJS exists.
    if (!file_exists($values['binary'])) {
      $form_state
        ->setError($form['binary'], $this
        ->t('The PhantomJS binary was not found at the location given.'));
    }

    // Check that destination can be created.
    $destination = \Drupal::config('system.file')
      ->get('default_scheme') . '://' . $values['destination'];
    if (!file_prepare_directory($destination, FILE_CREATE_DIRECTORY)) {
      $form_state
        ->setError($form['destination'], t('The path was not writeable or could not be created.'));
    }

    // Check that capture script exists.
    if (!file_exists($values['script'])) {
      $form_state
        ->setError($form['script'], $this
        ->t('PhantomJS script was not found at the location given.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    $this
      ->config('phantomjs_capture.settings')
      ->set('binary', $values['binary'])
      ->set('destination', $values['destination'])
      ->set('script', $values['script'])
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	1
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::configFactory	protected	function	Gets the config factory for this form.	1
FormBase::container	private	function	Returns the service container.
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
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.
PhantomJSCaptureSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
PhantomJSCaptureSettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
PhantomJSCaptureSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
PhantomJSCaptureSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
PhantomJSCaptureSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
PhantomJSCaptureSettingsForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
PhantomJSCaptureSettingsForm::__construct	public	function	PhantomCaptureSettingsForm constructor. Overrides ConfigFormBase::__construct
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.

You are here

class PhantomJSCaptureSettingsForm in PhantomJS Capture 8

Hierarchy

File

Namespace

Members

API Navigation