[Core-Database] added 2 new functions to help avoid code duplication

[ridz1208]

This adds 2 new functions to the database.class.inc that build on the pselect() and pselectCol() in order to return an array indexed by a selected primary key. These functions are meant to replace the multitude of places in the code where the pselect() and pselectCol() result is ran through a foreach loop in order to extract and re-index the array using its primary keys.

The necessary Exceptions are thrown to avoid data being overwritten in the built array and misuse of the function in general

[ridz1208]

@HenriRabalais this might be useful for you

[driusan]

It looks like it needs to be a unique non-null column, not necessarily a primary key (which also affects the function name..)

[ridz1208]

yeah your correct I had primary key everywhere before then changed it all except here I guess

[ridz1208]

@driusan fixed

[driusan]

@ridz1208 The function names still reference "primary"

[ridz1208]

@driusan yeah i know, not sure what to call them. And not sure if the exception messages are clear enough.

Suggestion ?

[driusan]

Some ideas, in no particular order:

1. pselectIndexed and pselectColIndexed
2. pselectByIndex and pselectColByIndex
3. pselectIndexKey and pselectColIndexKey
4. pselectWithIndexKey and pselectColWithIndexKey

[driusan]

@HenriRabalais Are you reviewing/testing this?

[HenriRabalais]

Looks good to me and will be very useful - this will replace a lot of the work that the biobank DAO is currently doing when querying the database.

[HenriRabalais]

I fail to see how this is useful in light of the first function - is the plan to make 1:1 index to value mappings? If that is the case, it does not seem that you are able to specify which column you are targeting.

[driusan]

Now that I think of it, you're right. Doesn't pselectCol always return a single column? Isn't this just requiring an extra parameter @ridz1208?

[ridz1208]

The idea here...
Imagine the following table (notice that the primary key is an autoincrement but they are not consecutive to distinguish them from row numbers)

Ideally what you want and what is used all throughout the loris codebase is an array of the form $centerID=>$centerName as follows

$DB->pselectColWithIndexKey("SELECT CenterID, Name FROM psc WHERE CenterID<11",array(),"CenterID")
Array
(
    [1] => CCNA Testing Site
    [5] => True North Clinical Research (Halifax)
    [6] => St. Joseph's Hospital
    [7] => Centre for Diagnosis and Research on Alzheimer's Disease (CEDRA), Memory Clinic
    [8] => Centre Hospitalier de l'Université de Montréal
    [10] => Douglas Mental Health University Institute, Memory Clinic
)

But currently we can only get one of the following... in either case we will need a secondary forloop to extract the key=>value association we are looking for.

$DB->pselect("SELECT CenterID, Name FROM psc WHERE CenterID<11",array())
Array
(
    [0] => Array
        (
            [CenterID] => 1
            [Name] => CCNA Testing Site
        )

    [1] => Array
        (
            [CenterID] => 5
            [Name] => True North Clinical Research (Halifax)
        )

    [2] => Array
        (
            [CenterID] => 6
            [Name] => St. Joseph's Hospital
        )

    [3] => Array
        (
            [CenterID] => 7
            [Name] => Centre for Diagnosis and Research on Alzheimer's Disease (CEDRA), Memory Clinic
        )

    [4] => Array
        (
            [CenterID] => 8
            [Name] => Centre Hospitalier de l'Université de Montréal
        )

    [5] => Array
        (
            [CenterID] => 10
            [Name] => Douglas Mental Health University Institute, Memory Clinic
        )

)

$DB->pselectCol("SELECT Name FROM psc WHERE CenterID<11",array())
Array
(
    [0] => CCNA Testing Site
    [1] => True North Clinical Research (Halifax)
    [2] => St. Joseph's Hospital
    [3] => Centre for Diagnosis and Research on Alzheimer's Disease (CEDRA), Memory Clinic
    [4] => Centre Hospitalier de l'Université de Montréal
    [5] => Douglas Mental Health University Institute, Memory Clinic
)

$DB->pselectWithIndexKey("SELECT CenterID, Name FROM psc WHERE CenterID<11",array(),"CenterID")
Array
(
    [1] => Array
        (
            [Name] => CCNA Testing Site
        )

    [5] => Array
        (
            [Name] => True North Clinical Research (Halifax)
        )

    [6] => Array
        (
            [Name] => St. Joseph's Hospital
        )

    [7] => Array
        (
            [Name] => Centre for Diagnosis and Research on Alzheimer's Disease (CEDRA), Memory Clinic
        )

    [8] => Array
        (
            [Name] => Centre Hospitalier de l'Université de Montréal
        )

    [10] => Array
        (
            [Name] => Douglas Mental Health University Institute, Memory Clinic
        )

)

I think this function might just be a better version of pselectCol but I dont think it is redundant with pselectWithIndexKey because it returns a flatened array directly useable by the code requesting it

[ridz1208]

@driusan did the explanation make it clearer ?

[driusan]

Other than the fact that I didn't see the comment until now, yes.

[HenriRabalais]

@driusan Yeah, sorry, I had made comments a week ago and forgot to submit them :/

I just noticed Henri's comment..