Galette\Controllers\CsvController Class Reference

Inheritance diagram for Galette\Controllers\CsvController:

Collaboration diagram for Galette\Controllers\CsvController:

Public Member Functions
	export (Request $request, Response $response)
	doExport (Request $request, Response $response)
	import (Request $request, Response $response)
	doImports (Request $request, Response $response)
	uploadImportFile (Request $request, Response $response)
	getFile (Request $request, Response $response, string $file, string $type)
	confirmRemoveFile (Request $request, Response $response, string $file, string $type)
	removeFile (Request $request, Response $response, string $file, string $type)
	importModel (Request $request, Response $response)
	getImportModel (Request $request, Response $response)
	storeModel (Request $request, Response $response)
	membersExport (Request $request, Response $response)
	contributionsExport (Request $request, Response $response, string $type)
	scheduledPaymentsExport (Request $request, Response $response)
Public Member Functions inherited from Galette\Controllers\AbstractController
	__construct (ContainerInterface $container)

Protected Member Functions
	sendResponse (Response $response, string $filepath, string $filename)
Protected Member Functions inherited from Galette\Controllers\AbstractController
	galetteRedirect (Request $request, Response $response)
	getArgs (Request $request)
	withJson (Response $response, array $data, int $status=200)

Additional Inherited Members
Protected Attributes inherited from Galette\Controllers\AbstractController
Db	$zdb
Login	$login
Preferences	$preferences
Twig	$view
Logo	$logo
PrintLogo	$print_logo
Plugins	$plugins
RouteParser	$routeparser
History	$history
I18n	$i18n
L10n	$l10n
Session	$session
Messages	$flash
FieldsConfig	$fields_config
ListsConfig	$lists_config
array	$members_fields
array	$members_form_fields
array	$members_fields_cats

Detailed Description

Galette CSV controller

Author

Johan Cwiklinski johan.nosp@m.@x-t.nosp@m.nd.be

Member Function Documentation

confirmRemoveFile()

Galette\Controllers\CsvController::confirmRemoveFile	(	Request	$request,
		Response	$response,
		string	$file,
		string	$type
	)

Remove CSV file confirmation (imports or exports)

Parameters

Request	$request	PSR Request
Response	$response	PSR Response
string	$file	File name
string	$type	File type

Returns

Response

contributionsExport()

Galette\Controllers\CsvController::contributionsExport	(	Request	$request,
		Response	$response,
		string	$type
	)

Contributions CSV exports

Parameters

Request	$request	PSR Request
Response	$response	PSR Response
string	$type	One of 'contributions' or 'transactions'

Returns

Response

doExport()

Galette\Controllers\CsvController::doExport	(	Request	$request,
		Response	$response
	)

Proceed exports

Parameters

Request	$request	PSR Request
Response	$response	PSR Response

Returns

Response

doImports()

Galette\Controllers\CsvController::doImports	(	Request	$request,
		Response	$response
	)

Proceed imports

Parameters

Request	$request	PSR Request
Response	$response	PSR Response

Returns

Response

export()

Galette\Controllers\CsvController::export	(	Request	$request,
		Response	$response
	)

Exports page

Parameters

Request	$request	PSR Request
Response	$response	PSR Response

Returns

Response

getFile()

Galette\Controllers\CsvController::getFile	(	Request	$request,
		Response	$response,
		string	$file,
		string	$type
	)

Get CSV file (imports or exports)

Parameters

Request	$request	PSR Request
Response	$response	PSR Response
string	$file	File name
string	$type	File type

Returns

Response

getImportModel()

Galette\Controllers\CsvController::getImportModel	(	Request	$request,
		Response	$response
	)

Get CSV import model file

Parameters

Request	$request	PSR Request
Response	$response	PSR Response

Returns

Response

import()

Galette\Controllers\CsvController::import	(	Request	$request,
		Response	$response
	)

Imports page

Parameters

Request	$request	PSR Request
Response	$response	PSR Response

Returns

Response

importModel()

Galette\Controllers\CsvController::importModel	(	Request	$request,
		Response	$response
	)

Import model page

Parameters

Request	$request	PSR Request
Response	$response	PSR Response

Returns

Response

FIXME:

• set fields that should not be part of import

membersExport()

Galette\Controllers\CsvController::membersExport	(	Request	$request,
		Response	$response
	)

Members CSV exports

Parameters

Request	$request	PSR Request
Response	$response	PSR Response

Returns

Response

removeFile()

Galette\Controllers\CsvController::removeFile	(	Request	$request,
		Response	$response,
		string	$file,
		string	$type
	)

Remove CSV file (imports or exports)

Parameters

Request	$request	PSR Request
Response	$response	PSR Response
string	$file	File name
string	$type	File type

Returns

Response

scheduledPaymentsExport()

Galette\Controllers\CsvController::scheduledPaymentsExport	(	Request	$request,
		Response	$response
	)

Scheduled payments CSV exports

Parameters

Request	$request	PSR Request
Response	$response	PSR Response

Returns

Response

sendResponse()

Galette\Controllers\CsvController::sendResponse ( Response  $response, string  $filepath, string  $filename  )

protected

Send response

Parameters

Response	$response	PSR Response
string	$filepath	File path on disk
string	$filename	File name for output

Returns

Response

storeModel()

Galette\Controllers\CsvController::storeModel	(	Request	$request,
		Response	$response
	)

Store CSV model

Parameters

Request	$request	PSR Request
Response	$response	PSR Response

Returns

Response

uploadImportFile()

Galette\Controllers\CsvController::uploadImportFile	(	Request	$request,
		Response	$response
	)

Get CSV file (imports or exports)

Parameters

Request	$request	PSR Request
Response	$response	PSR Response

Returns

Response

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/galette-apidoc/checkouts/develop/galette/lib/Galette/Controllers/CsvController.php