summaryrefslogtreecommitdiff
path: root/buildscripts/phing/classes/phing/util/DataStore.php
blob: af696697b1d01ca5b5f6f8c6c4f2c3f5c7586c17 (plain)
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
<?php

/*
 *  $Id: 77f24d8b9d8082b4c23cb4cd5d23a06a3be88e2d $
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the LGPL. For more information please see
 * <http://phing.info>.
 */
 
require_once 'phing/system/io/PhingFile.php';
require_once 'phing/system/io/FileWriter.php';

/**
 * An abstract representation of file and directory pathnames.
 *
 * @package phing.util
 * @author  Michiel Rook <mrook@php.net>
 * @version $Id$
 */
class DataStore
{
    private $data = array();    
    private $file = null;
    
    /**
     * Constructs a new data store
     *
     * @param PhingFile $file object pointing to the data store on disk
     */
    function __construct(PhingFile $file)
    {
        $this->file = $file;
        
        if ($this->file->exists())
        {
            $this->read();
        }
    }
    
    /**
     * Destructor
     */
    function __destruct()
    {
        $this->commit();
    }
    
    /**
     * Retrieves a value from the data store
     *
     * @param string $key the key
     *
     * @return mixed the value
     */
    public function get($key)
    {
        if (!isset($this->data[$key]))
        {
            return null;
        }
        else
        {
            return $this->data[$key];
        }
    }
    
    /**
     * Adds a value to the data store
     *
     * @param string  $key        the key
     * @param mixed   $value      the value
     * @param boolean $autocommit whether to auto-commit (write) 
     *                            the data store to disk
     *
     * @return none
     */
    public function put($key, $value, $autocommit = false)
    {
        $this->data[$key] = $value;
        
        if ($autocommit)
        {
            $this->commit();
        }
    }
    
    /**
     * Commits data store to disk
     *
     * @return none
     */
    public function commit()
    {
        $this->write();
    }
    
    /**
     * Internal function to read data store from file
     *
     * @return none
     */
    private function read()
    {
        if (!$this->file->canRead())
        {
            throw new BuildException("Can't read data store from '" . 
                $file->getPath() . "'");
        }
        else
        {
            $serializedData = $this->file->contents();
            
            $this->data = unserialize($serializedData);
        }
    }

    /**
     * Internal function to write data store to file
     *
     * @return none
     */
    private function write()
    {
        if (!$this->file->canWrite())
        {
            throw new BuildException("Can't write data store to '" . 
                $file->getPath() . "'");
        }
        else
        {
            $serializedData = serialize($this->data);

            $writer = new FileWriter($this->file);
            $writer->write($serializedData);
            $writer->close();
        }
    }    
};