[update] update doc for v2.2.0

Author: catfan

LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Angel Lai
+Copyright (c) 2025 Angel Lai
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -15,22 +15,22 @@
 
 ## Features
 
-* **Lightweight** - Portable with only one file.
+* **Lightweight** - Single-file framework with minimal dependencies.
 
-* **Easy** - Easy to learn and use, with a friendly construction.
+* **Easy** - Simple and intuitive API for quick integration.
 
-* **Powerful** - Supports various common and complex SQL queries, data mapping and prevents SQL injection.
+* **Powerful** - Supports complex SQL queries, data mapping, and SQL injection prevention.
 
-* **Compatible** - Supports MySQL, MSSQL, SQLite, MariaDB, PostgreSQL, Sybase, Oracle, and more.
+* **Compatible** - Works with MySQL, MariaDB, PostgreSQL, SQLite, MSSQL, Oracle, Sybase, and more.
 
-* **Friendly** - Works well with every PHP framework, such as Laravel, Codeigniter, Yii, Slim, and frameworks that support singleton extension or composer.
+* **Friendly** - Integrates seamlessly with Laravel, CodeIgniter, Yii, Slim, and other PHP frameworks.
 
-* **Free** - Under the MIT license, you can use it anywhere, for whatever purpose.
+* **Free** - Licensed under MIT, free to use for any purpose.
 
 ## Requirements
 
-- PHP 7.3+
-- Installed PDO extension
+- PHP 7.3 or later
+- PDO extension enabled
 
 ## Get Started
 
@@ -41,19 +41,19 @@ Add Medoo to the `composer.json` configuration file.
 $ composer require catfan/medoo
 ```
 
-And update the composer
+Then update Composer
 ```bash
 $ composer update
 ```
 
 ```php
-// Require Composer's autoloader.
+// Require Composer's autoloader
 require 'vendor/autoload.php';
 
-// Use the Medoo namespace.
+// Import Medoo namespace
 use Medoo\Medoo;
 
-// Connect to the database.
+// Initialize database connection
 $database = new Medoo([
     'type' => 'mysql',
     'host' => 'localhost',
@@ -62,11 +62,13 @@ $database = new Medoo([
     'password' => 'your_password'
 ]);
 
+// Insert data
 $database->insert('account', [
     'user_name' => 'foo',
     'email' => 'foo@bar.com'
 ]);
 
+// Retrieve data
 $data = $database->select('account', [
     'user_name',
     'email'
@@ -83,18 +85,24 @@ echo json_encode($data);
 ```
 
 ## Contribution Guidelines
+Before submitting a pull request, ensure compatibility with multiple database engines and include unit tests when possible.
 
-Before starting a new pull request, please ensure compatibility with other databases and write unit tests whenever possible.
+### Testing & Code Style
+- Run `phpunit tests` to execute unit tests.
+- Use `php-cs-fixer fix` to enforce code style consistency.
 
-Run `phpunit tests` for unit testing and `php-cs-fixer fix` to fix code style.
+### Commit Message Format
+Each commit should begin with a tag indicating the type of change:
 
-Each commit should start with a tag indicating the type of change: `[fix]`, `[feature]`, or `[update]`.
+- `[fix]` for bug fixes
+- `[feature]` for new features
+- `[update]` for improvements
 
-Please keep it simple and keep it clear.
+Keep contributions simple and well-documented.
 
 ## License
 
-Medoo is released under the MIT license.
+Medoo is released under the MIT License.
 
 ## Links
 

src/Medoo.php

@@ -6,10 +6,10 @@
  *
  * The Lightweight PHP Database Framework to Accelerate Development.
  *
- * @version 2.1.12
- * @author Angel Lai
+ * @version 2.2.0
  * @package Medoo
- * @copyright Copyright 2024 Medoo Project, Angel Lai.
+ * @author Angel Lai
+ * @copyright Angel Lai
  * @license https://opensource.org/licenses/MIT
  * @link https://medoo.in
  */
@@ -71,28 +71,28 @@ class Raw
 class Medoo
 {
     /**
-     * The PDO object.
+     * The PDO database connection instance.
      *
      * @var \PDO
      */
     public $pdo;
 
     /**
-     * The type of database.
+     * The database type.
      *
      * @var string
      */
     public $type;
 
     /**
-     * Table prefix.
+     * The table prefix.
      *
      * @var string
      */
     protected $prefix;
 
     /**
-     * The PDO statement object.
+     * Current PDO statement instance.
      *
      * @var \PDOStatement
      */
@@ -106,91 +106,91 @@ class Medoo
     protected $dsn;
 
     /**
-     * The array of logs.
+     * Logged queries.
      *
      * @var array
      */
     protected $logs = [];
 
     /**
-     * Determine should log the query or not.
+     * Whether query logging is enabled.
      *
      * @var bool
      */
     protected $logging = false;
 
     /**
-     * Determine is in test mode.
+     * Whether the database is in test mode.
      *
      * @var bool
      */
     protected $testMode = false;
 
     /**
-     * The last query string was generated in test mode.
+     * The last generated query string in test mode.
      *
      * @var string
      */
     public $queryString;
 
     /**
-     * Determine is in debug mode.
+     * Whether debug mode is enabled.
      *
      * @var bool
      */
     protected $debugMode = false;
 
     /**
-     * Determine should save debug logging.
+     * Whether debug logging is enabled.
      *
      * @var bool
      */
     protected $debugLogging = false;
 
     /**
-     * The array of logs for debugging.
+     * Logged debug queries.
      *
      * @var array
      */
     protected $debugLogs = [];
 
     /**
-     * The unique global id.
+     * The unique global identifier.
      *
-     * @var integer
+     * @var int
      */
     protected $guid = 0;
 
     /**
-     * The returned id for the insert.
+     * The last inserted record ID.
      *
      * @var string
      */
     public $returnId = '';
 
     /**
-     * Error Message.
+     * The last error message.
      *
      * @var string|null
      */
     public $error = null;
 
     /**
-     * The array of error information.
+     * The last error details.
      *
      * @var array|null
      */
     public $errorInfo = null;
 
     /**
-     * The keyword to connect the table alias.
+     * The connector used for table aliases.
      *
      * @var string
      */
     protected $tableAliasConnector = ' AS ';
 
     /**
-     * The quote pattern string.
+     * The pattern used for quoting identifiers.
      *
      * @var string
      */
@@ -218,11 +218,13 @@ class Medoo
     protected const ALIAS_PATTERN = "[\p{L}_][\p{L}\p{N}@$#\-_]*";
 
     /**
-     * Connect the database.
+     * Establish a database connection.
      *
+     * Example usage:
+     * 
      * ```
      * $database = new Medoo([
-     *      // required
+     *      // Required
      *      'type' => 'mysql',
      *      'database' => 'name',
      *      'host' => 'localhost',
@@ -238,7 +240,7 @@ class Medoo
      *
      * @param array $options Connection options
      * @return Medoo
-     * @throws PDOException
+     * @throws PDOException If the connection fails
      * @link https://medoo.in/api/new
      * @codeCoverageIgnore
      */
@@ -519,6 +521,7 @@ public function __construct(array $options)
     /**
      * Setup the database type.
      *
+     * @param string The database type string.
      * @return void
      */
     public function setupType(string $type)
@@ -744,9 +747,9 @@ function ($matches) {
     }
 
     /**
-     * Quote a string for use in a query.
+     * Escape and quote a string for use in an SQL query.
      *
-     * @param string $string
+     * @param string $string The string to be quoted.
      * @return string
      */
     public function quote(string $string): string
@@ -759,10 +762,11 @@ public function quote(string $string): string
     }
 
     /**
-     * Quote table name for use in a query.
+     * Quote a table name for use in an SQL query.
      *
-     * @param string $table
+     * @param string $table The table name to be quoted.
      * @return string
+     * @throws InvalidArgumentException If the table name is invalid.
      */
     public function tableQuote(string $table): string
     {
@@ -774,10 +778,11 @@ public function tableQuote(string $table): string
     }
 
     /**
-     * Quote column name for use in a query.
+     * Quote a column name for use in an SQL query.
      *
-     * @param string $column
+     * @param string $column The column name to be quoted.
      * @return string
+     * @throws InvalidArgumentException If the column name is invalid.
      */
     public function columnQuote(string $column): string
     {