aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/sabre/dav/tests/Sabre/DAV/Mock/Collection.php
blob: 041274706734fc6774971509679307292a1c1132 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
<?php

declare(strict_types=1);

namespace Sabre\DAV\Mock;

use Sabre\DAV;

/**
 * Mock Collection.
 *
 * This collection quickly allows you to create trees of nodes.
 * Children are specified as an array.
 *
 * Every key a filename, every array value is either:
 *   * an array, for a sub-collection
 *   * a string, for a file
 *   * An instance of \Sabre\DAV\INode.
 *
 * @copyright Copyright (C) fruux GmbH (https://fruux.com/)
 * @author Evert Pot (http://evertpot.com/)
 * @license http://sabre.io/license/ Modified BSD License
 */
class Collection extends DAV\Collection
{
    protected $name;
    protected $children;
    protected $parent;

    /**
     * Creates the object.
     *
     * @param string     $name
     * @param Collection $parent
     */
    public function __construct($name, array $children = [], Collection $parent = null)
    {
        $this->name = $name;
        foreach ($children as $key => $value) {
            if (is_string($value)) {
                $this->children[] = new File($key, $value, $this);
            } elseif (is_array($value)) {
                $this->children[] = new self($key, $value, $this);
            } elseif ($value instanceof \Sabre\DAV\INode) {
                $this->children[] = $value;
            } else {
                throw new \InvalidArgumentException('Unknown value passed in $children');
            }
        }
        $this->parent = $parent;
    }

    /**
     * Returns the name of the node.
     *
     * This is used to generate the url.
     *
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Creates a new file in the directory.
     *
     * Data will either be supplied as a stream resource, or in certain cases
     * as a string. Keep in mind that you may have to support either.
     *
     * After successful creation of the file, you may choose to return the ETag
     * of the new file here.
     *
     * The returned ETag must be surrounded by double-quotes (The quotes should
     * be part of the actual string).
     *
     * If you cannot accurately determine the ETag, you should not return it.
     * If you don't store the file exactly as-is (you're transforming it
     * somehow) you should also not return an ETag.
     *
     * This means that if a subsequent GET to this new file does not exactly
     * return the same contents of what was submitted here, you are strongly
     * recommended to omit the ETag.
     *
     * @param string          $name Name of the file
     * @param resource|string $data Initial payload
     *
     * @return string|null
     */
    public function createFile($name, $data = null)
    {
        if (null === $data) {
            $data = '';
        }
        if (is_resource($data)) {
            $data = stream_get_contents($data);
        }
        $this->children[] = new File($name, $data, $this);

        return '"'.md5($data).'"';
    }

    /**
     * Creates a new subdirectory.
     *
     * @param string $name
     */
    public function createDirectory($name)
    {
        $this->children[] = new self($name);
    }

    /**
     * Returns an array with all the child nodes.
     *
     * @return \Sabre\DAV\INode[]
     */
    public function getChildren()
    {
        return $this->children;
    }

    /**
     * Adds an already existing node to this collection.
     */
    public function addNode(\Sabre\DAV\INode $node)
    {
        $this->children[] = $node;
    }

    /**
     * Removes a childnode from this node.
     *
     * @param string $name
     */
    public function deleteChild($name)
    {
        foreach ($this->children as $key => $value) {
            if ($value->getName() == $name) {
                unset($this->children[$key]);

                return;
            }
        }
    }

    /**
     * Deletes this collection and all its children,.
     */
    public function delete()
    {
        foreach ($this->getChildren() as $child) {
            $this->deleteChild($child->getName());
        }
        $this->parent->deleteChild($this->getName());
    }
}