Class Mage_Paypal_Model_Report_Settlement

Enter description here ...

Varien_Object

Mage_Paypal_Model_Report_Settlement

Package: Mage\Paypal
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Paypal/Model/Report/Settlement.php

Methods summary
`protected`	# `_construct( )` Initialize resource model Initialize resource model
`protected Mage_Core_Model_Abstract`	# `_beforeSave( )` Stop saving process if file with same report date, account ID and last modified date was already ferched Stop saving process if file with same report date, account ID and last modified date was already ferched Returns `Mage_Core_Model_Abstract` Overrides `Mage_Core_Model_Abstract::_beforeSave()`
`public integer`	# `fetchAndSave( array $config )` Goes to specified host/path and fetches reports from there. Save reports to database. Goes to specified host/path and fetches reports from there. Save reports to database. Parameters `$config` `array` $config SFTP credentials Returns `integer` Number of report rows that were fetched and saved successfully
`public Mage_Paypal_Model_Report_Settlement`	# `parseCsv( string $localCsv, string $format = 'new' )` Parse CSV file and collect report rows Parse CSV file and collect report rows Parameters `$localCsv` `string` $localCsv Path to CSV file `$format` `string` $format CSV format(column names) Returns `Mage_Paypal_Model_Report_Settlement`
`public Mage_Paypal_Model_Report_Settlement`	# `loadByAccountAndDate( )` Load report by unique key (accoutn + report date) Load report by unique key (accoutn + report date) Returns `Mage_Paypal_Model_Report_Settlement`
`public array`	# `getRows( )` Return collected rows for further processing. Return collected rows for further processing. Returns `array`
`public string`	# `getFieldLabel( string $field )` Return name for row column Return name for row column Parameters `$field` `string` $field Field name in row model Returns `string`
`public array`	# `getSftpCredentials( boolean $automaticMode = false )` Iterate through website configurations and collect all SFTP configurations Filter config values if necessary Iterate through website configurations and collect all SFTP configurations Filter config values if necessary Parameters `$automaticMode` `boolean` $automaticMode Whether to skip settings with disabled Automatic Fetching or not Returns `array`
`protected string`	# `_fileNameToDate( string $filename )` Converts a filename to date of report. Converts a filename to date of report. Parameters `$filename` `string` $filename Returns `string`
`protected array`	# `_filterReportsList( array $list )` Filter SFTP file list by filename format Filter SFTP file list by filename format Parameters `$list` `array` $list List of files as per $connection->rawls() Returns `array` Trimmed down list of files

Methods inherited from Mage_Core_Model_Abstract
_afterDelete(), _afterDeleteCommit(), _afterLoad(), _afterSave(), _beforeDelete(), _beforeLoad(), _clearData(), _clearReferences(), _getEventData(), _getResource(), _hasModelChanged(), _init(), _protectFromNonAdmin(), _setResourceModel(), afterCommitCallback(), afterLoad(), cleanModelCache(), clearInstance(), delete(), getCacheIdTags(), getCacheTags(), getCollection(), getEntityId(), getId(), getIdFieldName(), getResource(), getResourceCollection(), getResourceName(), isObjectNew(), load(), save(), setId()

Constants summary
`string`	`REPORTS_HOSTNAME`	`"reports.paypal.com"`	# Default PayPal SFTP host Default PayPal SFTP host
`string`	`SANDBOX_REPORTS_HOSTNAME`	`"reports.sandbox.paypal.com"`	# Default PayPal SFTP host for sandbox mode Default PayPal SFTP host for sandbox mode
`string`	`REPORTS_PATH`	`"/ppreports/outgoing"`	# PayPal SFTP path PayPal SFTP path
`string`	`FILES_IN_CHARSET`	`"UTF-16"`	# Original charset of old report files Original charset of old report files
`string`	`FILES_OUT_CHARSET`	`"UTF-8"`	# Target charset of report files to be parsed Target charset of report files to be parsed

Properties summary
`protected array`	`$_rows`	`array()`	# Reports rows storage Reports rows storage
`protected array`	`$_csvColumns`	array( 'old' => array( 'section_columns' => array( '' => 0, 'TransactionID' => 1, 'InvoiceID' => 2, 'PayPalReferenceID' => 3, 'PayPalReferenceIDType' => 4, 'TransactionEventCode' => 5, 'TransactionInitiationDate' => 6, 'TransactionCompletionDate' => 7, 'TransactionDebitOrCredit' => 8, 'GrossTransactionAmount' => 9, 'GrossTransactionCurrency' => 10, 'FeeDebitOrCredit' => 11, 'FeeAmount' => 12, 'FeeCurrency' => 13, 'CustomField' => 14, 'ConsumerID' => 15 ), 'rowmap' => array( 'TransactionID' => 'transaction_id', 'InvoiceID' => 'invoice_id', 'PayPalReferenceID' => 'paypal_reference_id', 'PayPalReferenceIDType' => 'paypal_reference_id_type', 'TransactionEventCode' => 'transaction_event_code', 'TransactionInitiationDate' => 'transaction_initiation_date', 'TransactionCompletionDate' => 'transaction_completion_date', 'TransactionDebitOrCredit' => 'transaction_debit_or_credit', 'GrossTransactionAmount' => 'gross_transaction_amount', 'GrossTransactionCurrency' => 'gross_transaction_currency', 'FeeDebitOrCredit' => 'fee_debit_or_credit', 'FeeAmount' => 'fee_amount', 'FeeCurrency' => 'fee_currency', 'CustomField' => 'custom_field', 'ConsumerID' => 'consumer_id' ) ), 'new' => array( 'section_columns' => array( '' => 0, 'Transaction ID' => 1, 'Invoice ID' => 2, 'PayPal Reference ID' => 3, 'PayPal Reference ID Type' => 4, 'Transaction Event Code' => 5, 'Transaction Initiation Date' => 6, 'Transaction Completion Date' => 7, 'Transaction Debit or Credit' => 8, 'Gross Transaction Amount' => 9, 'Gross Transaction Currency' => 10, 'Fee Debit or Credit' => 11, 'Fee Amount' => 12, 'Fee Currency' => 13, 'Custom Field' => 14, 'Consumer ID' => 15, 'Payment Tracking ID' => 16 ), 'rowmap' => array( 'Transaction ID' => 'transaction_id', 'Invoice ID' => 'invoice_id', 'PayPal Reference ID' => 'paypal_reference_id', 'PayPal Reference ID Type' => 'paypal_reference_id_type', 'Transaction Event Code' => 'transaction_event_code', 'Transaction Initiation Date' => 'transaction_initiation_date', 'Transaction Completion Date' => 'transaction_completion_date', 'Transaction Debit or Credit' => 'transaction_debit_or_credit', 'Gross Transaction Amount' => 'gross_transaction_amount', 'Gross Transaction Currency' => 'gross_transaction_currency', 'Fee Debit or Credit' => 'fee_debit_or_credit', 'Fee Amount' => 'fee_amount', 'Fee Currency' => 'fee_currency', 'Custom Field' => 'custom_field', 'Consumer ID' => 'consumer_id', 'Payment Tracking ID' => 'payment_tracking_id' ) ) )	#

Properties inherited from Mage_Core_Model_Abstract
`$_cacheTag, $_dataSaveAllowed, $_eventObject, $_eventPrefix, $_isObjectNew, $_resource, $_resourceCollectionName, $_resourceName`

Packages

Classes

Exceptions

Class Mage_Paypal_Model_Report_Settlement

Returns

Overrides

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns