Overview

Packages

  • Auth
    • Ads
    • Ldap
    • Xoops
  • Autotasks
  • Config
    • Category
    • Item
    • Option
  • Core
    • Filesystem
    • Filters
    • Logger
    • Mail
    • Message
    • Password
    • Security
    • StopSpammer
    • Template
    • Textsanitizer
    • VersionChecker
  • Data
    • Avatar
    • Comment
  • Database
    • Connection
    • Criteria
    • Legacy
    • MySQL
    • PDO
    • Updater
  • Feeds
    • RSS
  • File
  • Form
    • Base
    • Elements
  • ICMS
    • IPF
      • View
  • Image
    • Category
  • Ipf
    • Category
    • Controller
    • Export
    • form
    • Keyhighlighter
    • Member
    • Object
    • Permission
    • richfile
    • Tree
    • urllink
    • View
  • kernel
    • Set
  • Member
    • Group
    • GroupMembership
    • GroupPermission
    • User
  • Messaging
  • Module
  • None
  • Notification
  • Page
  • Plugins
    • Editor
  • Preload
    • Libraries
  • Privmessage
  • Session
  • SmartObject
  • View
    • Block
    • Breadcrumb
    • PageNav
    • PrinterFriendly
    • Template
    • Templates
    • Theme
    • Tree

Classes

  • icms_ipf_export_Handler
  • icms_ipf_export_Renderer
  • Overview
  • Package
  • Class

Class icms_ipf_export_Handler

Package: Ipf\Export
Category: ICMS
Copyright: The ImpressCMS Project http://www.impresscms.org/
License: GNU General Public License (GPL)
Author: marcan marcan@impresscms.org
Author: Sina Asghari (aka stranger) pesian_stranger@users.sourceforge.net
Located at ipf/export/Handler.php
Methods summary
public
# __construct( object & $objectHandler, object $criteria = null, array $fields = false, string $filename = false, string $filepath = false, string $format = 'csv', array $options = false )

Constructor

Constructor

Parameters

$objectHandler
IcmsPersistableHandler handling the data we want to export
$criteria
containing the criteria of the query fetching the objects to be exported
$fields
fields to be exported. If FALSE then all fields will be exported
$filename
name of the file to be created
$filepath
path where the file will be saved
$format
format of the ouputed export. Currently only supports CSV
$options
options of the format to be exported in
public
# render( $filename )

Renders the export

Renders the export

public
# setOuptutMethods( array $outputMethods )

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

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

Parameters

$outputMethods
array example : 'uid' => 'getUserName'...
public
# setNotDisplayFields( $fields )
Properties summary
public $handler
#
public $criteria
#
public $fields
#
public $format
#
public $filename
#
public $filepath
#
public $options
#
public boolean $outputMethods
# false
public $notDisplayFields
#
API documentation generated by ApiGen