class SecuritytxtSerializer in Security.txt 8

Securitytxt serializer class.

Formats the security.txt and security.txt.sig output files.

Hierarchy

• class \Drupal\securitytxt\SecuritytxtSerializer

1 file declares its use of SecuritytxtSerializer

SecuritytxtController.php in src/Controller/SecuritytxtController.php

1 string reference to 'SecuritytxtSerializer'

securitytxt.services.yml in ./securitytxt.services.yml

securitytxt.services.yml

1 service uses SecuritytxtSerializer

securitytxt.serializer in ./securitytxt.services.yml

Drupal\securitytxt\SecuritytxtSerializer

File

src/SecuritytxtSerializer.php, line 14

Namespace

Drupal\securitytxt

class SecuritytxtSerializer {

  /**
   * Gets the body of a security.txt file.
   *
   * @param \Drupal\Core\Config\ImmutableConfig $settings
   *   A 'securitytxt.settings' config instance.
   *
   * @return string
   *   The body of a security.txt file.
   *
   * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
   *   When the security.txt file is disabled.
   */
  public function getSecuritytxtFile(ImmutableConfig $settings) {
    $enabled = $settings
      ->get('enabled');
    $contact_email = $settings
      ->get('contact_email');
    $contact_phone = $settings
      ->get('contact_phone');
    $contact_url = $settings
      ->get('contact_url');
    $encryption_key_url = $settings
      ->get('encryption_key_url');
    $policy_url = $settings
      ->get('policy_url');
    $acknowledgement_url = $settings
      ->get('acknowledgement_url');
    $signature_url = Url::fromRoute('securitytxt.securitytxt_signature')
      ->setAbsolute()
      ->toString();
    if ($enabled) {
      $content = '';
      if ($contact_email != '') {
        $content .= 'Contact: ' . $contact_email . "\n";
      }
      if ($contact_phone) {
        $content .= 'Contact: ' . $contact_phone . "\n";
      }
      if ($contact_url != '') {
        $content .= 'Contact: ' . $contact_url . "\n";
      }
      if ($encryption_key_url != '') {
        $content .= 'Encryption: ' . $encryption_key_url . "\n";
      }
      if ($policy_url != '') {
        $content .= 'Policy: ' . $policy_url . "\n";
      }
      if ($acknowledgement_url != '') {
        $content .= 'Acknowledgement: ' . $acknowledgement_url . "\n";
      }
      $content .= 'Signature: ' . $signature_url . "\n";
      return $content;
    }
    else {
      throw new NotFoundHttpException();
    }
  }

  /**
   * Gets the body of a security.txt.sig file.
   *
   * @param \Drupal\Core\Config\ImmutableConfig $settings
   *   A 'securitytxt.settings' config instance.
   *
   * @return string
   *   The body of a security.txt.sig file.
   *
   * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
   *   When the security.txt file is disabled.
   */
  public function getSecuritytxtSignature(ImmutableConfig $settings) {
    $enabled = $settings
      ->get('enabled');
    $signature_text = $settings
      ->get('signature_text');
    if ($enabled) {
      return $signature_text;
    }
    else {
      throw new NotFoundHttpException();
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
SecuritytxtSerializer::getSecuritytxtFile	public	function	Gets the body of a security.txt file.
SecuritytxtSerializer::getSecuritytxtSignature	public	function	Gets the body of a security.txt.sig file.