Symfony Migration

[ryanrath]

Description

This is the main migration PR for Symfony.

Motivation and Context

Tests performed

Checklist:

• The pull request description is suitable for a Changelog entry
• The milestone is set correctly on the pull request
• The appropriate labels have been added to the pull request

[eiffel777]

Because of the change on line 377, changing what values $factoryClassName might be, should 'static' != $factoryClassName test a value different then static? If I am understanding the code correctly, maybe Realm::class?

[ryanrath]

So I think it can actually be removed. Some quick context:

This function is called in three places / functions:

• Realm::getGroupByObjects: return static::getSortedObjectList('GroupBy', ...);
• Realm::getRealmObjects: return static::getSortedObjectList('Realm', ...);
• Realm::getStatisticObjects: return static::getSortedObjectList('Statistic', ...);

The value of $factory (a string, the function that's going to ultimately be executed ) w/ the original code is:

static::factory           # $className = 'Realm';
\Realm\GroupBy::factory   # $className = 'GroupBy';
\Realm\Statistic::factory # $className = 'Statistic';

Now, I'm not sure exactly why whoever wrote this subbed in static for Realm, but I do know that it / that line isn't actually needed and can be simplified to the following:

function getSortedObjectList(
    string $className,
    object $configObj,
    ...
)
{
    ...
    // No need for `$factoryClassName = ('Realm' == $className ? 'static' : $className);` 
    // Allows for the configuring of a different class to handle GroupBys or Statistics in datawarehouse.json
    if ( 'Realm' != $className && isset($configObj->class) ) {
        if ( ! class_exists($configObj->class) ) {
            $msg = sprintf("Attempt to instantiate undefined %s class %s", $className, $configObj->class);
            throw new \Exception($msg);
        }
        $factoryClassName = $configObj->class;
    // NOTE: this is an `else` instead of an `elseif` 
    } else {
        // Add the __NAMESPACE__ to the provided $className.
        $factoryClassName = sprintf('\\%s\\%s', __NAMESPACE__, $className);
    }
    $factoryCallable = [$factoryClassName, 'factory'];

    ...
}

If we look at $factory / $factoryCallable for the original code and my proposed simplified code above it looks something like:

Original:
"static::factory"
"\\Realm\\GroupBy::factory"
"\\Realm\\Statistic::factory"
***
New Updated:
["\\Realm\\Realm","factory"]
["\\Realm\\GroupBy","factory"]
["\\Realm\\Statistic","factory"]

Thoughts?