function AssetsStream::basePath

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/StreamWrapper/AssetsStream.php \Drupal\Core\StreamWrapper\AssetsStream::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::getContainer()->getParameter('site.path'));

Parameters

string $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.

Overrides PublicStream::basePath

1 call to AssetsStream::basePath()
FileSystemForm::buildForm in core/modules/system/src/Form/FileSystemForm.php
Form constructor.

File

core/lib/Drupal/Core/StreamWrapper/AssetsStream.php, line 41

Class

AssetsStream
Defines a Drupal stream wrapper class for optimized assets (assets://).

Namespace

Drupal\Core\StreamWrapper

Code

public static function basePath($site_path = NULL) : string {
    return Settings::get('file_assets_path', parent::basePath($site_path));
}

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