class TwitterFeedsForm in Tweet Feed 4.x

Same name and namespace in other branches

8.3 src/Form/TwitterFeedsForm.php \Drupal\tweet_feed\Form\TwitterFeedsForm

Form controller for Tweet entity edit forms.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\tweet_feed\Form\TwitterFeedsForm

Expanded class hierarchy of TwitterFeedsForm

1 string reference to 'TwitterFeedsForm'

tweet_feed.routing.yml in ./tweet_feed.routing.yml: tweet_feed.routing.yml

File

src/Form/TwitterFeedsForm.php, line 17

Namespace

Drupal\tweet_feed\Form

View source

class TwitterFeedsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $feed_machine_name = NULL) {
    $config = $this
      ->config('tweet_feed.twitter_feeds');

    // Set up our settings form for this particular account (new or update)
    if (!empty($feed_machine_name)) {
      $feeds = $config
        ->get('feeds');
      $feed = $feeds[$feed_machine_name];
      if (!empty($feed)) {
        $form['feed_machine_name'] = [
          '#type' => 'hidden',
          '#value' => $feed_machine_name,
        ];
        $form['feed_update'] = [
          '#type' => 'hidden',
          '#value' => 1,
        ];
      }
      $aid = $feed['aid'];
      $feed_name = $feed['feed_name'];
      $query_type = $feed['query_type'];
      $search_term = $feed['search_term'];
      $list_name = $feed['list_name'];
      $timeline_id = $feed['timeline_id'];
      $pull_count = $feed['pull_count'];
      $new_window = $feed['new_window'];
      $hash_taxonomy = $feed['hash_taxonomy'];
      $clear_prior = $feed['clear_prior'];
      $twitter_feed_name_disabled = TRUE;
    }
    else {

      // Otherwise just initialize the form so we do not have a swath of errors
      $aid = $query_type = $search_term = $list_name = $feed_name = NULL;
      $timeline_id = $new_window = $clear_prior = NULL;
      $twitter_feed_name_disabled = FALSE;
      $hash_taxonomy = NULL;
      $pull_count = 200;
    }

    // Get a list of the configured accounts so we can assign this feed to a particular
    // API account for pulling and allow user to select which one to use.
    $account_config = $this
      ->config('tweet_feed.twitter_accounts');
    $accounts = $account_config
      ->get('accounts');
    if (!empty($accounts)) {
      foreach ($accounts as $machine_name => $account) {
        $acc[$machine_name] = $account['account_name'];
      }
    }
    else {

      // You must have an account to add a feed. If you don't then everything falls apart.
      // Warn the user here if they are trying to add a feed without an account.
      \Drupal::messenger()
        ->addError($this
        ->t('You cannot create a feed until you have added an account. Please add an account here before proceeding to add a feed.'));
      $response = new RedirectResponse(Url::fromRoute('tweet_feed.twitter_accounts')
        ->toString());
      $response
        ->send();
    }
    $form['tweet_feed_query_settings'] = array(
      '#type' => 'fieldset',
      '#title' => t('Twitter Query Settings'),
      '#collapsible' => FALSE,
      '#collapsed' => FALSE,
      '#weight' => 1,
    );
    $form['tweet_feed_query_settings']['feed_name'] = array(
      '#type' => 'textfield',
      '#title' => t('Feed Name'),
      '#description' => t('The name of the feed as it will appear on administrative forms'),
      '#default_value' => $feed_name,
      '#required' => TRUE,
      '#disabled' => $twitter_feed_name_disabled,
      '#weight' => 1,
    );
    $form['tweet_feed_query_settings']['aid'] = array(
      '#type' => 'select',
      '#title' => t('API Account To Use For Pulling This Feed'),
      '#options' => $acc,
      '#default_value' => $aid,
      '#required' => TRUE,
      '#weight' => 2,
    );

    // I was going to remove this remnant of the old module since it really isn't all that
    // necessary. But because it makes the code below infinitely more readable, I am going
    // to leave it in.
    define('QUERY_SEARCH', 1);
    define('QUERY_TIMELINE', 2);
    define('QUERY_LIST', 3);
    $form['tweet_feed_query_settings']['query_type'] = array(
      '#type' => 'radios',
      '#title' => t('Type of Twitter Query'),
      '#options' => array(
        QUERY_SEARCH => t('Twitter Search'),
        QUERY_TIMELINE => t('User Timeline Display'),
        QUERY_LIST => t('User List Display'),
      ),
      '#required' => TRUE,
      '#default_value' => $query_type,
      '#weight' => 3,
    );
    $form['tweet_feed_query_settings']['search_term'] = array(
      '#type' => 'textfield',
      '#title' => t('Twitter Search Term'),
      '#max_length' => 64,
      '#default_value' => $search_term,
      '#states' => array(
        'visible' => array(
          ':input[name="query_type"]' => array(
            'value' => QUERY_SEARCH,
          ),
        ),
      ),
      '#weight' => 4,
    );
    $form['tweet_feed_query_settings']['timeline_id'] = array(
      '#type' => 'textfield',
      '#title' => t('Twitter Screen Name For Timline Query'),
      '#max_length' => 64,
      '#default_value' => $timeline_id,
      '#states' => array(
        'visible' => array(
          ':input[name="query_type"]' => array(
            array(
              'value' => QUERY_TIMELINE,
            ),
            array(
              'value' => QUERY_LIST,
            ),
          ),
        ),
      ),
      '#weight' => 5,
    );
    $form['tweet_feed_query_settings']['list_name'] = array(
      '#type' => 'textfield',
      '#title' => t('List name'),
      '#description' => t('Enter the list name exactly as it appears on twitter.com'),
      '#max_length' => 64,
      '#default_value' => $list_name,
      '#states' => array(
        'visible' => array(
          ':input[name="query_type"]' => array(
            'value' => QUERY_LIST,
          ),
        ),
      ),
      '#weight' => 6,
    );
    $form['tweet_feed_query_settings']['pull_count'] = array(
      '#type' => 'textfield',
      '#title' => t('Number of tweets to pull per import.'),
      '#maxlength' => 3,
      '#size' => 3,
      '#description' => t('Twitter limits the number of tweets to 200 per request. If this value is > 200, it will have to be done in multiple requests. Please be aware of Twitter\'s API request limits, so you are not in violation.'),
      '#required' => TRUE,
      '#default_value' => $pull_count,
      '#weight' => 7,
    );
    $form['tweet_feed_query_settings']['new_window'] = array(
      '#type' => 'checkbox',
      '#title' => t('Open tweeted links, hashtags and mentions in a new window.'),
      '#default_value' => $new_window,
      '#weight' => 8,
    );
    $form['tweet_feed_query_settings']['hash_taxonomy'] = array(
      '#type' => 'checkbox',
      '#title' => t('Link hashtags to taxonomy terms instead of Twitter.'),
      '#default_value' => $hash_taxonomy,
      '#weight' => 9,
    );
    $form['tweet_feed_query_settings']['clear_prior'] = array(
      '#type' => 'checkbox',
      '#title' => t('Remove all tweets in this feed prior to import.'),
      '#default_value' => $clear_prior,
      '#weight' => 10,
    );
    $form = parent::buildForm($form, $form_state);
    return $form;
  }

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

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $values = $form_state
      ->getValues();
    $config = $this
      ->config('tweet_feed.twitter_feeds');
    $feeds = $config
      ->get('feeds');
    if (empty($values['feed_update'])) {
      $feed_machine_name = preg_replace('/[^a-z0-9]+/', '_', strtolower($values['feed_name']));
      if (!empty($feeds[$feed_machine_name])) {
        $suffix = 1;
        do {
          $new_feed_machine_name = $new_feed_machine_name . '_' . $suffix;
          $suffix++;
        } while (!empty($feeds[$new_feed_machine_name]));
        $feed_machine_name = $new_feed_machine_name;
      }
      if (empty($feeds[$feed_machine_name])) {
        $feeds[$feed_machine_name] = [];
      }
      else {
        $feed_machine_name = $values['feed_machine_name'];
      }
    }
    else {
      $feed_machine_name = $values['feed_machine_name'];
    }
    $feeds[$feed_machine_name]['aid'] = $values['aid'];
    $feeds[$feed_machine_name]['feed_name'] = $values['feed_name'];
    $feeds[$feed_machine_name]['query_type'] = $values['query_type'];
    $feeds[$feed_machine_name]['search_term'] = $values['search_term'];
    $feeds[$feed_machine_name]['timeline_id'] = $values['timeline_id'];
    $feeds[$feed_machine_name]['list_name'] = $values['list_name'];
    $feeds[$feed_machine_name]['pull_count'] = $values['pull_count'];
    $feeds[$feed_machine_name]['new_window'] = $values['new_window'];
    $feeds[$feed_machine_name]['hash_taxonomy'] = $values['hash_taxonomy'];
    $feeds[$feed_machine_name]['clear_prior'] = $values['clear_prior'];
    $this
      ->config('tweet_feed.twitter_feeds')
      ->set('feeds', $feeds)
      ->save();
    $url = Url::fromRoute('tweet_feed.twitter_feeds');
    $form_state
      ->setRedirectUrl($url);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBase::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create	18
ConfigFormBase::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object.	16
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	3
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.	3
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.
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.
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.
TwitterFeedsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
TwitterFeedsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
TwitterFeedsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
TwitterFeedsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
TwitterFeedsForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm

You are here

class TwitterFeedsForm in Tweet Feed 4.x

Hierarchy

File

Namespace

Members

API Navigation