Tripal
Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
TripalCSVDownloader Class Reference
Inheritance diagram for TripalCSVDownloader:
Inheritance graph
[legend]
Collaboration diagram for TripalCSVDownloader:
Collaboration graph
[legend]

Public Member Functions

 isFieldSupported ($field, $instance)
 
- Public Member Functions inherited from TripalFieldDownloader
 __construct ($collection_id, $outfile_name)
 
 getURL ()
 
 delete ()
 
 writeInit (TripalJob $job=NULL)
 
 writeEntity ($entity, TripalJob $job=NULL)
 
 writeDone (TripalJob $job=NULL)
 
 write (TripalJob $job=NULL)
 
 download ()
 

Static Public Attributes

static $label = 'CSV'
 
static $full_label = 'Comma separated'
 
static $default_extension = 'csv'
 
- Static Public Attributes inherited from TripalFieldDownloader
static $label = 'Generic'
 
static $full_label = 'Generic File format'
 
static $default_extension = 'txt'
 

Protected Member Functions

 formatEntity ($entity)
 
 getHeader ()
 
- Protected Member Functions inherited from TripalFieldDownloader
 setFields ()
 
 setFields2Terms ()
 
 setPrintableFields ()
 

Additional Inherited Members

- Protected Attributes inherited from TripalFieldDownloader
 $collection = NULL
 
 $collection_id = NULL
 
 $collection_bundles = NULL
 
 $outfile = ''
 
 $printable_fields = []
 
 $remote_entity = ''
 
 $fields2terms = []
 
 $fields = []
 
 $fh
 

Member Function Documentation

◆ formatEntity()

TripalCSVDownloader::formatEntity (   $entity)
protected
See also
TripalFieldDownloader::format()

Reimplemented from TripalFieldDownloader.

◆ getHeader()

TripalCSVDownloader::getHeader ( )
protected

◆ isFieldSupported()

TripalCSVDownloader::isFieldSupported (   $field,
  $instance 
)

Member Data Documentation

◆ $default_extension

TripalCSVDownloader::$default_extension = 'csv'
static

Indicates the default extension for the outputfile.

◆ $full_label

TripalCSVDownloader::$full_label = 'Comma separated'
static

A more verbose label that better describes the formatter.

◆ $label

TripalCSVDownloader::$label = 'CSV'
static

Sets the label shown to the user describing this formatter. It should be a short identifier. Use the $full_label for a more descriptive label.


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