aboutsummaryrefslogtreecommitdiff
path: root/lib/classes/AuthorObject.class.php
blob: b3e98e3a8ef6d22f1697610260d356502a52133f (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
<?php
# Lifter002: TEST
# Lifter007: TODO
# Lifter003: TODO
# Lifter010: TODO
// +--------------------------------------------------------------------------+
// This file is part of Stud.IP
// AuthorObject.class.php
//
// Class to provide basic properties of an object in Stud.IP
//
// Copyright (c) 2003 Alexander Willner <mail@AlexanderWillner.de>
// +--------------------------------------------------------------------------+
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or any later version.
// +--------------------------------------------------------------------------+
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
// +--------------------------------------------------------------------------+


define("ERROR_NORMAL", "1");
define("ERROR_CRITICAL", "8");


/**
 * AuthorObject.class.php
 *
 * Class to provide basic properties of an object in Stud.IP
 *
 * @author      Alexander Willner <mail@alexanderwillner.de>
 * @copyright   2003 Stud.IP-Project
 * @access      public
 * @package     studip_core
 * @modulegroup core
 */
class AuthorObject
{

    /**
     * Holds the code and description of an internal error
     * @access   private
     * @var      array $errorArray
     */
    public $errorArray;

    /**
     * Holds the type of object. See INSTANCEOF_*
     * @access   private
     * @var      string $instanceof
     */
    public $instanceof;

    /**
     * Constructor
     * @access   public
     */
    public function __construct()
    {
        $this->instanceof = 'AuthorObject';
        $this->errorArray = [];
    }

    /**
     * Gets the type of object
     * @access  public
     * @return  string The type of object. See INSTANCEOF_*
     */
    public function x_instanceof()
    {
        return $this->instanceof;
    }

    /**
     * Gives the internal errorcode
     * @access public
     * @return boolean True if an error exists
     */
    public function isError()
    {
        return count($this->errorArray) > 0;
    }

    /**
     * Gives the codes and descriptions of the internal errors
     * @access  public
     * @return  array  The errors as an Array like "1" => "Could not open DB"
     */
    public function getErrors()
    {
        return $this->errorArray;
    }

    /**
     * Resets the errorcodes and descriptions
     * @access public
     */
    public function resetErrors()
    {
        $this->errorArray = [];
    }

    /**
     * Sets the errorcode (internal)
     * @access  public
     * @param integer $errcode The code of the error
     * @param string $errstring The description of the error
     */
    public function throwError($errcode, $errstring)
    {
        if (!is_array($this->errorArray)) {
            $this->errorArray = [];
        }

        $this->errorArray [] = [
            'code'   => $errcode,
            'string' => $errstring,
        ];
    }

    /**
     * Sets the errorcode from other classes (internal)
     * @access  private
     * @param object $class The class with the error
     */
    public function throwErrorFromClass(AuthorObject $class)
    {
        $this->errorArray = $class->getErrors();
        $class->resetErrors();
    }
}