function Updater::getProjectTitle

Same name in other branches
  1. 7.x includes/updater.inc \Updater::getProjectTitle()
  2. 9 core/lib/Drupal/Core/Updater/Updater.php \Drupal\Core\Updater\Updater::getProjectTitle()
  3. 8.9.x core/lib/Drupal/Core/Updater/Updater.php \Drupal\Core\Updater\Updater::getProjectTitle()
  4. 11.x core/lib/Drupal/Core/Updater/Updater.php \Drupal\Core\Updater\Updater::getProjectTitle()

Returns the project name from a Drupal info file.

Parameters

string $directory: Directory to search for the info file.

Return value

string The title of the project.

Throws

\Drupal\Core\Updater\UpdaterException

3 calls to Updater::getProjectTitle()
UpdateManagerInstall::submitForm in core/modules/update/src/Form/UpdateManagerInstall.php
Form submission handler.
Updater::__construct in core/lib/Drupal/Core/Updater/Updater.php
Constructs a new updater.
UpdaterTest::testGetProjectTitleWithChild in core/tests/Drupal/KernelTests/Core/Updater/UpdaterTest.php
Tests project and child project showing correct title.

File

core/lib/Drupal/Core/Updater/Updater.php, line 188

Class

Updater
Defines the base class for Updaters used in Drupal.

Namespace

Drupal\Core\Updater

Code

public static function getProjectTitle($directory) {
    $info_file = self::findInfoFile($directory);
    $info = \Drupal::service('info_parser')->parse($info_file);
    if (empty($info)) {
        throw new UpdaterException("Unable to parse info file: '{$info_file}'.");
    }
    return $info['name'];
}

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