[ Index ]

PHP Cross Reference of Moodle 1.9.3 [Build 15-Oct-2008]

title

Body

[close]

/lib/ -> csvlib.class.php (summary)

(no description)

File Size: 268 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

csv_import_reader:: (12 methods):
  csv_import_reader()
  load_csv_content()
  get_columns()
  init()
  next()
  close()
  get_error()
  cleanup()
  get_delimiter_list()
  get_delimiter()
  get_encoded_delimiter()
  get_new_iid()


Class: csv_import_reader  - X-Ref

Utitily class for importing of CSV files.

csv_import_reader($iid, $type)   X-Ref
Contructor

param: int $iid import identifier
param: string $type which script imports?

load_csv_content(&$content, $encoding, $delimiter_name, $column_validation=null)   X-Ref
Parse this content

param: string &$content passed by ref for memory reasons, unset after return
param: string $encoding content encoding
param: string $delimiter_name separator (comma, semicolon, colon, cfg)
param: string $column_validation name of function for columns validation, must have one param $columns
return: false if error, count of data lines if ok; use get_error() to get error string

get_columns()   X-Ref
Returns list of columns

return: array

init()   X-Ref
Init iterator.


next()   X-Ref
Get next line

return: array of values

close()   X-Ref
Release iteration related resources


get_error()   X-Ref
Get last error

return: string error text of null if none

cleanup($full=false)   X-Ref
Cleanup temporary data

param: boolean true menasdo a full cleanup - all sessions for current user, false only the active iid

get_delimiter_list()   X-Ref
Get list of cvs delimiters

return: array suitable for selection box

get_delimiter($delimiter_name)   X-Ref
Get delimiter character

param: string separator name
return: char delimiter char

get_encoded_delimiter($delimiter_name)   X-Ref
Get encoded delimiter character

param: string separator name
return: char encoded delimiter char

get_new_iid($type)   X-Ref
Create new import id

param: string who imports?
return: int iid



Generated: Wed Jan 14 11:33:29 2009 Cross-referenced by PHPXref 0.7