Docs For Class Mage_Dataflow_Model_Batch

Description

Dataflow batch Io model

author: Magento Core Team <[email protected]>

Located in /Dataflow/Model/Batch/Io.php (line 35)

Class Constant Summary

TMP_DIR = '/var/tmp/'

TMP_NAME = 'batch_%d.tmp'

Variable Summary

Mage_Dataflow_Model_Batch $_batchModel

string $_filename

int $_fileSize

Varien_Io_File $_ioFile

string $_path

Method Summary

void clear ()

bool close ()

string getFile ([ $withPath = false])

unknown getFileSize ()

Varien_Io_File getIoAdapter ()

string getPath ()

Mage_Dataflow_Model_Batch_Io init (Mage_Dataflow_Model_Batch $object)

Mage_Dataflow_Model_Batch_Io open ([ $write = true])

string|array read ([ $csv = false], [ $delimiter = ','], [ $enclosure = '"'])

bool write (string $string)

Variables

Mage_Dataflow_Model_Batch $_batchModel (line 45)

Dataflow Batch model

access: protected

string $_filename (line 59)

Filename

access: protected

int $_fileSize = 0 (line 73)

size of file

access: protected

Varien_Io_File $_ioFile (line 66)

Varien IO File class

access: protected

string $_path (line 52)

Full path to tmp dir

access: protected

Methods

clear (line 192)

access: public

void clear ()

close (line 187)

Close file

access: public

bool close ()

getFile (line 106)

Retrieve tmp filename

access: public

string getFile ([ $withPath = false])

$withPath

getFileSize (line 202)

Get writed file size

access: public

unknown getFileSize ()

getIoAdapter (line 122)

Retrieve Io File Adapter

access: public

Varien_Io_File getIoAdapter ()

getPath (line 92)

Retrieve real path to tmp dir

access: public

string getPath ()

init (line 81)

Init model (required)

access: public

Mage_Dataflow_Model_Batch_Io init (Mage_Dataflow_Model_Batch $object)

Mage_Dataflow_Model_Batch $object

open (line 135)

Open file in stream mode

access: public

Mage_Dataflow_Model_Batch_Io open ([ $write = true])

$write

read (line 170)

Read up to 1K bytes from the file pointer

Reading stops as soon as one of the following conditions is met:

length bytes have been read
EOF (end of file) is reached

access: public

string|array read ([ $csv = false], [ $delimiter = ','], [ $enclosure = '"'])

$csv
$delimiter
$enclosure

write (line 156)

Write string

access: public

bool write (string $string)

string $string

Class Constants

TMP_DIR = '/var/tmp/' (line 37)

TMP_NAME = 'batch_%d.tmp' (line 38)

Class Mage_Dataflow_Model_Batch_Io