public function Robots::form in Metatag 8

Generate a form element for this meta tag.

Parameters

array $element: The existing form element to attach to.

Return value

array The completed form element.

Overrides MetaNameBase::form

File

src/Plugin/metatag/Tag/Robots.php, line 46

Class

Robots

The basic "Robots" meta tag.

Namespace

Drupal\metatag\Plugin\metatag\Tag

Code

public function form(array $element = []) {

  // Prepare the default value as it is stored as a string.
  $default_value = [];
  if (!empty($this->value)) {
    $default_value = explode(', ', $this->value);
  }
  $form = [
    '#type' => 'checkboxes',
    '#title' => $this
      ->label(),
    '#description' => $this
      ->description(),
    '#options' => [
      'index' => $this
        ->t('index - Allow search engines to index this page (assumed).'),
      'follow' => $this
        ->t('follow - Allow search engines to follow links on this page (assumed).'),
      'noindex' => $this
        ->t('noindex - Prevents search engines from indexing this page.'),
      'nofollow' => $this
        ->t('nofollow - Prevents search engines from following links on this page.'),
      'noarchive' => $this
        ->t('noarchive - Prevents cached copies of this page from appearing in search results.'),
      'nosnippet' => $this
        ->t('nosnippet - Prevents descriptions from appearing in search results, and prevents page caching.'),
      'noodp' => $this
        ->t('noodp - Blocks the <a href=":opendirectory">Open Directory Project</a> description from appearing in search results.', [
        ':opendirectory' => 'http://www.dmoz.org/',
      ]),
      'noydir' => $this
        ->t('noydir - Prevents Yahoo! from listing this page in the <a href=":ydir">Yahoo! Directory</a>.', [
        ':ydir' => 'http://dir.yahoo.com/',
      ]),
      'noimageindex' => $this
        ->t('noimageindex - Prevent search engines from indexing images on this page.'),
      'notranslate' => $this
        ->t('notranslate - Prevent search engines from offering to translate this page in search results.'),
    ],
    'index' => [
      '#states' => [
        'disabled' => [
          [
            ':input[name="robots[noindex]"]' => [
              'checked' => TRUE,
            ],
          ],
          'or',
          [
            ':input[name*="[robots][noindex]"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ],
    ],
    'noindex' => [
      '#states' => [
        'disabled' => [
          [
            ':input[name="robots[index]"]' => [
              'checked' => TRUE,
            ],
          ],
          'or',
          [
            ':input[name*="[robots][index]"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ],
    ],
    'follow' => [
      '#states' => [
        'disabled' => [
          [
            ':input[name="robots[nofollow]"]' => [
              'checked' => TRUE,
            ],
          ],
          'or',
          [
            ':input[name*="[robots][nofollow]"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ],
    ],
    'nofollow' => [
      '#states' => [
        'disabled' => [
          [
            ':input[name="robots[follow]"]' => [
              'checked' => TRUE,
            ],
          ],
          'or',
          [
            ':input[name*="[robots][follow]"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ],
    ],
    '#default_value' => $default_value,
    '#required' => isset($element['#required']) ? $element['#required'] : FALSE,
    '#element_validate' => [
      [
        get_class($this),
        'validateTag',
      ],
    ],
  ];
  return $form;
}