class Test in Security Review 8

A test security check for testing extensibility.

Hierarchy

• class \Drupal\security_review\Check uses DependencySerializationTrait, StringTranslationTrait
  • class \Drupal\security_review_test\Test

1 file declares its use of Test

security_review_test.module in tests/modules/security_review_test/security_review_test.module

Module that defines testable security checks for Security Review.

1 string reference to 'Test'

Test::getTitle in tests/modules/security_review_test/src/Test.php

Returns the human-readable title of the check.

File

tests/modules/security_review_test/src/Test.php, line 11

Namespace

Drupal\security_review_test

class Test extends Check {

  /**
   * {@inheritdoc}
   */
  public function getNamespace() {
    return 'Security Review Test';
  }

  /**
   * {@inheritdoc}
   */
  public function getTitle() {
    return 'Test';
  }

  /**
   * {@inheritdoc}
   */
  public function run() {
    $findings = [];
    for ($i = 0; $i < 20; ++$i) {
      $findings[] = rand(0, 1) ? rand(0, 10) : 'string';
    }
    return $this
      ->createResult(CheckResult::INFO, $findings);
  }

  /**
   * {@inheritdoc}
   */
  public function help() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getMessage($result_const) {
    return 'The test ran.';
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Check::$config	protected	property	The configuration storage for this check.
Check::$container	protected	property	The service container.
Check::$settings	protected	property	Settings handler for this check.
Check::$state	protected	property	The State system.
Check::$statePrefix	protected	property	The check's prefix in the State system.
Check::checklist	protected	function	Returns the Security Review Checklist service.
Check::configFactory	protected	function	Returns the Config factory.
Check::container	protected	function	Returns the service container.
Check::createResult	public	function	Creates a new CheckResult for this Check.
Check::currentUser	protected	function	Returns the current Drupal user.
Check::database	protected	function	Returns the database connection.
Check::enable	public	function	Enables the check. Has no effect if the check was not skipped.
Check::entityTypeManager	protected	function	Returns the entity type manager.
Check::evaluate	public	function	Returns the evaluation page of a result.	13
Check::evaluatePlain	public	function	Evaluates a CheckResult and returns a plaintext output.	12
Check::getMachineNamespace	public	function	Returns the namespace of the check.
Check::getMachineTitle	public	function	Returns the machine name of the check.	5
Check::id	final public	function	Returns the identifier constructed using the namespace and title values.
Check::isSkipped	public	function	Returns whether the check is skipped. Checks are not skipped by default.
Check::kernel	protected	function	Returns the Drupal Kernel.
Check::lastResult	public	function	Returns the last stored result of the check.
Check::lastRun	public	function	Returns the timestamp the check was last run.
Check::moduleHandler	protected	function	Returns the module handler.
Check::runCli	public	function	Same as run(), but used in CLI context such as Drush.	2
Check::security	protected	function	Returns the Security Review Security service.
Check::securityReview	protected	function	Returns the Security Review service.
Check::settings	public	function	Returns the check-specific settings' handler.
Check::skip	public	function	Marks the check as skipped.
Check::skippedBy	public	function	Returns the user the check was skipped by.
Check::skippedOn	public	function	Returns the timestamp the check was last skipped on.
Check::storeResult	public	function	Stores a result in the state system.
Check::storesFindings	public	function	Returns whether the findings should be stored or reproduced when needed.	2
Check::__construct	public	function	Initializes the configuration storage and the settings handler.	2
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
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.
Test::getMessage	public	function	Converts a result integer to a human-readable result message. Overrides Check::getMessage
Test::getNamespace	public	function	Returns the namespace of the check. Overrides Check::getNamespace
Test::getTitle	public	function	Returns the human-readable title of the check. Overrides Check::getTitle	1
Test::help	public	function	Returns the check-specific help page. Overrides Check::help
Test::run	public	function	The actual procedure of carrying out the check. Overrides Check::run