You are here

public static function FileSecurity::writeHtaccess in Drupal 10

Same name in this branch
  1. 10 composer/Plugin/VendorHardening/FileSecurity.php \Drupal\Composer\Plugin\VendorHardening\FileSecurity::writeHtaccess()
  2. 10 core/lib/Drupal/Component/FileSecurity/FileSecurity.php \Drupal\Component\FileSecurity\FileSecurity::writeHtaccess()
Same name and namespace in other branches
  1. 8 core/lib/Drupal/Component/FileSecurity/FileSecurity.php \Drupal\Component\FileSecurity\FileSecurity::writeHtaccess()
  2. 9 core/lib/Drupal/Component/FileSecurity/FileSecurity.php \Drupal\Component\FileSecurity\FileSecurity::writeHtaccess()

Writes an .htaccess file in the given directory, if it doesn't exist.

Parameters

string $directory: The directory.

bool $deny_public_access: (optional) Set to FALSE to ensure an .htaccess file for an open and public directory. Default is TRUE.

bool $force: (optional) Set to TRUE to force overwrite an existing file.

Return value

bool TRUE if the file already exists or was created. FALSE otherwise.

8 calls to FileSecurity::writeHtaccess()
FileSecurityTest::testWriteHtaccessFailure in core/tests/Drupal/Tests/Component/FileSecurity/FileSecurityTest.php
@covers ::writeHtaccess
FileSecurityTest::testWriteHtaccessForceOverwrite in core/tests/Drupal/Tests/Component/FileSecurity/FileSecurityTest.php
@covers ::writeHtaccess
FileSecurityTest::testWriteHtaccessPrivate in core/tests/Drupal/Tests/Component/FileSecurity/FileSecurityTest.php
@covers ::writeHtaccess
FileSecurityTest::testWriteHtaccessPublic in core/tests/Drupal/Tests/Component/FileSecurity/FileSecurityTest.php
@covers ::writeHtaccess
FileStorage::ensureDirectory in core/lib/Drupal/Component/PhpStorage/FileStorage.php
Ensures the directory exists, has the right permissions, and a .htaccess.

... See full list

File

core/lib/Drupal/Component/FileSecurity/FileSecurity.php, line 28

Class

FileSecurity
Provides file security functions.

Namespace

Drupal\Component\FileSecurity

Code

public static function writeHtaccess($directory, $deny_public_access = TRUE, $force = FALSE) {
  return self::writeFile($directory, '.htaccess', self::htaccessLines($deny_public_access), $force);
}