云客Drupal源码分析之php流Streams、公共文件、私有文件

在开始这个主题前我们做一个实验，在你的drupal模块控制器中加一行代码：

file_put_contents("public://yunke.txt","Streams test");

然后访问这个控制器，看看发生了什么？没错页面上不会有什么改变，但也没有报告什么错误，那这行代码到底干了什么？

作为开发者你应该很熟悉file_put_contents（）这个函数，代码意思是将"Streams test"这个字符串写入一个文件中，

可是文件名却是："public://yunke.txt",它是什么意思？文件保存了吗？保存到哪里去了？

这就是本主题要讲的内容！

不知道"public://yunke.txt",很正常，但你可能知道php://input，没错，就是那个php读取原始post输入的东西

在微信公众账号管理系统中就是用这个来读取收到的原始XML数据，其实public://yunke.txt和php://input差不多，它们源自同一个概念

就是php流及流包装器，由于在一般的开发中很少用到它，所以很多开发者并不熟悉，但它功能强大，是php这门语言的一个重点内容

在java中也有类似概念，如果你对C语言熟悉，那么会倍感熟悉，它或多或少基于ANSI C 标准IO函数簇。

由于php流这个知识点属于php学习的范畴，并不限于drupal源码分析，所以我单独写了篇博客来介绍它：

请看：http://blog.csdn.net/u011474028/article/details/52814049

那是本文的一部分，如果你对流不熟悉请务必暂停去阅读学习后再继续，否则你很难理解后面的内容，在文末附加一个流包装器的例子。

这里开始假定你已经学习完了流相关的知识，来看一看它在drupal8中的运用：

还是从file_put_contents("public://yunke.txt","Streams test");说起

它是在公共文件目录里面建立一个叫做yunke.txt的文件，里面保存了字符串"Streams test"，那么这个公共文件目录在哪里？

它可以在站点配置文件中指定，如果你没有指定，那么默认是\sites\default\files，如果你按上面的方法做了，看一看是不是有这个文件？

drupal使用流这个概念来储存公有及私有文件并提供操作上的方便，私有文件可以保存到一个web访客无法通过url访问到的地方，这样就比较安全了

如何在settings.php文件中配置公有及私有文件的主目录：

$settings['file_public_path'] = "./yunke"; //所有公共文件都将保存到站点根目录的yunke文件夹下，若无默认是\sites\default\files
$settings['file_private_path'] = “/home/yunke”; //设置后需要做权限设定，以防止web访客通过url访问到文件，配置中若有此项就会在容器中注册私有流包装器

关于流方面的源码储存在：\core\lib\Drupal\Core\StreamWrapper里面

定义了一个php级别的流包装器接口：PhpStreamWrapperInterface

drupal用的包装器接口（继承自上面的接口）：StreamWrapperInterface

LocalStream：抽象的本地流包装器

额外定义了公共流包装器、私有流包装器、临时流包装器、只读流

这些包装器用一个包装器管理器来管理：

StreamWrapperManager：实现了StreamWrapperManagerInterface接口，主要作用是注册流包装器

调用流包装器管理器的代码位于drupal核心：Drupal\Core\DrupalKernel的preHandle方法中，有以下代码：

// Register stream wrappers.
    $this->container->get('stream_wrapper_manager')->register();

而preHandle方法的调用是在多层HttpKernel核心处理中的预处理层：
http_middleware.kernel_pre_handle（Drupal\Core\StackMiddleware\KernelPreHandle）
请看前面的《云客Drupal8源码分析之HttpKernel堆栈》一文

 

以上就是本主题的全部了，下面提供一个流包装器案例，是我从drupal8中抽取出来，做了修改，可以独立使用的一个类，可以研究下它的实现：

 

class yunkeWrapper
{
    public $context;
    public $handle = null;
    public $uri = null;
    protected static $dir = "";
    //public $dir = "dir";//可以是相对路径或绝对路径，空表示当前路径

    public function dir_closedir()
    {
        closedir($this->handle);
        // We do not really have a way to signal a failure as closedir() does not
        // have