class AdsenseCseSettings in Google AdSense integration 8

Form for the adsense CSE settings.

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\adsense\Form\AdsenseCseSettings

Expanded class hierarchy of AdsenseCseSettings

1 string reference to 'AdsenseCseSettings'

adsense.routing.yml in ./adsense.routing.yml: adsense.routing.yml

File

src/Form/AdsenseCseSettings.php, line 14

Namespace

Drupal\adsense\Form

View source

class AdsenseCseSettings extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('adsense.settings');
    $form['searchbox'] = [
      '#type' => 'details',
      '#open' => TRUE,
      '#title' => $this
        ->t('Search Box Options'),
    ];
    $form['searchbox']['adsense_cse_logo'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Logo Type'),
      '#default_value' => $config
        ->get('adsense_cse_logo'),
      '#options' => [
        'adsense_cse_branding_watermark' => $this
          ->t('Watermark on search box (requires JavaScript)'),
        'adsense_cse_branding_right' => $this
          ->t('Next to the search box'),
        'adsense_cse_branding_bottom' => $this
          ->t('Below the search box'),
      ],
    ];
    $form['searchbox']['adsense_cse_color_box_background'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Background color'),
      '#default_value' => $config
        ->get('adsense_cse_color_box_background'),
      '#options' => [
        'FFFFFF' => $this
          ->t('White'),
        '999999' => $this
          ->t('Gray'),
        '000000' => $this
          ->t('Black'),
      ],
    ];
    $form['searchbox']['adsense_cse_encoding'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Site Encoding'),
      '#default_value' => $config
        ->get('adsense_cse_encoding'),
      '#options' => CustomSearchAd::adsenseEncodings(),
    ];
    $form['searchbox']['adsense_cse_textbox_length'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Text Box Length'),
      '#default_value' => $config
        ->get('adsense_cse_textbox_length'),
      '#size' => 2,
      '#min' => 8,
      '#max' => 64,
    ];
    $form['searchbox']['adsense_cse_language'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Watermark Language'),
      '#default_value' => $config
        ->get('adsense_cse_language'),
      '#options' => CustomSearchAd::adsenseLanguages(),
    ];
    $form['result'] = [
      '#type' => 'details',
      '#open' => TRUE,
      '#title' => $this
        ->t('Search Results Style'),
    ];
    $form['result']['adsense_cse_country'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Country or territory for Google domain'),
      '#default_value' => $config
        ->get('adsense_cse_country'),
      '#options' => CustomSearchAd::adsenseCountries(),
    ];
    $form['result']['adsense_cse_frame_width'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Width of results area'),
      '#default_value' => $config
        ->get('adsense_cse_frame_width'),
      '#field_suffix' => ' ' . $this
        ->t('pixels'),
      '#size' => 3,
      '#maxlength' => 4,
      '#min' => $form_state
        ->getValue('adsense_cse_ad_location') == 'adsense_cse_loc_top_bottom' ? 500 : 795,
      '#max' => 10000,
    ];
    $form['result']['adsense_cse_ad_location'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Ad Location'),
      '#default_value' => $config
        ->get('adsense_cse_ad_location'),
      '#options' => [
        'adsense_cse_loc_top_right' => $this
          ->t('Top and Right'),
        'adsense_cse_loc_top_bottom' => $this
          ->t('Top and Bottom'),
        'adsense_cse_loc_right' => $this
          ->t('Right'),
      ],
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->configFactory()
      ->getEditable('adsense.settings');
    $form_state
      ->cleanValues();
    foreach ($form_state
      ->getValues() as $key => $value) {
      $config
        ->set($key, Html::escape($value));
    }
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AdsenseCseSettings::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
AdsenseCseSettings::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
AdsenseCseSettings::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
AdsenseCseSettings::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
ConfigFormBase::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create	13
ConfigFormBase::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object.	11
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.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
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.
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 AdsenseCseSettings in Google AdSense integration 8

Hierarchy

File

Namespace

Members

API Navigation