summaryrefslogtreecommitdiffstats
path: root/app/class/pad.class.php
blob: 0c69385c3b815435b20ad16bea4d0d3ec3c5edab (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
<?php

/*
 * SCROTT IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 * For more information, please refer to UNLICENSE
 */

require_once "class/obj.class.php";
require_once "class/agent.class.php";
require_once "class/stage.class.php";

/*
 * This class models Scrott pads.  Pads are the space for projects to track
 * issues and communicate.
 */
class pad extends obj
{
    /*
     * Constructor
     */
    public function __construct(?string $guid = NULL)
    {
        $this->fields['pads'] = array(
            "guid",
            "stage",
            "issueNumb",
        );

        parent::__construct($guid);
        $this->expectType("pad");
    }

    /*
     * Get an array of all pads, sorted by name
     */
    public static function getAll_ordByName() : array
    {
        $query = "SELECT guid FROM objects WHERE objtype = 'pad' ORDER BY name";
        $res = database::query($query);

        $pads = array();

        foreach ($res as $p)
            $pads[] = new pad($p['guid']);

        return $pads;
    }

    /*
     * Get an array of all pads NOT owned by a group.  These are root-level
     * pads.  Results are sorted by name.
     */
    public static function getAllNoGroup_ordByName() : array
    {
        $query = "SELECT o.guid FROM objects o JOIN objects b ON o.owner = b.guid WHERE o.objtype = 'pad' AND " .
            "b.objtype = 'user' ORDER BY o.name";
        $res = database::query($query);

        $pads = array();

        foreach ($res as $p)
            $pads[] = new pad($p['guid']);

        return $pads;
    }

    /*
     * Initialize a new pad object with the given name and owner
     */
    public static function initNew(string $name, agent $owner) : pad
    {
        $pad = new pad();
        $pad->setOwner($owner);
        $pad->name = $name;
        $pad->objtype = "pad";
        $pad->issueNumb = 0;
        $pad->saveObj();
        return $pad;
    }

    /*
     * Get an array of all stages under this pad.  The array is in
     * proper sequential order.
     */
    public function getStages() : array
    {
        if (!isset($this->stage) || $this->stage == "")
            return array();

        $stage = new stage($this->stage);
        return $stage->getArray();
    }

    /*
     * Insert a stage object at the front of this pad's pipeline
     */
    public function insertStage(stage $stage) : void
    {
        $stage->stage = $this->stage;
        $this->stage = $stage->guid;
        $stage->saveObj();
        $this->saveObj();
    }

    /*
     * Get an array of all closed issues under this pad.  Ordered by
     * datetime closed.
     */
    public function getClosedIssues_ordByClosed() : array
    {
        $query = "SELECT o.guid FROM objects o JOIN issues i ON o.guid = i.guid " .
            "WHERE o.parent = '" . database::esc($this->guid) . "' ORDER BY i.closed DESC";
        $res = database::query($query);

        $issues = array();

        foreach ($res as $i)
            $issues[] = new issue($i['guid']);

        return $issues;
    }
}

?>