[#143] Move data/test-data.inc.php to a sample location, add it to .gitignore, and update README

Author: ericras

.gitignore

@@ -12,6 +12,7 @@
 /data/suppress_uids.txt
 /data/hr_tree.xml
 /data/faculty_education.csv
+/data/test-data.inc.php
 /data/unl_sis_bio.txt
 /data/unl_sis_prog.txt
 /node_modules/

README.md

@@ -74,6 +74,21 @@ php scripts/import_sis_data.php
 
 Note: this needs to be ran at least once a day to keep the data in the cache
 
+## Sample User (Optional)
+
+The idea is to simulate a person record that doesn't exist in the official identity system.
+
+Reasons to do this:
+- So there is a permanent person (that won't quit or retire) for another system to use for testing.
+- As a test/development record for possible schema changes or to see how different data affects output.
+- As an Easter egg.
+
+To enable and use the sample user:
+To use:
+1) Copy /data/test-data.inc_sample.php to /data/test-data.inc.php and edit if desired.
+2) Make sure the include of /data/test-data.inc.php and the setting of UNL_Peoplefinder::$sampleUID are uncommented in config.inc.php
+
+
 ## INSTALL
 
 1) Run: 'npm install; grunt; composer install'

data/test-data.inc.php data/test-data.inc_sample.php

@@ -1,5 +1,11 @@
 <?php
 
+/**
+ * To use:
+ * Copy this file to /data/test-data.inc.php
+ * Make sure the lines related to this file and UNL_Peoplefinder::$sampleUID are uncommented in config.inc.php
+ */
+
 /**
  * Sample of the result of the query in UNL_Peoplefinder_Driver_OracleDB->fixLDAPEntries()
  * Simulates the result for one person: hhusker1

www/config-sample.inc.php

@@ -46,5 +46,5 @@
 UNL_Peoplefinder::$testDomains = array('directory-test.unl.edu', 'localhost');
 
 // Sample user ID
-UNL_Peoplefinder::$sampleUID = 'hhusker1';
-include_once __DIR__ . '/../data/test-data.inc.php';
+//UNL_Peoplefinder::$sampleUID = 'hhusker1';
+//include_once __DIR__ . '/../data/test-data.inc.php';