Documentation, format class, no modification. (#7629)

This commit is contained in:
frytimo
2025-11-19 12:48:36 -04:00
committed by GitHub
parent 0ea256fce8
commit 34821bed7e
36 changed files with 12982 additions and 11551 deletions

View File

@@ -25,54 +25,60 @@
Matthew Vale <github@mafoo.org>
*/
class tones {
class tones {
/**
* declare private variables
*/
private $music_list;
private $recordings_list;
private $default_tone_label;
private $database;
/**
* declare private variables
*/
private $music_list;
private $recordings_list;
private $default_tone_label;
private $database;
/**
* called when the object is created
*/
public function __construct(array $setting_array = []) {
//add multi-lingual support
$language = new text;
$text = $language->get();
/**
* Constructor for the class.
*
* This method initializes the object with setting_array and session data.
*
* @param array $setting_array An optional array of settings to override default values. Defaults to [].
*/
public function __construct(array $setting_array = []) {
//add multi-lingual support
$language = new text;
$text = $language->get();
//connect to the database
$this->database = $setting_array['database'] ?? database::new();
}
/**
* tones_list function
*
* @return array
*/
public function tones_list() {
//get the tones
$sql = "select * from v_vars ";
$sql .= "where var_category = 'Tones' ";
$sql .= "order by var_name asc ";
$tones = $this->database->select($sql, null, 'all');
if (!empty($tones)) {
foreach ($tones as $tone) {
$tone = $tone['var_name'];
if (isset($text['label-'.$tone])) {
$label = $text['label-'.$tone];
}
else {
$label = $tone;
}
$tone_list[$tone] = $label;
}
}
unset($sql, $tones, $tone);
//return the tones
return $tone_list ?? [];
}
//connect to the database
$this->database = $setting_array['database'] ?? database::new();
}
/**
* Retrieves a list of tone names with their corresponding labels.
*
* This method fetches tone data from the database and formats it for display.
*
* @return array An array of tone names as keys and their labels as values. If no tones are found, an empty array
* is returned.
*/
public function tones_list() {
//get the tones
$sql = "select * from v_vars ";
$sql .= "where var_category = 'Tones' ";
$sql .= "order by var_name asc ";
$tones = $this->database->select($sql, null, 'all');
if (!empty($tones)) {
foreach ($tones as $tone) {
$tone = $tone['var_name'];
if (isset($text['label-' . $tone])) {
$label = $text['label-' . $tone];
} else {
$label = $tone;
}
$tone_list[$tone] = $label;
}
}
unset($sql, $tones, $tone);
//return the tones
return $tone_list ?? [];
}
}