Import Class Reference

Inheritance diagram for Import:
Item CustomFieldsModel RedBeanModel BeanModel ObservableComponent

Public Member Functions

 __toString ()
 getTempTableName ()
 setTempTableName ($name)

Static Public Member Functions

static getModuleClassName ()
static canSaveMetadata ()
static getDefaultMetadata ()
static isTypeDeletable ()

Protected Member Functions

 beforeDelete ()

Protected Attributes

 $tempTableName

Detailed Description

Definition at line 37 of file Import.php.


Member Function Documentation

__toString (  ) 

Returns the displayable string for the class. Should be overridden in any model that can provide a meaningful string representation of itself.

Returns:
A string.

Reimplemented from RedBeanModel.

Definition at line 41 of file Import.php.

static canSaveMetadata (  )  [static]

By default models cannot save their metadata, allowing them to be loaded quickly because the loading of of metadata can be avoided as much as possible. To make a model able to save its metadata override this method to return true. PUT it before the getDefaultMetadata in the derived class.

Reimplemented from RedBeanModel.

Definition at line 51 of file Import.php.

static getDefaultMetadata (  )  [static]

Returns the default meta data for the class. It must be appended to the meta data from the parent model, if any.

Reimplemented from Item.

Definition at line 56 of file Import.php.

static isTypeDeletable (  )  [static]

To be overriden on intermediate derived classes to return false so that deletes are not done on intermediate classes because the object relational mapping will not clean up properly. For example if User is a Person, and Person is a RedBeanModel delete should be called only on User, not on Person. So User must override isDeletable to return false.

Reimplemented from Item.

Definition at line 74 of file Import.php.

getTempTableName (  ) 

Returns the string name of the temp table in the database used for the import data.

Exceptions:
NotSupportedException 
Returns:
Temporary table id if the import model has a valid id.

Definition at line 84 of file Import.php.

setTempTableName ( name  ) 
Parameters:
string $name

Definition at line 101 of file Import.php.

beforeDelete (  )  [protected]

This method is invoked before deleting a record. The default implementation raises the onBeforeDelete event. You may override this method to do any preparation work for record deletion. Make sure you call the parent implementation so that the event is raised properly.

Returns:
boolean whether the record should be deleted. Defaults to true.

Reimplemented from RedBeanModel.

Definition at line 107 of file Import.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Tue Nov 21 07:10:25 2017