class PhantomJSCaptureTestForm in PhantomJS Capture 8

Class PhantomJSCaptureTestForm

Provide a form to test the output 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\phantomjs_capture\Form\PhantomJSCaptureTestForm

Expanded class hierarchy of PhantomJSCaptureTestForm

1 string reference to 'PhantomJSCaptureTestForm'

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

File

src/Form/PhantomJSCaptureTestForm.php, line 18

Namespace

Drupal\phantomjs_capture\Form

View source

class PhantomJSCaptureTestForm extends FormBase {

  /**
   * @var PhantomJSCaptureHelper
   */
  private $captureHelper;

  /**
   * PhantomJSCaptureTestForm constructor.
   * @param PhantomJSCaptureHelperInterface $phantomjs_capture_helper
   */
  public function __construct(PhantomJSCaptureHelperInterface $phantomjs_capture_helper) {
    $this->captureHelper = $phantomjs_capture_helper;
  }

  /**
   * {@inheritDoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('phantomjs_capture.helper'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['url'] = array(
      '#type' => 'textarea',
      '#title' => $this
        ->t('URL'),
      '#required' => TRUE,
      '#description' => $this
        ->t('Absolute URL to the page that you want to capture (it must to be a complete URL with http://). Certain kinds of URLs, such as ones that begin with a # symbol (SPAs or some search engine queries) may not work.'),
      '#default_value' => 'https://www.drupal.org',
    );
    $form['format'] = array(
      '#type' => 'select',
      '#title' => 'File format',
      '#options' => array(
        '.png' => 'PNG',
        '.jpg' => 'JPEG',
        '.pdf' => 'PDF',
      ),
    );
    $form['result'] = array(
      '#prefix' => '<div id="capture-result">',
      '#suffix' => '</div>',
      '#markup' => '',
    );
    $form['submit'] = array(
      '#type' => 'submit',
      '#value' => t('Capture'),
    );
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {

    // empty
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('phantomjs_capture.settings');
    $values = $form_state
      ->getValues();
    $url = Url::fromUri($values['url']);
    $file = 'capture_test' . $values['format'];
    $destination = \Drupal::config('system.file')
      ->get('default_scheme') . '://' . $config
      ->get('destination') . '/test/' . REQUEST_TIME;
    $file_url = file_create_url($destination . '/' . $file);
    if ($this->captureHelper
      ->capture($url, $destination, $file)) {
      drupal_set_message($this
        ->t('The file has been generated! You can view it <a href=":url">here</a>', array(
        ':url' => $file_url,
      )));
    }
    else {
      drupal_set_message('The address entered could not be retrieved, directory was not writeable, or phantomjs could not perform the action requested.', 'error');
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::config	protected	function	Retrieves a configuration object.
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.
PhantomJSCaptureTestForm::$captureHelper	private	property
PhantomJSCaptureTestForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
PhantomJSCaptureTestForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
PhantomJSCaptureTestForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
PhantomJSCaptureTestForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
PhantomJSCaptureTestForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
PhantomJSCaptureTestForm::__construct	public	function	PhantomJSCaptureTestForm constructor.
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 PhantomJSCaptureTestForm in PhantomJS Capture 8

Hierarchy

File

Namespace

Members

API Navigation