Author: mcantelon
Date: Wed Jan 18 13:20:44 2012
New Revision: 10715
Log:
Documented QubitFlatfile class properties.
Modified:
trunk/lib/QubitFlatfileImport.class.php
Modified: trunk/lib/QubitFlatfileImport.class.php
==============================================================================
--- trunk/lib/QubitFlatfileImport.class.php Wed Jan 18 12:03:53 2012
(r10714)
+++ trunk/lib/QubitFlatfileImport.class.php Wed Jan 18 13:20:44 2012
(r10715)
@@ -27,28 +27,28 @@
*/
class QubitFlatfileImport
{
- public $className;
- public $errorLog;
- public $rowsUntilProgressDisplay;
-
- public $status = array();
- public $rowStatusVars = array();
-
- public $columnNames = array();
- public $ignoreColumns = array();
-
- public $standardColumns = array();
- public $columnMap = array();
- public $propertyMap = array();
- public $noteMap = array();
- public $handlers = array();
- public $variableColumns = array();
- public $arrayColumns = array();
-
- public $rowInitLogic;
- public $preSaveLogic;
- public $saveLogic;
- public $postSaveLogic;
+ public $className; // optional class name of object to
create/save
+ public $errorLog; // optional location of error log file
+ public $rowsUntilProgressDisplay; // optional display progress every n rows
+
+ public $status = array(); // place to store data related to overall
import
+ public $rowStatusVars = array(); // place to store data related to current
row
+
+ public $columnNames = array(); // column names from first row of
imported CSV
+ public $ignoreColumns = array(); // columns in CSV to ignore
+
+ public $standardColumns = array(); // columns in CSV are object properties
+ public $columnMap = array(); // columns in CSV that map to object
properties
+ public $propertyMap = array(); // columns in CSV that map to Qubit
properties
+ public $noteMap = array(); // columns in CSV that should become notes
+ public $handlers = array(); // columns in CSV paired with custom
handling logic
+ public $variableColumns = array(); // columns in CSV to be later referenced
by logic
+ public $arrayColumns = array(); // columns in CSV to explode and later
reference
+
+ public $rowInitLogic; // Optional logic to create/load object if not using
$className
+ public $preSaveLogic; // Optional pre-save logic
+ public $saveLogic; // Optional logic to save object if not using
$className
+ public $postSaveLogic; // Optional post-save logic
public function __construct($options)
{
--
You received this message because you are subscribed to the Google Groups
"Qubit Toolkit Commits" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/qubit-commits?hl=en.
