databases/Server.php at 1.2 · opulencephp/databases · GitHub

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
158
159
160
161
162
163
164
165
166
167
<?php

/*
 * Opulence
 *
 * @link      https://www.opulencephp.com
 * @copyright Copyright (C) 2021 David Young
 * @license   https://github.com/opulencephp/Opulence/blob/1.2/LICENSE.md
 */

namespace Opulence\Databases;

/**
 * Defines a database server
 */
class Server
{
    /** @var string The host of this server */
    protected $host = '';
    /** @var int|null The port this server listens on */
    protected $port;
    /** @var string The username to log in to the server */
    protected $username = '';
    /** @var string The password to log in to the server */
    protected $password = '';
    /** @var string The name of the database to connect to on the server */
    protected $databaseName = '';
    /** @var string The character set used by this server */
    protected $charset = 'utf8';

    /**
     * @param ?string $host The server host
     * @param ?string $username The username to log in to the server
     * @param ?string $password The password to log in to the server
     * @param ?string $databaseName The name of the database to connect to
     * @param ?int $port The port of this server
     * @param ?string $charset The character set used by this server
     */
    public function __construct(
        string $host = null,
        string $username = null,
        string $password = null,
        string $databaseName = null,
        int $port = null,
        string $charset = null
    ) {
        if ($host !== null) {
            $this->setHost($host);
        }

        if ($username !== null) {
            $this->setUsername($username);
        }

        if ($password !== null) {
            $this->setPassword($password);
        }

        if ($databaseName !== null) {
            $this->setDatabaseName($databaseName);
        }

        if ($port !== null) {
            $this->setPort($port);
        }

        if ($charset !== null) {
            $this->setCharset($charset);
        }
    }

    /**
     * @return string
     */
    public function getCharset() : string
    {
        return $this->charset;
    }

    /**
     * @return string
     */
    public function getDatabaseName() : string
    {
        return $this->databaseName;
    }

    /**
     * @return string
     */
    public function getHost() : string
    {
        return $this->host;
    }

    /**
     * @return string
     */
    public function getPassword() : string
    {
        return $this->password;
    }

    /**
     * @return int|null
     */
    public function getPort()
    {
        return $this->port;
    }

    /**
     * @return string
     */
    public function getUsername() : string
    {
        return $this->username;
    }

    /**
     * @param string $charset
     */
    public function setCharset(string $charset)
    {
        $this->charset = $charset;
    }

    /**
     * @param string $databaseName
     */
    public function setDatabaseName(string $databaseName)
    {
        $this->databaseName = $databaseName;
    }

    /**
     * @param string $host
     */
    public function setHost(string $host)
    {
        $this->host = $host;
    }

    /**
     * @param string $password
     */
    public function setPassword(string $password)
    {
        $this->password = $password;
    }

    /**
     * @param int $port
     */
    public function setPort(int $port)
    {
        $this->port = $port;
    }

    /**
     * @param string $username
     */
    public function setUsername(string $username)
    {
        $this->username = $username;
    }
}