class PathologicSettingsCommon in Pathologic 8

Hierarchy

• class \Drupal\pathologic\PathologicSettingsCommon uses StringTranslationTrait

2 files declare their use of PathologicSettingsCommon

FilterPathologic.php in src/Plugin/Filter/FilterPathologic.php

PathologicSettingsForm.php in src/PathologicSettingsForm.php

File

src/PathologicSettingsCommon.php, line 7

Namespace

Drupal\pathologic

class PathologicSettingsCommon {
  use StringTranslationTrait;

  /**
   * Common elements for the Pathologic configuration form.
   *
   * This reduces redundancy in code for form elements that will appear on both
   * the global settings form and the per-format filter settings form.
   *
   * @param array $defaults
   *   An array of default values for the configuration form fields.
   * @return
   *   The common form elements
   */
  public function commonSettingsForm(array $defaults) {
    return [
      'protocol_style' => [
        '#type' => 'radios',
        '#title' => $this
          ->t('Processed URL format'),
        '#default_value' => $defaults['protocol_style'],
        '#options' => [
          'full' => $this
            ->t('Full URL (<code>http://example.com/foo/bar</code>)'),
          'proto-rel' => $this
            ->t('Protocol relative URL (<code>//example.com/foo/bar</code>)'),
          'path' => $this
            ->t('Path relative to server root (<code>/foo/bar</code>)'),
        ],
        '#description' => t('The <em>Full URL</em> option is best for stopping broken images and links in syndicated content (such as in RSS feeds), but will likely lead to problems if your site is accessible by both HTTP and HTTPS. Paths output with the <em>Protocol relative URL</em> option will avoid such problems, but feed readers and other software not using up-to-date standards may be confused by the paths. The <em>Path relative to server root</em> option will avoid problems with sites accessible by both HTTP and HTTPS with no compatibility concerns, but will absolutely not fix broken images and links in syndicated content.'),
        '#weight' => 10,
      ],
      'local_paths' => [
        '#type' => 'textarea',
        '#title' => $this
          ->t('All base paths for this site'),
        '#default_value' => $defaults['local_paths'],
        '#description' => $this
          ->t('If this site is or was available at more than one base path or URL, enter them here, separated by line breaks. For example, if this site is live at <code>http://example.com/</code> but has a staging version at <code>http://dev.example.org/staging/</code>, you would enter both those URLs here. If confused, please read <a href=":docs" target="_blank">Pathologic&rsquo;s documentation</a> for more information about this option and what it affects.', [
          ':docs' => 'https://www.drupal.org/node/257026',
        ]),
        '#weight' => 20,
      ],
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PathologicSettingsCommon::commonSettingsForm	public	function	Common elements for the Pathologic configuration form.
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.