PrivateKey.php

Same filename in other branches
  1. 9 core/lib/Drupal/Core/PrivateKey.php
  2. 10 core/lib/Drupal/Core/PrivateKey.php
  3. 11.x core/lib/Drupal/Core/PrivateKey.php

Namespace

Drupal\Core

File

core/lib/Drupal/Core/PrivateKey.php

View source
<?php

namespace Drupal\Core;

use Drupal\Core\State\StateInterface;
use Drupal\Component\Utility\Crypt;

/**
 * Manages the Drupal private key.
 */
class PrivateKey {
    
    /**
     * The state service.
     *
     * @var \Drupal\Core\State\StateInterface
     */
    protected $state;
    
    /**
     * Constructs the private key object.
     *
     * @param \Drupal\Core\State\StateInterface $state
     *   The state service.
     */
    public function __construct(StateInterface $state) {
        $this->state = $state;
    }
    
    /**
     * Gets the private key.
     *
     * @return string
     *   The private key.
     */
    public function get() {
        if (!($key = $this->state
            ->get('system.private_key'))) {
            $key = $this->create();
            $this->set($key);
        }
        return $key;
    }
    
    /**
     * Sets the private key.
     *
     * @param string $key
     *   The private key to set.
     */
    public function set($key) {
        return $this->state
            ->set('system.private_key', $key);
    }
    
    /**
     * Creates a new private key.
     *
     * @return string
     *   The private key.
     */
    protected function create() {
        return Crypt::randomBytesBase64(55);
    }

}

Classes

Title Deprecated Summary
PrivateKey Manages the Drupal private key.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.