function PhpStreamWrapperInterface::mkdir

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/StreamWrapper/PhpStreamWrapperInterface.php \Drupal\Core\StreamWrapper\PhpStreamWrapperInterface::mkdir()
  2. 10 core/lib/Drupal/Core/StreamWrapper/PhpStreamWrapperInterface.php \Drupal\Core\StreamWrapper\PhpStreamWrapperInterface::mkdir()
  3. 11.x core/lib/Drupal/Core/StreamWrapper/PhpStreamWrapperInterface.php \Drupal\Core\StreamWrapper\PhpStreamWrapperInterface::mkdir()

Create a directory.

This method is called in response to mkdir()

Note, in order for the appropriate error message to be returned this method should not be defined if the wrapper does not support creating directories.

Note, the streamWrapper::$context property is updated if a valid context is passed to the caller function.

Parameters

string $path: Directory which should be created.

int $mode: The value passed to mkdir().

int $options: A bitwise mask of values, such as STREAM_MKDIR_RECURSIVE.

Return value

bool Returns TRUE on success or FALSE on failure.

See also

mkdir()

PhpStreamWrapperInterface::rmdir()

http://php.net/manual/en/streamwrapper.mkdir.php

2 methods override PhpStreamWrapperInterface::mkdir()
LocalStream::mkdir in core/lib/Drupal/Core/StreamWrapper/LocalStream.php
Create a directory.
ReadOnlyStream::mkdir in core/lib/Drupal/Core/StreamWrapper/ReadOnlyStream.php
Support for mkdir().

File

core/lib/Drupal/Core/StreamWrapper/PhpStreamWrapperInterface.php, line 101

Class

PhpStreamWrapperInterface
Defines a generic PHP stream wrapper interface.

Namespace

Drupal\Core\StreamWrapper

Code

public function mkdir($path, $mode, $options);

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