Skip to content

[meta] Remove deprecated functions from Utility.class.inc #10094

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[meta] Remove deprecated functions from Utility.class.inc #10094

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
156 changes: 0 additions & 156 deletions php/libraries/Utility.class.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,29 +211,6 @@ class Utility
);
}

/**
* Get the list of sites as an associative array
*
* @param boolean $study_site if true only return study sites from psc
* table
* @param boolean $DCC Whether the DCC should be included or not
*
* @return array of the form CenterID => Site Name.
* Note that even though CenterID is numeric, the array
* should be interpreted as an associative array since the keys
* refer to the centerID, not the array index.
*
* @deprecated
*/
static function getAssociativeSiteList(
bool $study_site = true,
bool $DCC = true
): array {
throw new \DeprecatedException(
' This function is deprecated. Please use \Utility::getSiteList()'
. ' instead.'
);
}

/**
* Returns a list of study Visit Labels that are being used by this study.
Expand Down Expand Up @@ -468,30 +445,6 @@ class Utility
return $associative_array;
}

/**
* Ensures that $var is a collection of $var elements, not just a
* single element. This is useful for using config->getSetting for an element
* that may be in the config multiple times or may be in the config file a
* single time. By calling toArray, you ensure that the value you're working
* with is an array and don't need to determine if it's an array or a scalar.
* Note: This does not change a string into an array with one string element
* Note: This function should be used for tags with attributes
*
* @param mixed $var The variable to be converted to an array.
*
* @return array If $var is an array, var, otherwise an array containing $var
*
* @deprecated
*/
static function toArray($var)
{
throw new \DeprecatedException(
'Utility::toArray() is deprecated and should not be used. ' .
'Instead use Utility::associativeToNumericArray() for converting ' .
'arrays. Scalar values cannot be passed to this function.'
);
}

/**
* Takes a scalar value and returns an array containing that value as its
* only element.
Expand Down Expand Up @@ -537,96 +490,6 @@ class Utility
return $arr;
}

/**
* Get a list of instruments installed in Loris.
*
* @return array of the form Test_name => Full Description
*/
static function getAllInstruments(): array
{
error_log(
"LORIS Deprecation Warning: The getAllInstruments() function of ".
"the Utility class has been deprecated. This function does not load ".
"the most accurate Full_name value and should be replaced by ".
"getInstrumentNamesList() of the NDB_BVL_Instrument class."
);
$Factory = \NDB_Factory::singleton();
$DB = $Factory->Database();
$instruments_q = $DB->pselect(
"SELECT Test_name,Full_name FROM test_names ORDER BY Full_name",
[]
);
$instruments = [];
foreach ($instruments_q as $row) {
if (isset($row['Test_name']) && isset($row['Full_name'])) {
$instruments[$row['Test_name']] =$row['Full_name'];
}
}

return $instruments;
}

/**
* Get a list of DDE instruments installed in Loris.
*
* @return array of the form Test_name => Full Description
*/
static function getAllDDEInstruments(): array
{
error_log(
"LORIS Deprecation Warning: The getAllDDEInstruments() function of
the Utility class has been deprecated. This function does not load the
most accurate Full_name value and should be replaced by
getDDEInstrumentNamesList() of the NDB_BVL_Instrument class."
);
$Factory = \NDB_Factory::singleton();
$DB = $Factory->Database();
$ddeInstruments = $DB->pselect(
"SELECT DISTINCT test_battery.Test_name, Full_name
FROM test_battery
JOIN test_names ON test_battery.Test_name = test_names.Test_name
WHERE DoubleDataEntryEnabled = 'Y'",
[]
);
$instruments = [];
foreach ($ddeInstruments as $instrument) {
$instruments[$instrument['Test_name']] = $instrument['Full_name'];
}
return $instruments;
}

/**
* Gets a list of all instruments where are administered as direct data
* entry from subjects.
* This should return an array in a format suitable for addSelect() from
* NDB_Page
*
* @return array of test_names in a Test_Name => "Full Name"
*/
static function getDirectInstruments(): array
{
error_log(
"LORIS Deprecation Warning: The getDirectInstruments() function of
the Utility class has been deprecated. This function does not load the
most accurate Full_name value and should be replaced by
getDirectEntryInstrumentNamesList() of the NDB_BVL_Instrument class."
);
$factory = NDB_Factory::singleton();
$DB = $factory->database();

$instruments = [];
$instruments_q = $DB->pselect(
"SELECT Test_name,Full_name FROM test_names WHERE IsDirectEntry=true
ORDER BY Full_name",
[]
);
foreach ($instruments_q as $key) {
$instruments[$key['Test_name']] =$key['Full_name'];
}

return $instruments;
}

/**
* Checks to see if a table contains a specified column
*
Expand Down Expand Up @@ -737,25 +600,6 @@ class Utility
return iterator_to_array($sourcefields);
}

/**
* Returns a list of study Visit Labels that are being used by this study.
*
* @param integer|null $projectID Limit visit labels to labels used by this
* project.
*
* @return array<string,string> Study visits in the format array('VL' => 'VL')
* where VL is the visit label
*
* @deprecated
*/
static function getExistingVisitLabels(?int $projectID = null): array
{
throw new \DeprecatedException(
'This function is deprecated. Please use Utility::getVisitList() '
. 'instead.'
);
}

/**
* Get all the instruments which currently exist for a given visit label
* in the database.
Expand Down
Loading