eol_php_code: A PHP repository from lwalley

Requirements¶ ↑

PHP version 5.3.X (there are known issues with 5.4.0 and above)
ImageMagick
'biodiversity' Ruby gem, as defined in the Gemfile
An installation of the EOL Ruby on Rails codebase (https://github.com/EOL/eol), with all specs passing. This will ensure you have such things as:
  A working installation of MySQL
  A working installation of Apache Solr
  A working instance of Virtuoso

Installation¶ ↑

There are a few things you must do before using this code:

Ensure you have a working web server with PHP support.
Ensure there is an available php.ini configuration file with desired settings.

Update in /config/environment.php the constants for:
  WEB_ROOT        - eg: 'http://localhost/eol_php_code/'

In /config/environment.php check the values of:
  CONTENT_PARTNER_LOCAL_PATH
  CONTENT_LOCAL_PATH
  CONTENT_RESOURCE_LOCAL_PATH
  These are the locations where media will be downloaded to for viewing on the website

Give write permission for the following directories to your web server user:
  /log
  /temp
  /applications/content_server/content (or changed value of CONTENT_LOCAL_PATH)
  /applications/content_server/content_partners (or changed value of CONTENT_PARTNER_LOCAL_PATH)
  /applications/content_server/resources (or changed value of CONTENT_RESOURCE_LOCAL_PATH)
  /applications/content_server/tmp
  /vendor/eol_content_schema_v2/extension_cache

Install the biodiversity Ruby gem:
  you must fist have Ruby and Rubygems installed, then see https://github.com/GlobalNamesArchitecture/biodiversity
  for installation

Create other files in /config/environments/ENV_NAME.php:
  these environment files will be loaded when boot.php is included,
  which is towards the TOP of environment.php

Run the tests and make sure they all pass
  see the Test section for more information

Getting Started¶ ↑

You need to include /config/environment.php for any application that you want to be connected to the databases configured in database.yml and in the current environment

The default environment is ‘development’ unless you change the default in environment.php

The default environment can be overridden by:

including this line BEFORE including environment.php:
  $GLOBALS['ENV_NAME'] = $ENVIRONMENT;

calling a script and including the GET parameter:
  http://localhost/eol_php_code/.../script.php?ENV_NAME=$ENVIRONMENT

calling a command line script and including the argument:
  > php script.php ENV_NAME=$ENVIRONMENT

Tests¶ ↑

Tests are best initiated from the command line by running:

> php tests/run_tests.php

Or running a group with:

> php tests/run_tests.php web
> php tests/run_tests.php unit

Or running an individual test with:

> php tests/run_tests.php unit/test_name.php

Fixture *.yml files can be added to /tests/fixtures. Any fields that don’t match the fields in your test database will be ignored. Test will only use fixtures if they have a public class attribute defined:

public $load_fixtures = true;

Fixture data is turned into mock objects which can be accessed within tests as such:

$this->fixtures->fixture_name->row_identifier->field
e.g. $this->fixtures->agents->me->id

Connecting Harvesting with eol.org Ruby on Rails codebase¶ ↑

This PHP codebase was designed to compliment the EOL Ruby on Rails codebase (github.com/EncyclopediaOfLife/eol). The PHP code is used almost entirely for harvesting content, inserting harvested content and associated metadata into the database, and working out differences among taxonomies so we can present all content for a single species on a single EOL page. The Rails code is used almost entirely for presenting the content to the world, and providing interfaces for curators to cast judgement on the validity of the content EOL is presenting.

In order to have the website and harvesting code working together there are a few configuration options that need to be set:

The config/database.yml in this codebase must be configured to connect to the same MASTER database that the Rails codebase is. This codebase will connect to the eol_data_$ENVIRONMENT database which is one of three databases that the Rails codebase connects to.
In the Rails codebase there are several /config/environment/$ENVIRONMENT.rb config files. For any enviornment that you want to be connected with the PHP code base you must change a few variables:
# the domain of the server running the PHP code
$CONTENT_SERVERS = ['http://localhost']

# corresponds to CONTENT_LOCAL_PATH - the path on the PHP server where media will be downloaded
$CONTENT_SERVER_CONTENT_PATH = "/eol_php_code/applications/content_server/content/"

# corresponds to CONTENT_RESOURCE_LOCAL_PATH - the path on the PHP server where resources will be downloaded
$CONTENT_SERVER_RESOURCES_PATH = "/eol_php_code/applications/content_server/resources/"

# the full URL to the PHP server to /applications/content_server/service.php which is used by the website to send uploads of content partner logos and resource XML files
$WEB_SERVICE_BASE_URL="http://localhost/eol_php_code/applications/content_server/service.php?"

Scheduled Tasks¶ ↑

Once connected with the Rails codebase, there are a few scheduled tasks we run to ensure that harvesting is happening every day and the website has the data it need to present species pages efficiently: