Create more documentation (#7627)

* Documentation, format class, no modification.
This commit is contained in:
frytimo
2025-11-18 21:33:07 -04:00
committed by GitHub
parent e619c97ce6
commit adfc4cc469
104 changed files with 24461 additions and 21721 deletions

View File

@@ -68,7 +68,9 @@
private $toggle_values;
/**
* called when the object is created
* Initializes the object with settings and default values.
*
* @param array $setting_array Associative array of setting keys to their respective values (optional)
*/
public function __construct(array $setting_array = []) {
//set domain and user UUIDs
@@ -92,7 +94,13 @@
}
/**
* delete records
* Deletes one or multiple records from the access controls table.
*
* @param array $records An array of record IDs to delete, where each ID is an associative array
* containing 'uuid' and 'checked' keys. The 'checked' value indicates
* whether the corresponding checkbox was checked for deletion.
*
* @return void No return value; this method modifies the database state and sets a message.
*/
public function delete($records) {
if (permission_exists($this->permission_prefix.'delete')) {
@@ -141,7 +149,13 @@
}
/**
* toggle records
* Toggles the state of the specified records.
*
* @param array $records An array of record IDs to delete, where each ID is an associative array
* containing 'uuid' and 'checked' keys. The 'checked' value indicates
* whether the corresponding checkbox was checked for deletion.
*
* @return void No return value; this method modifies the database state and sets a message.
*/
public function toggle($records) {
if (permission_exists($this->permission_prefix.'edit')) {
@@ -212,7 +226,12 @@
}
/**
* copy records
* Copies one or more records
* @param array $records An array of record IDs to delete, where each ID is an associative array
* containing 'uuid' and 'checked' keys. The 'checked' value indicates
* whether the corresponding checkbox was checked for deletion.
*
* @return void No return value; this method modifies the database state and sets a message.
*/
public function copy($records) {
if (permission_exists($this->permission_prefix.'add')) {