Install and configure Solarium

[waldoj]

Install and configure Solarium as our Solr interface.

[waldoj]

I'm having trouble with the autoloader. I have this in htdocs/index.php:

require('Solarium/Autoloader.php');
$result = Solarium_Autoloader::register();

I've tested it out, and Solarium_Autoloader::register() is running, as is doubly confirmed with spl_autoload_functions():

Array
(
    [0] => __autoload_libraries
    [1] => Array
        (
            [0] => Solarium_Autoloader
            [1] => load
        )

)

The only thing that concerns me here is that this is a multidimensional array. I haven't seen the output of spl_autoload_functions() before, but I'm surprised to see this.

Anyhow, when I try to run a bit of test Solarium code, I get this in the error log:

PHP Warning:  include_once(/vagrant/statedecoded/includes//class.Solarium_Version.inc.php): failed to open stream: No such file or directory in /vagrant/statedecoded/includes/functions.inc.php on line 23

PHP Warning:  include_once(): Failed opening '/vagrant/statedecoded/includes//class.Solarium_Version.inc.php' for inclusion (include_path='.:/usr/share/php:/usr/share/pear:/vagrant/statedecoded/includes/') in /vagrant/statedecoded/includes/functions.inc.php on line 23

PHP Fatal error:  Uncaught exception 'Exception' with message 'Could not include `class.Solarium_Version.inc.php'.' in /vagrant/statedecoded/includes/functions.inc.php:25\nStack trace:\n#0 [internal function]: __autoload_libraries('Solarium_Versio...')\n#1 /vagrant/statedecoded/htdocs/index.php(261): spl_autoload_call('Solarium_Versio...')\n#2 {main}\n  thrown in /vagrant/statedecoded/includes/functions.inc.php on line 25

It looks to me like the autoloader isn't falling back past our own __autoload_libraries() function (found in includes/functions.inc.php to use Solarium's own autoloader functions.

So I put a bit of debugging code into Autoloader::load(), to see if it's ever executing, and it is. It's even generating the right path for require($file): /vagrant/statedecoded/includes/Solarium//Version.php.

And yet the fatal error is coming from functions.inc.php. That is, the autoloader is dying before it's even moved on past the first registered autoloader.

Wait. I've got it. Our autoloader looks like this:

function __autoload_libraries($class_name)
{

    $filename = 'class.' . $class_name . '.inc.php';
    if ((include_once INCLUDE_PATH . '/' . $filename) === FALSE)
    {
        throw new Exception("Could not include `$filename'.");
    }

}

Throwing an exception upon failure made perfect sense when we only had a single autoloader. But with chained autoloaders, we're preventing further autoloaders from running!

[waldoj]

When creating a new client instance (new Solarium_Client($solr_config);), it's necessary to specify the host, port, and path of the Solr server as that $solr_config array. Figure out how to best make available globally that array, currently created as $solr_config in index.php, using the SOLR_URL constant. (We can't store this array as a constant, because constants can store arrays.)

[waldoj]

In the meantime, I've established $GLOBALS['solr_config'] in index.php. That's just so that this isn't an obstacle to development; I still intend to think through what the best solution is.

[waldoj]

OK, as things stand now, the autoloader isn't working within search.php, so something is still not quite right here. It works fine on index.php, and spl_autoload_functions() lists properly all of the registered autoload functions, so I'm not sure what the problem is. Will revisit later.

[waldoj]

All set—it was a problem with the autoloader in functions.inc.php, corrected in 349c2b9.

[waldoj]

This is done, save for dealing with the question of how $GLOBALS['solr_config']. Think through what the proper approach is to making this array available globally, implement it, and then then ticket can be closed.

[waldoj]

Note that GLOBALS['solr_config'] is defined within index.php and used in includes/class.ParserController.inc.php, htdocs/search.php, and includes/class.Law.inc.php, so it will need to be changed in all of those locations.

[waldoj]

Screw it—I'm leaving it as $GLOBALS['solr_config']. Tick-tock.