Class: IcmsPersistableExport

Source Location: /kernel/icmspersistableexport.php

Class IcmsPersistableExport

Class Overview

Class to easily export data from IcmsPersistables

Located in /kernel/icmspersistableexport.php [line 14]



		
				Author(s):
		
		
		
API Tags:
Filesource:  Source Code for this file

Information Tags:
Version:  $Id: icmspersistableexport.php 8569 2009-04-11 13:34:58Z icmsunderdog $
Copyright:  The ImpressCMS Project http://www.impresscms.org/
Since:  1.2
License:  GNU General Public License (GPL)

Properties

Methods

[ Top ]
Property Summary
mixed   $criteria  
mixed   $fields  
mixed   $filename  
mixed   $filepath  
mixed   $format  
mixed   $handler  
mixed   $notDisplayFields  
mixed   $options  
mixed   $outputMethods  

[ Top ]
Method Summary
IcmsPersistableExport   IcmsPersistableExport()   Constructor
void   render()   Renders the export
void   setNotDisplayFields()  
void   setOuptutMethods()   Set an array contaning the alternate methods to use instead of the default getVar()

[ Top ]
Properties
mixed   $criteria [line 17]

[ Top ]
mixed   $fields [line 18]

[ Top ]
mixed   $filename [line 20]

[ Top ]
mixed   $filepath [line 21]

[ Top ]
mixed   $format [line 19]

[ Top ]
mixed   $handler [line 16]

[ Top ]
mixed   $notDisplayFields [line 24]

[ Top ]
mixed   $options [line 22]

[ Top ]
mixed   $outputMethods = false [line 23]

[ Top ]
Methods
Constructor IcmsPersistableExport  [line 37]

  IcmsPersistableExport IcmsPersistableExport( &$objectHandler, [object $criteria = null], [array $fields = false], [string $filename = false], [string $filepath = false], [string $format = 'csv'], [array $options = false], object $objectHandler  )

Constructor

Parameters:
object   $objectHandler:  IcmsPersistableHandler handling the data we want to export
object   $criteria:  containing the criteria of the query fetching the objects to be exported
array   $fields:  fields to be exported. If FALSE then all fields will be exported
string   $filename:  name of the file to be created
string   $filepath:  path where the file will be saved
string   $format:  format of the ouputed export. Currently only supports CSV
array   $options:  options of the format to be exported in
   &$objectHandler: 


[ Top ]
render  [line 50]

  void render( $filename  )

Renders the export

Parameters:
   $filename: 


[ Top ]
setNotDisplayFields  [line 97]

  void setNotDisplayFields( $fields  )

Parameters:
   $fields: 


[ Top ]
setOuptutMethods  [line 90]

  void setOuptutMethods( $outputMethods  )

Set an array contaning the alternate methods to use instead of the default getVar()

$outputMethods array example : 'uid' => 'getUserName'...

Parameters:
   $outputMethods: 


[ Top ]

Documentation generated on Sat, 12 Dec 2009 21:21:15 -0600 by phpDocumentor 1.4.1