Import data from a cvs file. More...

Public Member Functions
	__construct ($class_name, $id="")

	column ($field, $position, $label="", $options=array(), $importer="", $update_empty=true)
	Adds a data import column definition. More...

	additional ($field, $label="", $template="", $update_empty)
	If values are set using logic that does not refer to data in a particular column, use additional with a callback function as the template. More...

	match ()

	formatList ($items, $nameField)
	When instantiating a DataImportColumn, use this function to build an array of option key/value pairs for lookup. More...

	import ()
	Import and save the data. More...

	button ($text, $url, $confirm=null, $isScript=false)
	Adds a custom button to the form. More...

	loadData ($fp)
	Load the data from the spreadsheet (cvs file) into the DataItem objects. More...

	log ($text)
	Store info, errors, and warnings in a log file and ouput. More...

	writeLog ()
	Output the log. More...

	importOneRow ($row, $row_number)
	Given a data row, set the value into each field of the DataItem object. More...

	preProcessRow ($obj)
	If implementing classes may wish to add custom logic for handling a row before it is saved or displayed in preview. More...

	getSavedObj ($obj)
	Called by the build preview table method. More...

	findMatch ($obj)
	Check the db for a record that matches the values for the field(s) given in the matches array. More...

	setFilter ($obj, $old)
	If a match to a saved obj is found, set the filter to include only those fields that have changed. More...

	getColumn ($field)

	init (&$obj, $row_number)

	save ()

	formatSaveLogText ($row_number, $obj, $new)
	For each row saved, output text stating the row was updated and which fields set. More...

	getPrimaryKey ()

	getClassName ()
	Get the display (prettified) version of the class name for the import. More...

	buildInputTable ()
	Describe the expected columns to the user above the Browse File form. More...

	writeScript ()

	drawView ()

	preview ()
	Load the data into preview objects and display in a table. More...

	drawForm ()
	Display the expected input column layout and show a File upload renderer for the user to select the csv file to be imported. More...

	uploadDataImportFile ()

	drawButtons ()
	Draws any additional buttons specified in the calling script. More...

	openFile ()

	getFilePath ()
	Implementing classes may wish to retrieve differently (e.g., document library) More...

	buildPreviewTable ()
	Display in a DataListView the values read in and set into the data objects and show a Warnings column to list values not found in the lookup table. More...

	previewRowStyle ($obj)

	createPreviewData ()
	Clone each of the objs that would be saved to the db on import and set into a preview object that has the formatted value for each field and any warning info or other details for display. More...

	formatPreviewCell ($obj, $column)
	When building the preview table, format the column using the supplied DataImportColumn preview template callback. More...

	importCell ($column, $obj, $value)
	Given the input value read in, set the value into the field of the object. More...

	formatRowIndex ($obj)

Public Attributes
	$class_name
	name of data item class to be updated More...

	$id

	$log

	$objs = array()
	Contains data read in from the input file. More...

	$import = false

	$preview = false
	whether we are in preview mode More...

	$matches = array()
	Field(s) to use to check for a match in db - can be empty. More...

	$savedObjs = array()
	Matches found in the db for data in the import file, indexed by primary key. More...

	$onPreProcessRow = null
	callback for after each row of data is loaded and before it is saved or displayed in preview table More...

	$filepath = null
	optionally set known file path for csv file; otherwise provide form for user to specify More...

	$validateDataFile
	optional callback to validate data contents of the file More...

	$buttons = array()
	The custom buttons collection. More...

	$onSaveComplete = null
	Callback event handler that is fired after all the imported rows are saved. More...

	$field = "csv_file"

	$cssClass = ""

	$table

	$quiet = false
	Quiet mode - generate no output to the HTML stream. More...

Detailed Description

Import data from a cvs file.

Requires specifying the columns to be imported and their position in the csv file.

You may wish to instantiate a helper file for custom handling.

e.g.,

$helper = new UserImportHelper();

$mgr = new DataImportManager(SiteUser, "import_users"); $mgr->column("first_name", 1); $mgr->column("last_name", 2); $mgr->column("email", 3); $mgr->column("role", 4);

$mgr->match("email");

$mgr->onPreProcessRow = array($helper, preProcessRow); $mgr->onSaveComplete = array($helper, sendEmail);

$script .= $mgr->writeScript(); $mgr->drawView();

If a column needs special handling such as finding a key based on a text string in a reference table, use a callback.

If the input column will provide a name value and the import manager will retrieve its key value, then instantiate the column as follows:

$this->column("grade_id", 1, "Grade", $this->formatList($grades, "grade_name"));

Definition at line 73 of file data_import_manager.inc.

Constructor & Destructor Documentation

◆ __construct()

DataImportManager::__construct	(	$class_name,
		$id = `""`
	)

Parameters

String $class_name - name of the DataItem class being imported

Definition at line 98 of file data_import_manager.inc.

      {    
           $this->class_name = $class_name;
           $this->id = ($id) ? $id : codify(strtolower($this->class_name)) . "_data_import";
           
           if($_POST["import"])
           {
                $this->import = true;
           }
      }

Member Function Documentation

◆ additional()

DataImportManager::additional	(	$field,
		$label = `""`,
		$template = `""`,
		$update_empty
	)

If values are set using logic that does not refer to data in a particular column, use additional with a callback function as the template.

Parameters

string	$field
string	$label
string	$template
boolean	$update_empty

Returns: DataImportManager

Definition at line 140 of file data_import_manager.inc.

      {
           if(!$label)
           {
                $obj = new $this->class_name;
                $label =  $obj->prettifyFieldName($field);
           }
           $this->columns[] = new DataImportColumn($field, 0, $label, null, $template, $update_empty);
           
           return $this;
      }

◆ buildInputTable()

DataImportManager::buildInputTable ( )

Describe the expected columns to the user above the Browse File form.

Definition at line 548 of file data_import_manager.inc.

      {
           $table = new DataListView($this->columns, $this->id);
           $table->column("Column Name", "{field}")
                ->column("Title/Label", "{label}")
                ->column("Options", "{formatOptions()}")
                ->column("Position", "{position}")
                ;
           
           $table->sortable = false;
           $table->paginate = false;
           $table->filter = false;
           
           return $table;
      }

◆ buildPreviewTable()

DataImportManager::buildPreviewTable ( )

Display in a DataListView the values read in and set into the data objects and show a Warnings column to list values not found in the lookup table.

Definition at line 752 of file data_import_manager.inc.

      {              
           $pObjs = $this->createPreviewData();
  
           $pk = $this->getPrimaryKey();
           $table = new DataListView($pObjs, $this->id);
           $table->column("Row", array($this, formatRowIndex));
           $table->column(prettify($pk), "{{$pk}}");
           
           foreach($this->columns as $column)
           {
                $field = $column->field;
                $table->column($column->label, "{{$field}}");
           }
           
           $table->onStartRow = array($this, previewRowStyle);         
           $table->emptyMessage = "No data to be imported.";
           $table->sortable = false;
           $table->paginate = false;
           $table->filter = false;
           
           return $table;
      }

◆ button()

DataImportManager::button	(	$text,
		$url,
		$confirm = `null`,
		$isScript = `false`
	)

Adds a custom button to the form.

Parameters

string	$text	the button label text
string	$url	the URL to handle the button press
string	$confirm	optional confirmation message
boolean	$isScript	true if the url is javascript code to execute, false if it is a URL to redirect to

Definition at line 213 of file data_import_manager.inc.

      {
           $this->buttons[] = array('text' => $text, 'url' => $url, 'confirm' => $confirm, 'isScript' => $isScript);
      }    

◆ column()

DataImportManager::column	(	$field,
		$position,
		$label = `""`,
		$options = `array()`,
		$importer = `""`,
		$update_empty = `true`
	)

Adds a data import column definition.

Parameters

string	$field	- column name for table imported to
number	$position	- column order/position in import
string	$label	- label for the column
array	$options	- set of valid options for the imported data, if lookup is used
callback	$importer	- optional custom import function for the column

Definition at line 118 of file data_import_manager.inc.

      {
           if(!$label)
           {
                $obj = new $this->class_name;
                $label =  $obj->prettifyFieldName($field);
           }
           $this->columns[] = new DataImportColumn($field, $position, $label, $options, $importer, $update_empty);
           
           return $this;
      }    

◆ createPreviewData()

DataImportManager::createPreviewData ( )

Clone each of the objs that would be saved to the db on import and set into a preview object that has the formatted value for each field and any warning info or other details for display.

Returns: array of objects

Definition at line 792 of file data_import_manager.inc.

      {
           $filter = new InclusionFilter();
           foreach($this->columns as $column)
           {
                $filter->add($column->field);
           }
  
           $pObjs = array();
           if(count($this->objs))
           {
                foreach($this->objs as $obj)
                {
                     $pObj = clone $obj;
                     $pObj->filter = $filter;
                     foreach($this->columns as $column)
                     {
                          $pObj->filter->add($column->field);
                          $pObj->set($column->field, $this->formatPreviewCell($pObj, $column));
                     }
                     
                     $pObjs[] = $pObj;
                }
           }
           
           return $pObjs;
      }

◆ drawButtons()

DataImportManager::drawButtons ( )

Draws any additional buttons specified in the calling script.

Definition at line 677 of file data_import_manager.inc.

      {
           $buttons = array();
           
           foreach($this->buttons as $button)
           {
                $url = ($button['isScript']) ? $button['url'] : "go('{$button['url']}');";
                
                if ($button['confirm'])
                {
                     $link = "if (confirm('".jsSafe($button['confirm'])."')) $url; return false;";
                }
                else
                {
                     $link = "$url; return false;";
                }
                
                if(preg_match("/import=1/", $url) && !count($this->objs))
                {
                     continue;
                }
                $buttons[] = "<input type='button' class='{$this->buttonCSS}' onclick=\"$link\" value=\"{$button['text']}\"/>";
           }
           
           if($this->preview && $this->table && count($this->table->items))
           {
                array_unshift($buttons, "<input type='submit' name='import' class='button' value='Import File'/>\n");
           }
  
           echo "<div class='button_row'>" . implode("&nbsp;&nbsp;", $buttons) . "</div>";
      }

◆ drawForm()

DataImportManager::drawForm ( )

Display the expected input column layout and show a File upload renderer for the user to select the csv file to be imported.

Definition at line 634 of file data_import_manager.inc.

      {
           $table = $this->buildInputTable();
           echo "<p><label>Description of columns expected in import file:</label></p>\n";
           $table->drawView();
           
           echo "</br></br><form method='POST' action='' enctype='multipart/form-data'>
           <label>CSV file to import: </label><input type='file' name='{$this->field}'/><br/><br/>
           <input type='submit' name='import' class='button' value='Import File'/>
           <input type='submit' name='preview' class='button' value='Preview Import'/>
           </form>"; 
      }

◆ drawView()

DataImportManager::drawView ( )

Definition at line 569 of file data_import_manager.inc.

      {
           $file = $this->getFilePath();
           
           $class = ($this->cssClass) ? " class='{$this->cssClass}'" : "";
           echo "<div id='data_import'{$class}>\n";
           
           if(!$file)
           {
                $this->drawForm();
           }
           else if(!$this->import)
           {
                $this->preview();
           }
           else 
           {
                $this->import();
           }
           echo "</div>\n";
      }

◆ findMatch()

DataImportManager::findMatch ( $obj )

Check the db for a record that matches the values for the field(s) given in the matches array.

Parameters

obj $obj

Definition at line 359 of file data_import_manager.inc.

      {
           if(!count($this->matches))
           {
                return null;
           }
  
           foreach($this->matches as $field => $dump)
           {
                $constraint[] = $field . "=:$field";
           }
           
           $query = Query::create($this->class_name, "WHERE " . implode(" AND ", $constraint));
           
           foreach($this->matches as $field => $dump)
           {
                $query->bind(":$field", $obj->$field);
           }
           
           $foundObjs = $query->execute();
  
           return (count($foundObjs)) ? $foundObjs[0] : null;
      }

◆ formatList()

DataImportManager::formatList	(	$items,
		$nameField
	)

When instantiating a DataImportColumn, use this function to build an array of option key/value pairs for lookup.

Parameters

Array	$items	- array of DataItem objects in the lookup table
String	$nameField	- the field in the table that supplies the name that is meant to match the input value of the spreadsheet.

Definition at line 168 of file data_import_manager.inc.

      {
           if(count($items) == 0)
           {
                return array();
           }
           
           $out = array();
           foreach($items as $item)
           {
                $pk = $item->getPrimaryKey();
                $out[$item->$pk] = $item->$nameField;
           }
           
           return $out;
      }

◆ formatPreviewCell()

DataImportManager::formatPreviewCell	(	$obj,
		$column
	)

When building the preview table, format the column using the supplied DataImportColumn preview template callback.

Parameters

obj	$obj
obj	$column

Returns: mixed

Definition at line 828 of file data_import_manager.inc.

      {
           $old = $this->getSavedObj($obj);
                     
           if(is_callable($column->preview_template))
           {
                return call_user_func($column->preview_template, $obj, $old);
           }
      }

◆ formatRowIndex()

DataImportManager::formatRowIndex ( $obj )

Definition at line 865 of file data_import_manager.inc.

      {
           return $obj->row_number;
      }

◆ formatSaveLogText()

DataImportManager::formatSaveLogText	(	$row_number,
		$obj,
		$new
	)

For each row saved, output text stating the row was updated and which fields set.

If new row, write inserted.

Parameters

number	$row_number
obj	$obj
boolean	$new

Returns: string

Definition at line 485 of file data_import_manager.inc.

      {
           $pk = $this->getPrimaryKey();
           $name = $this->getClassName();
           $fields = $obj->getFields();
           $out = array();
           
           if(!$new)
           {
                $filter = $obj->getFilter();
                foreach($fields as $field => $type)
                {
                     if($filter && !$filter->isExcluded($field))
                     {
                          $out[] = $field . " " . $obj->$field;
                     }
                }
                $text = "<b>Updated</b> $name from row number $row_number $pk {$obj->$pk} " . implode(" ", $out);
           }
           else
           {
                foreach($fields as $field => $type)
                {
                     $out[] = $field . " " . $obj->$field;
                }
                     
                $text = "<b>Inserted</b> into $name from row number $row_number $pk {$obj->$pk} " . implode(" ", $out);
           }
           
           foreach($this->columns as $column)
           {
                $warning = $column->getWarning($obj);
                if($warning)
                {
                     $text .= "<span class='warning'>{$warning}</warning>";
                }
           }
           
           return $text;
      }

◆ getClassName()

DataImportManager::getClassName ( )

Get the display (prettified) version of the class name for the import.

Definition at line 537 of file data_import_manager.inc.

      {
           $class_name = $this->class_name;
           $obj = new $class_name;
           return $obj->prettifyClassName();  
      }

◆ getColumn()

DataImportManager::getColumn ( $field )

Definition at line 418 of file data_import_manager.inc.

      {
           if(!count($this->columns)) return false;
           
           if(count($this->columns))
           {
                foreach($this->columns as $column)
                {
                     if($column->field == $field)
                     {
                          return $column;
                     }
                }
           }
                
           return null;
      }

◆ getFilePath()

DataImportManager::getFilePath ( )

Implementing classes may wish to retrieve differently (e.g., document library)

Returns: String

Definition at line 729 of file data_import_manager.inc.

      {
           if($this->filepath)
           {
                return $this->filepath;
           }
           else if($_FILES[$this->field]["tmp_name"])
           {
                return $_FILES[$this->field]["tmp_name"];
           }
           else if($_POST[$this->field])
           {
                return $_POST[$this->field];
           }
           
           return null;
      }

◆ getPrimaryKey()

DataImportManager::getPrimaryKey ( )

Definition at line 526 of file data_import_manager.inc.

      {
           $class_name = $this->class_name;
           $obj = new $class_name;
           return $obj->getPrimaryKey();
      }

◆ getSavedObj()

DataImportManager::getSavedObj ( $obj )

Called by the build preview table method.

If during import, a record was found in the db that matched the given object, that match was saved to the savedObjs array.

Parameters

obj $obj

Returns: multitype:|NULL

Definition at line 341 of file data_import_manager.inc.

      {
           $pk = $this->getPrimaryKey();
      
           if(array_key_exists($obj->$pk, $this->savedObjs))
           {
                return $this->savedObjs[$obj->$pk];
           }
           
           return null;
      }

◆ import()

DataImportManager::import ( )

Import and save the data.

Definition at line 188 of file data_import_manager.inc.

      {
           $fp = $this->openFile();      
           if(!$fp) return;
           
           if($this->loadData($fp))
           {
                $this->save();
                if (!$this->quiet)
                {
                     $this->drawButtons();
                     $this->writeLog();
                }
           }
      }

◆ importCell()

DataImportManager::importCell	(	$column,
		$obj,
		$value
	)

Given the input value read in, set the value into the field of the object.

If this data column is set using the options lookup and the value is not found, save the warning to display in the DataListView row.

Parameters

$obj
$column
$value

Definition at line 851 of file data_import_manager.inc.

      {
           if (is_callable($column->importer) && $column->position > 0)
           {
                return call_user_func($column->importer, $obj, $value);
           }
           else if (is_callable($column->importer) && $column->position == 0)
           {
                return call_user_func($column->importer, $obj);
           }
           
           else $column->import($obj, $value);
      }

◆ importOneRow()

DataImportManager::importOneRow	(	$row,
		$row_number
	)

Given a data row, set the value into each field of the DataItem object.

Parameters

$row
$row_number

Definition at line 276 of file data_import_manager.inc.

      {
           $class_name = $this->class_name;
           $obj = new $class_name;
           
           $this->init($obj, $row_number);
      
           foreach($this->columns as $column)
           {
                $position = $column->position;
                if($position == 0) continue;
                $this->importCell($column, $obj, $row[$position-1]);
           }
           
           // Load additional columns after in case their value depends on rows
           // loaded from spreadsheet
           foreach($this->columns as $column)
           {
                if($column->position > 0) continue;
                $this->importCell($column, $obj, 0);    
           }
                     
           $obj = $this->preProcessRow($obj);
           
           return $obj;
      }

◆ init()

DataImportManager::init	(	&	$obj,
			$row_number
	)

Definition at line 442 of file data_import_manager.inc.

      {
           // use for indexing           
           $obj->set("row_number", $row_number);
      }

◆ loadData()

DataImportManager::loadData ( $fp )

Load the data from the spreadsheet (cvs file) into the DataItem objects.

Definition at line 222 of file data_import_manager.inc.

      {
           trace("Loading Data...", 3);
           
           // Use for indexing warnings
           $row_number = 1;
           $first = true;
           $read = 0;
           
           while (($row = fgetcsv($fp)) !== FALSE)
           {
                $read++;
                if($first && $this->validateDataFile && !call_user_func($this->validateDataFile, $row))
                {
                     return false;
                }
                $first = false;
                $obj = $this->importOneRow($row, $row_number);
                if($obj)
                {
                     $this->objs[$obj->row_number] = $obj;
                     $row_number++;
                }
           }    
           
           trace("Read {$row_number} objects from {$read} rows", 3);
           return true;
      }

◆ log()

DataImportManager::log ( $text )

Store info, errors, and warnings in a log file and ouput.

Parameters

$text

Definition at line 256 of file data_import_manager.inc.

      {
           $this->log .= $text . "</br></br>";
      }

◆ match()

DataImportManager::match ( )

Definition at line 152 of file data_import_manager.inc.

      {
           foreach(func_get_args() as $field)
           {
                $this->matches[$field] = true;
           }
      }

◆ openFile()

DataImportManager::openFile ( )

Definition at line 709 of file data_import_manager.inc.

      {
           $filepath = $this->getFilePath();
           $fp = fopen($filepath, 'r');
           
           if (fgetcsv($fp) == FALSE)
           {
                echo "<div class='error'>Cannot open data file {$filepath}.</div>\n";
                return null;
           }
           
           return $fp;
      }

◆ preProcessRow()

DataImportManager::preProcessRow ( $obj )

If implementing classes may wish to add custom logic for handling a row before it is saved or displayed in preview.

Parameters

$obj

Definition at line 310 of file data_import_manager.inc.

      {
           if(count($this->matches))
           {
                $savedObj = $this->findMatch($obj);
                if($savedObj)
                {              
                     $pk = $this->getPrimaryKey();
                     $this->savedObjs[$savedObj->$pk] = $savedObj;
                     $obj->$pk = $savedObj->$pk;
                     $this->setFilter($obj, $savedObj);
                     if(!$obj->getFilter()) return null;     
                }
           }
           
           if ($this->onPreProcessRow)
           {
                call_user_func($this->onPreProcessRow, $obj, $savedObj);
           }
      
           return $obj;
      }

◆ preview()

DataImportManager::preview ( )

Load the data into preview objects and display in a table.

Definition at line 594 of file data_import_manager.inc.

      {
           $this->preview = true;
           $this->uploadDataImportFile();
  
           $fp = $this->openFile();
           if(!$fp) return;
           
           if($this->loadData($fp))
           {
                $this->table = $this->buildPreviewTable();
           }
           
           if(count($this->table->items))
           {
                echo "<form method='POST' action='' enctype='multipart/form-data'>\n";
                echo "<input type='hidden' name='{$this->field}' value='{$this->filepath}'/>\n";
                $this->drawButtons();
           }
           
           echo $this->log;
           $this->table->drawView();
           
           if(!count($this->table->items) && !$this->filepath)
           {
                $this->drawForm();
           }
  
           $this->drawButtons();
           
           if(count($this->table->items))
           {
                echo "</form>\n";
           }
      }

◆ previewRowStyle()

DataImportManager::previewRowStyle ( $obj )

Definition at line 776 of file data_import_manager.inc.

      {
           $pk = $this->getPrimaryKey();
           if(!$obj->$pk)
           {
                return "data_import_row_new";
           }
      }

◆ save()

DataImportManager::save ( )

Definition at line 448 of file data_import_manager.inc.

      {
           if(count($this->objs) == 0)
           {
                return;
           }
  
           foreach($this->objs as $row_number => $obj)
           {
                $pk = $this->getPrimaryKey();
                $new = false;
                
                if(!$obj->$pk)
                {
                     $new = true;
                }
                $obj->save();
                $this->log($this->formatSaveLogText($row_number, $obj, $new));
           }
  
           if ($this->onSaveComplete)
           {
                call_user_func_array($this->onSaveComplete, array($this));
           }
           
           return true;
      }

◆ setFilter()

DataImportManager::setFilter	(	$obj,
		$old
	)

If a match to a saved obj is found, set the filter to include only those fields that have changed.

Parameters

obj	$obj
obj	$old

Returns: obj

Definition at line 391 of file data_import_manager.inc.

      {
           $fields = $obj->getFields();
           $changed = false;
      
           $obj->filter = new InclusionFilter();
           $old->filter = new InclusionFilter();
           foreach($fields as $field => $type)
           {
                $column = $this->getColumn($field);
                if(!$column) continue;
                $value = $obj->$field;
                if(($value || $column->update_empty) && $obj->$field != $old->$field)
                {
                     $changed = true;
                     $obj->filter->add($field);
                     $old->filter->add($field);
                }
           }
      
           if(!$changed)
           {
                $obj->filter = null;
                $old->filter = null;
           }
      }

◆ uploadDataImportFile()

DataImportManager::uploadDataImportFile ( )

Definition at line 647 of file data_import_manager.inc.

      {
           global $config;
           
           $file = $_FILES[$this->field]["tmp_name"];
           
           if(!$file)
           {
                return;
           }
           
           $fullpath = $config["uploadbase"] . DIRECTORY_SEPARATOR . basename($file);
      
           if (file_exists($fullpath))
           {
                unlink($fullpath);
           }
      
           trace("Uploading $file to $fullpath", 3);
      
           move_uploaded_file($file, $fullpath);
           chmod($fullpath, 0755);
      
           $this->filepath = $fullpath;
      }    

◆ writeLog()

DataImportManager::writeLog ( )

Output the log.

Definition at line 264 of file data_import_manager.inc.

      {
           if (!$this->quiet) echo $this->log;
      }

◆ writeScript()

DataImportManager::writeScript ( )

Definition at line 564 of file data_import_manager.inc.

      {
           return "";
      }

Member Data Documentation

◆ $buttons

DataImportManager::$buttons = array()

The custom buttons collection.

Definition at line 86 of file data_import_manager.inc.

◆ $class_name

DataImportManager::$class_name

name of data item class to be updated

Definition at line 75 of file data_import_manager.inc.

◆ $cssClass

DataImportManager::$cssClass = ""

Definition at line 89 of file data_import_manager.inc.

◆ $field

DataImportManager::$field = "csv_file"

Definition at line 88 of file data_import_manager.inc.

◆ $filepath

DataImportManager::$filepath = null

optionally set known file path for csv file; otherwise provide form for user to specify

Definition at line 84 of file data_import_manager.inc.

◆ $id

DataImportManager::$id

Definition at line 76 of file data_import_manager.inc.

◆ $import

DataImportManager::$import = false

Definition at line 79 of file data_import_manager.inc.

◆ $log

DataImportManager::$log

Definition at line 77 of file data_import_manager.inc.

◆ $matches

DataImportManager::$matches = array()

Field(s) to use to check for a match in db - can be empty.

Definition at line 81 of file data_import_manager.inc.

◆ $objs

DataImportManager::$objs = array()

Contains data read in from the input file.

Definition at line 78 of file data_import_manager.inc.

◆ $onPreProcessRow

DataImportManager::$onPreProcessRow = null

callback for after each row of data is loaded and before it is saved or displayed in preview table

Definition at line 83 of file data_import_manager.inc.

◆ $onSaveComplete

DataImportManager::$onSaveComplete = null

Callback event handler that is fired after all the imported rows are saved.

Definition at line 87 of file data_import_manager.inc.

◆ $preview

DataImportManager::$preview = false

whether we are in preview mode

Definition at line 80 of file data_import_manager.inc.

◆ $quiet

DataImportManager::$quiet = false

Quiet mode - generate no output to the HTML stream.

Definition at line 91 of file data_import_manager.inc.

◆ $savedObjs

DataImportManager::$savedObjs = array()

Matches found in the db for data in the import file, indexed by primary key.

Definition at line 82 of file data_import_manager.inc.

◆ $table

DataImportManager::$table

Definition at line 90 of file data_import_manager.inc.

◆ $validateDataFile

DataImportManager::$validateDataFile

optional callback to validate data contents of the file

Definition at line 85 of file data_import_manager.inc.

The documentation for this class was generated from the following file:

C:/code/cms.sonjara.com/framework/data_import_manager.inc

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ additional()

◆ buildInputTable()

◆ buildPreviewTable()

◆ button()

◆ column()

◆ createPreviewData()

◆ drawButtons()

◆ drawForm()

◆ drawView()

◆ findMatch()

◆ formatList()

◆ formatPreviewCell()

◆ formatRowIndex()

◆ formatSaveLogText()

◆ getClassName()

◆ getColumn()

◆ getFilePath()

◆ getPrimaryKey()

◆ getSavedObj()

◆ import()

◆ importCell()

◆ importOneRow()

◆ init()

◆ loadData()

◆ log()

◆ match()

◆ openFile()

◆ preProcessRow()

◆ preview()

◆ previewRowStyle()

◆ save()

◆ setFilter()

◆ uploadDataImportFile()

◆ writeLog()

◆ writeScript()

Member Data Documentation

◆ $buttons

◆ $class_name

◆ $cssClass

◆ $field

◆ $filepath

◆ $id

◆ $import

◆ $log

◆ $matches

◆ $objs

◆ $onPreProcessRow

◆ $onSaveComplete

◆ $preview

◆ $quiet

◆ $savedObjs

◆ $table

◆ $validateDataFile