Skip to content

Fix comments php-doc for Setting #194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cedricfrancoys merged 1 commit into from
Oct 13, 2024
Merged

Fix comments php-doc for Setting #194

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions packages/core/classes/setting/Setting.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,12 +182,12 @@ public function getUnique() {
/**
* Retrieve the value of a given setting.
*
* @param $package Package to which the setting relates to.
* @param $section Specific section within the package.
* @param $code Unique code of the setting within the given package and section.
* @param $default (optional) Default value to return if setting is not found.
* @param $selector (optional) Retrieve the specific value assigned to a given user.
* @param $lang (optional) Lang in which to retrieve the value (for multilang settings).
* @param string $package Package to which the setting relates to.
* @param string $section Specific section within the package.
* @param string $code Unique code of the setting within the given package and section.
* @param mixed $default (optional) Default value to return if setting is not found.
* @param array $selector (optional) Retrieve the specific value assigned to a given user.
* @param string|null $lang (optional) Lang in which to retrieve the value (for multilang settings).
*
* @return mixed Returns the value of the target setting or null if the setting parameter is not found. The type of the returned var depends on the setting's `type` field.
*/
Expand Down Expand Up @@ -255,15 +255,16 @@ public static function get_value(string $package, string $section, string $code,
/**
* Update the value of a given setting.
*
* @param $package Package to which the setting relates to.
* @param $section Specific section within the package.
* @param $code Unique code of the setting within the given package and section.
* @param $value The new value that has to be assigned to the setting.
* @param $selector (optional) Target the specific value assigned to a given user.
* @param string $package Package to which the setting relates to.
* @param string $section Specific section within the package.
* @param string $code Unique code of the setting within the given package and section.
* @param mixed $value The new value that has to be assigned to the setting.
* @param array $selector (optional) Target the specific value assigned to a given user.
* @param string|null $lang (optional) Lang in which to retrieve the value (for multilang settings).
*
* @return void
*/
public static function set_value(string $package, string $section, string $code, $value, array $selector=[], $lang=null) {
public static function set_value(string $package, string $section, string $code, $value, array $selector=[], string $lang=null) {
$providers = \eQual::inject(['orm']);
$om = $providers['orm'];

Expand Down