Database
+Overview
+PicoDatabase is a PHP class designed for simplified database interactions using PDO (PHP Data Objects). It provides methods to connect to a database, execute SQL commands, manage transactions, and fetch results in various formats. This manual outlines how to use the class, its features, and provides examples for reference.
Features
+-
+
- Connection Management: Establish and manage database connections. +
- SQL Execution: Execute various SQL commands such as INSERT, UPDATE, DELETE, and SELECT. +
- Transaction Handling: Support for committing and rolling back transactions. +
- Result Fetching: Fetch results in different formats (array, object, etc.). +
- Callbacks: Support for custom callback functions for query execution and debugging. +
- Unique ID Generation: Generate unique identifiers for database records. +
Installation
+To use the PicoDatabase class, ensure you have PHP with PDO support. Include the class file in your project, and you can instantiate it with your database credentials.
use MagicObject\Database\PicoDatabase;
+
+// Example credentials setup
+$credentials = new SecretObject();
+$db = new PicoDatabase($credentials);Credentials
+To create database credentials, please see the SecretObject section.
<?php
+
+namespace MagicObject\Database;
+
+use MagicObject\SecretObject;
+
+/**
+ * PicoDatabaseCredentials class
+ *
+ * This class encapsulates database credentials and utilizes the SecretObject to encrypt all attributes,
+ * ensuring the security of database configuration details from unauthorized access.
+ *
+ * It provides getter methods to retrieve database connection parameters such as driver, host, port,
+ * username, password, database name, schema, and application time zone.
+ *
+ * Example usage:
+ * ```php
+ * $credentials = new PicoDatabaseCredentials();
+ * $credentials->setHost('localhost');
+ * $credentials->setUsername('user');
+ * $credentials->setPassword('password');
+ * ```
+ *
+ * The attributes are automatically encrypted when set, providing a secure way to handle sensitive
+ * information within your application.
+ *
+ * @author Kamshory
+ * @package MagicObject\Database
+ * @link https://github.com/Planetbiru/MagicObject
+ */
+class PicoDatabaseCredentials extends SecretObject
+{
+ /**
+ * Database driver (e.g., 'mysql', 'pgsql').
+ *
+ * @var string
+ */
+ protected $driver = 'mysql';
+
+ /**
+ * Database server host.
+ *
+ * @EncryptIn
+ * @DecryptOut
+ * @var string
+ */
+ protected $host = 'localhost';
+
+ /**
+ * Database server port.
+ *
+ * @var int
+ */
+ protected $port = 3306;
+
+ /**
+ * Database username.
+ *
+ * @EncryptIn
+ * @DecryptOut
+ * @var string
+ */
+ protected $username = "";
+
+ /**
+ * Database user password.
+ *
+ * @EncryptIn
+ * @DecryptOut
+ * @var string
+ */
+ protected $password = "";
+
+ /**
+ * Database name.
+ *
+ * @EncryptIn
+ * @DecryptOut
+ * @var string
+ */
+ protected $databaseName = "";
+
+ /**
+ * Database schema (default: 'public').
+ *
+ * @EncryptIn
+ * @DecryptOut
+ * @var string
+ */
+ protected $databaseSchema = "public";
+
+ /**
+ * Application time zone.
+ *
+ * @var string
+ */
+ protected $timeZone = "Asia/Jakarta";
+}Class Methods
+Constructor
+public function __construct($databaseCredentials, $callbackExecuteQuery = null, $callbackDebugQuery = null)Parameters:
+-
+
SecretObject $databaseCredentials: Database credentials object.
+callable|null $callbackExecuteQuery: Optional callback for executing modifying queries. +-
+
- If the callback has 3 parameters, it will be:
+
-
+
$sqlQuery: The SQL query being executed.
+$params: The parameters used in the SQL query.
+$type: The type of query (e.g.,PicoDatabase::QUERY_INSERT).
+
+ - If the callback has 2 parameters, it will be:
+
-
+
$sqlQuery: The SQL query being executed.
+$type: The type of query.
+
+
+- If the callback has 3 parameters, it will be:
+
callable|null $callbackDebugQuery: Optional callback for debugging queries. +-
+
- If the callback has 2 parameters, it will be:
+
-
+
$sqlQuery: The SQL query being debugged.
+$params: The parameters used in the SQL query.
+
+ - If the callback has 1 parameter, it will be:
+
-
+
$sqlQuery: The SQL query being debugged.
+
+
+- If the callback has 2 parameters, it will be:
+
Connecting to the Database
+public function connect($withDatabase = true): boolParameters:
+-
+
bool $withDatabase: Whether to select the database upon connection.
+
Returns: true if connection is successful, false otherwise.
Disconnecting from the Database
+public function disconnect(): selfReturns: Current instance for method chaining.
+Query Execution
+public function query($sql, $params = null)Parameters:
+-
+
string $sql: SQL command to be executed.
+array|null $params: Optional parameters for the SQL query. +Returns: PDOStatement object orfalseon failure.
+
Fetch a Single Result
+public function fetch($sql, $tentativeType = PDO::FETCH_ASSOC, $defaultValue = null, $params = null)Parameters:
+-
+
string $sql: SQL command.
+int $tentativeType: Fetch mode (default isPDO::FETCH_ASSOC).
+mixed $defaultValue: Default value if no results found.
+array|null $params: Optional parameters. +Returns: Fetched result or default value.
+
Fetch All Results
+public function fetchAll($sql, $tentativeType = PDO::FETCH_ASSOC, $defaultValue = null, $params = null)Similar to fetch, but returns all matching results as an array.
+Transaction Management
+Commit Transaction
+public function commit(): boolReturns: true if successful.
+Rollback Transaction
+public function rollback(): boolReturns: true if successful.
+Unique ID Generation
+public function generateNewId(): stringReturns: A unique 20-byte ID.
+Last Inserted ID
+public function lastInsertId($name = null): string|falseParameters:
+-
+
- string|null $name: Sequence name (for PostgreSQL). +
Returns: The last inserted ID or false on error.
+Connection Status
+Check Connection
+public function isConnected(): boolExample Usage
+Connecting and Fetching Data
+// Instantiate PicoDatabase
+$db = new PicoDatabase($credentials);
+
+// Connect to the database
+if ($db->connect()) {
+ // Fetch a user by ID
+ $user = $db->fetch("SELECT * FROM users WHERE id = ?", [1]);
+ print_r($user);
+
+ // Disconnect
+ $db->disconnect();
+}Executing a Transaction
+$db->connect();
+$db->setAudoCommit(false); // Disable autocommit
+
+try {
+ $db->executeInsert("INSERT INTO users (name) VALUES (?)", ['John Doe']);
+ $db->commit(); // Commit the transaction
+} catch (Exception $e) {
+ $db->rollback(); // Rollback on error
+}Conclusion
+PicoDatabase is a robust class for managing database operations in PHP applications. By following the examples and method descriptions provided in this manual, you can effectively utilize its features for your database interactions. For further assistance, refer to the source code and documentation available at MagicObject GitHub.