public static function PublicStream::basePath in Zircon Profile 8.0

Same name and namespace in other branches

8 core/lib/Drupal/Core/StreamWrapper/PublicStream.php \Drupal\Core\StreamWrapper\PublicStream::basePath()

Returns the base path for public://.

If we have a setting for the public:// scheme's path, we use that. Otherwise we build a reasonable default based on the site.path service if it's available, or a default behavior based on the request.

Note that this static method is used by \Drupal\system\Form\FileSystemForm so you should alter that form or substitute a different form if you change the class providing the stream_wrapper.public service.

The site path is injectable from the site.path service:

$base_path = PublicStream::basePath(\Drupal::service('site.path'));

Parameters

\SplString $site_path: (optional) The site.path service parameter, which is typically the path to sites/ in a Drupal installation. This allows you to inject the site path using services from the caller. If omitted, this method will use the global service container or the kernel's default behavior to determine the site path.

Return value

string The base path for public:// typically sites/default/files.

16 calls to PublicStream::basePath()

FileSystemForm::buildForm in core/modules/system/src/Form/FileSystemForm.php: Form constructor.
FileTransferTest::testJail in core/modules/system/src/Tests/FileTransfer/FileTransferTest.php
file_directory_temp in core/includes/file.inc: Gets and sets the path of the configured temporary directory.
FilterHtmlImageSecureTest::testImageSource in core/modules/filter/src/Tests/FilterHtmlImageSecureTest.php: Tests removal of images having a non-local source.
LocaleUpdateBase::setTranslationFiles in core/modules/locale/src/Tests/LocaleUpdateBase.php: Setup the environment containing local and remote translation files.

... See full list

File

core/lib/Drupal/Core/StreamWrapper/PublicStream.php, line 107: Contains \Drupal\Core\StreamWrapper\PublicStream.

Class

PublicStream: Defines a Drupal public (public://) stream wrapper class.

Namespace

Drupal\Core\StreamWrapper

Code

public static function basePath(\SplString $site_path = NULL) {
  if ($site_path === NULL) {

    // Find the site path. Kernel service is not always available at this
    // point, but is preferred, when available.
    if (\Drupal::hasService('kernel')) {
      $site_path = \Drupal::service('site.path');
    }
    else {

      // If there is no kernel available yet, we call the static
      // findSitePath().
      $site_path = DrupalKernel::findSitePath(Request::createFromGlobals());
    }
  }
  return Settings::get('file_public_path', $site_path . '/files');
}

You are here