ImportExportController

Adds features for importing and exporting data.

 class Backend\Behaviors\ImportExportController
extends Backend\Classes\ControllerBehavior

This behavior is implemented in the controller like so:

public $implement = [
    \Backend\Behaviors\ImportExportController::class,
];

public $importExportConfig = 'config_import_export.yaml';

The $importExportConfig property makes reference to the configuration values as either a YAML file, located in the controller view directory, or directly as a PHP array.

Traits

Trait Description
AssetMaker

Asset Maker Trait Adds asset based methods to a class

ConfigMaker

Config Maker Trait Adds configuration based methods to a class

ExtensionTrait

Extension trait

SessionMaker

Session Maker Trait

ViewMaker

View Maker Trait Adds view based methods to a class

WidgetMaker

Widget Maker Trait

Properties

public $exportColumns : array

Export column configuration.

public $exportModel : Model

Export model

public $importColumns : array

Import column configuration.

public $importExportConfig : mixed

Configuration for this behaviour

public $importModel : Model

Import model

protected $actions : array

Visible actions in context of the controller

protected $exportFileName : string

File name used for export output.

protected $exportFormatFormWidget : Backend\Classes\WidgetBase

Reference to the widget used for standard export options.

protected $exportOptionsFormWidget : Backend\Classes\WidgetBase

Reference to the widget used for custom export options.

protected $importOptionsFormWidget : Backend\Classes\WidgetBase

Reference to the widget used for specifying import options.

protected $importUploadFormWidget : Backend\Classes\WidgetBase

Reference to the widget used for uploading import file.

protected $requiredConfig : array

Configuration values that must exist when applying the primary config file.

public $assetPath : string

Inherited from ControllerBehavior

Specifies a path to the asset directory.

public static $extendableStaticCalledClass : string

Inherited from ControllerBehavior

The calling class when using a static method.

public $layout : string

Inherited from ControllerBehavior

Layout to use for the view.

public $suppressLayout : bool

Inherited from ControllerBehavior

Prevents the use of a layout.

public $vars : array

Inherited from ControllerBehavior

A list of variables to pass to the page.

protected $assets : array

Inherited from ControllerBehavior

Collection of assets to display in the layout.

protected $config : array

Inherited from ControllerBehavior

Supplied configuration.

protected $configPath : string

Inherited from ControllerBehavior

Specifies a path to the config directory.

protected $controller : Backend\Classes\Controller

Inherited from ControllerBehavior

Reference to the back end controller.

protected static $extensionCallbacks : array

Inherited from ControllerBehavior

Used to extend the constructor of an extension class. Eg:

BehaviorClass::extend(function($obj) { })

protected $extensionHidden : mixed

Inherited from ControllerBehavior

protected $layoutPath : string

Inherited from ControllerBehavior

Specifies a path to the layout directory.

protected $requiredProperties : array

Inherited from ControllerBehavior

Properties that must exist in the controller using this behavior.

protected $viewPath : string | array

Inherited from ControllerBehavior

Specifies a path to the views directory.

Methods

public __construct (Backend\Classes\Controller $controller)

Behavior constructor

Parameters
Property Description
$controller
Returns
mixed

public download ($name, $outputName = null)

Parameters
Property Description
$name
mixed
$outputName
mixed
Returns
mixed

public export ()

Returns
mixed

public exportFromList (string $definition = null, array $options = []) : void

Outputs the list results as a CSV export.

Parameters
Property Description
$definition
string
$options
array
Returns
void

public exportGetModel ()

Returns
mixed

public exportRender ()

Returns
mixed

public import ()

Returns
mixed

public importExportMakePartial (string $partial, array $params = []) : string

Controller accessor for making partials within this behavior.

Parameters
Property Description
$partial
string
$params
array
Returns
string

Partial contents

public importGetModel ()

Returns
mixed

public importIsColumnRequired ($columnName)

Parameters
Property Description
$columnName
mixed
Returns
mixed

public importRender ()

Returns
mixed

public onExport ()

Returns
mixed

public onExportLoadForm ()

Returns
mixed

public onImport ()

Returns
mixed

public onImportLoadColumnSampleForm ()

Returns
mixed

public onImportLoadForm ()

Returns
mixed

public prepareExportVars () : void

Prepares the view data.

Returns
void

public prepareImportVars () : void

Prepares the view data.

Returns
void

protected checkPermissionsForType ($type) : View

Checks to see if the import/export is controlled by permissions and if the logged in user has permissions.

Parameters
Property Description
$type
mixed
Returns
View

protected checkRequiredImportColumns ()

Returns
mixed

protected checkUseListExportMode ()

Returns
mixed

protected createCsvReader (string $path) : CsvReader

Create a new CSV reader with options selected by the user

Parameters
Property Description
$path
string
Returns
CsvReader

protected getExportColumns ()

Returns
mixed

protected getFormatOptionsFromPost () : array

Returns the file format options from postback. This method can be used to define presets.

Returns
array

protected getImportDbColumns ()

Returns
mixed

protected getImportFileColumns ()

Returns
mixed

protected getImportFilePath ()

Returns
mixed

protected getImportSourceIndexOffset (bool $firstRowTitles) : int

Get the index offset to add to the reported row number in status messages

Parameters
Property Description
$firstRowTitles
bool

Whether or not the first row contains column titles

Returns
int

$offset

protected getModelForType ($type)

Parameters
Property Description
$type
mixed
Returns
mixed

protected getRedirectUrlForType ($type)

Parameters
Property Description
$type
mixed
Returns
mixed

protected makeExportFormatFormWidget ()

Returns
mixed

protected makeExportOptionsFormWidget ()

Returns
mixed

protected makeImportOptionsFormWidget ()

Returns
mixed

protected makeImportUploadFormWidget ()

Returns
mixed

protected makeListColumns ($config)

Parameters
Property Description
$config
mixed
Returns
mixed

protected makeOptionsFormWidgetForType ($type)

Parameters
Property Description
$type
mixed
Returns
mixed

protected processExportColumnsFromPost ()

Returns
mixed

public addCss (array | string $name, array $attributes = []) : void

Inherited from ControllerBehavior

Adds StyleSheet asset to the asset list. Call $this->makeAssets() in a view to output corresponding markup.

Parameters
Property Description
$name
array | string

Specifies a path (URL) or an array of paths to the stylesheet(s).

$attributes
array

Adds extra HTML attributes to the asset link.

Returns
void

public addJs (array | string $name, array $attributes = []) : void

Inherited from ControllerBehavior

Adds JavaScript asset to the asset list. Call $this->makeAssets() in a view to output corresponding markup.

Parameters
Property Description
$name
array | string

Specifies a path (URL) or an array of paths to the script(s).

$attributes
array

Adds extra HTML attributes to the asset link.

Returns
void

public addRss (string $name, array $attributes = []) : void

Inherited from ControllerBehavior

Adds an RSS link asset to the asset list. Call $this->makeAssets() in a view to output corresponding markup.

Parameters
Property Description
$name
string

Specifies a path (URL) to the RSS channel

$attributes
array

Adds extra HTML attributes to the asset link.

Returns
void

public addViewPath (string | array $path) : void

Inherited from ControllerBehavior

Prepends a path on the available view path locations.

Parameters
Property Description
$path
string | array
Returns
void

public combineAssets (array $assets, string $localPath = "") : string

Inherited from ControllerBehavior

Run the provided assets through the Asset Combiner

Parameters
Property Description
$assets
array

Collection of assets

$localPath
string

Prefix all assets with this path (optional)

Returns
string

public static extend (callable $callback)

Inherited from ControllerBehavior
Parameters
Property Description
$callback
callable
Returns
mixed

public extensionApplyInitCallbacks ()

Inherited from ControllerBehavior
Returns
mixed

public static extensionExtendCallback (callable $callback) : void

Inherited from ControllerBehavior

Helper method for ::extend() static method

Parameters
Property Description
$callback
callable
Returns
void

public extensionIsHiddenField ($name)

Inherited from ControllerBehavior
Parameters
Property Description
$name
mixed
Returns
mixed

public extensionIsHiddenMethod ($name)

Inherited from ControllerBehavior
Parameters
Property Description
$name
mixed
Returns
mixed

public flushAssets () : void

Inherited from ControllerBehavior

Disables the use, and subequent broadcast, of assets. This is useful to call during an AJAX request to speed things up. This method works by specifically targeting the hasAssetsDefined method.

Returns
void

public getAssetPath (string $fileName, string $assetPath = null) : string

Inherited from ControllerBehavior

Locates a file based on it's definition. If the file starts with a forward slash, it will be returned in context of the application public path, otherwise it will be returned in context of the asset path.

Parameters
Property Description
$fileName
string

File to load.

$assetPath
string

Explicitly define an asset path.

Returns
string

Relative path to the asset file.

public getAssetPaths () : array

Inherited from ControllerBehavior

Returns an array of all registered asset paths.

Returns
array

public static getCalledExtensionClass ()

Inherited from ControllerBehavior
Returns
mixed

public getConfig (string $name = null, mixed $default = null) : string

Inherited from ControllerBehavior

Safe accessor for configuration values.

Parameters
Property Description
$name
string

Config name, supports array names like "field[key]"

$default
mixed

Default value if nothing is found

Returns
string

public getConfigPath (string $fileName, mixed $configPath = null) : string

Inherited from ControllerBehavior

Locates a file based on it's definition. If the file starts with the ~ symbol it will be returned in context of the application base path, otherwise it will be returned in context of the config path.

Parameters
Property Description
$fileName
string

File to load.

$configPath
mixed

Explicitly define a config path.

Returns
string

Full path to the config file.

public getViewPath (string $fileName, $viewPaths = null) : string

Inherited from ControllerBehavior

Locates a file based on its definition. The file name can be prefixed with a symbol (~|$) to return in context of the application or plugin base path, otherwise it will be returned in context of this object view path.

If the fileName cannot be found it will be returned unmodified.

Parameters
Property Description
$fileName
string
$viewPaths
mixed
Returns
string

public getViewPaths () : array

Inherited from ControllerBehavior

Returns the active view path locations.

Returns
array

public guessConfigPath (string $suffix = "") : string

Inherited from ControllerBehavior

Guess the package path for the called class.

Parameters
Property Description
$suffix
string

An extra path to attach to the end

Returns
string

public guessConfigPathFrom (string $class, string $suffix = "") : string

Inherited from ControllerBehavior

Guess the package path from a specified class.

Parameters
Property Description
$class
string

Class to guess path from.

$suffix
string

An extra path to attach to the end

Returns
string

public guessViewPath (string $suffix = "", boolean $isPublic = false) : string | null

Inherited from ControllerBehavior

Guess the package path for the called class.

Parameters
Property Description
$suffix
string

An extra path to attach to the end

$isPublic
boolean

Returns public path instead of an absolute one

Returns
string | null

public guessViewPathFrom (string $class, string $suffix = "", boolean $isPublic = false) : string | null

Inherited from ControllerBehavior

Guess the package path from a specified class.

Parameters
Property Description
$class
string

Class to guess path from.

$suffix
string

An extra path to attach to the end

$isPublic
boolean

Returns public path instead of an absolute one

Returns
string | null

public hasAssetsDefined () : bool

Inherited from ControllerBehavior

Returns true if assets any have been added.

Returns
bool

public makeAssets ($type = null) : string | null

Inherited from ControllerBehavior

Outputs <link> and <script> tags to load assets previously added with addJs, addCss, & addRss method calls depending on the provided $type

Parameters
Property Description
$type
mixed
Returns
string | null

public makeConfig (array $configFile = [], array $requiredConfig = []) : array | stdClass

Inherited from ControllerBehavior

Reads the contents of the supplied file and applies it to this object.

Parameters
Property Description
$configFile
array
$requiredConfig
array
Returns
array | stdClass

public makeConfigFromArray (array $configArray = []) : stdClass

Inherited from ControllerBehavior

Makes a config object from an array, making the first level keys properties of a new object.

Parameters
Property Description
$configArray
array

Config array.

Returns
stdClass

The config object

public makeFileContents (string $filePath, array $extraParams = []) : string

Inherited from ControllerBehavior

Makes all views in context of the controller, not the behavior.

Parameters
Property Description
$filePath
string

Absolute path to the view file.

$extraParams
array

Parameters that should be available to the view.

Returns
string

public makeFormWidget (string $class, array $fieldConfig = [], array $widgetConfig = []) : Backend\Classes\FormWidgetBase

Inherited from ControllerBehavior

Makes a form widget object with the supplied form field and widget configuration.

Parameters
Property Description
$class
string

Widget class name

$fieldConfig
array

A field name, an array of config or a FormField object.

$widgetConfig
array

An array of config.

Returns

The widget object

public makeLayout ($name = null, array $params = [], boolean $throwException = true) : string | bool

Inherited from ControllerBehavior

Render a layout, defaulting to the layout propery specified on the class

Parameters
Property Description
$name
mixed
$params
array
$throwException
boolean
Returns
string | bool

The layout contents, or false.

public makeLayoutPartial (string $partial, array $params = []) : string

Inherited from ControllerBehavior

Renders a layout partial

Parameters
Property Description
$partial
string
$params
array
Returns
string

public makePartial (string $partial, array $params = [], boolean $throwException = true) : mixed

Inherited from ControllerBehavior

Render a partial file contents located in the views folder.

Parameters
Property Description
$partial
string
$params
array
$throwException
boolean
Returns
mixed

Partial contents or false if not throwing an exception.

public makeView (string $view) : string

Inherited from ControllerBehavior

Loads the specified view. Applies the layout if one is set.

The view file must have the .php extension (or ".htm" for historical reasons) and be located in the views directory

Parameters
Property Description
$view
string
Returns
string

public makeViewContent (string $contents, $layout = null) : string

Inherited from ControllerBehavior

Renders supplied contents inside a layout.

Parameters
Property Description
$contents
string
$layout
mixed
Returns
string

public makeWidget (string $class, array $widgetConfig = []) : mixed | Backend\Classes\WidgetBase

Inherited from ControllerBehavior

Makes a widget object with the supplied configuration file.

Parameters
Property Description
$class
string

Widget class name

$widgetConfig
array

An array of config.

Returns

The widget object

public mergeConfig (mixed $configA, mixed $configB) : stdClass

Inherited from ControllerBehavior

Merges two configuration sources, either prepared or not, and returns them as a single configuration object.

Parameters
Property Description
$configA
mixed
$configB
mixed
Returns
stdClass

The config object

public resetSession () : void

Inherited from ControllerBehavior

Resets all session data related to this widget.

Returns
void

public setConfig (mixed $config, array $required = [])

Inherited from ControllerBehavior

Sets the configuration values

Parameters
Property Description
$config
mixed

Config object or array

$required
array

Required config items

Returns
mixed

protected addAsset (string $type, string $path, array $attributes)

Inherited from ControllerBehavior

Adds the provided asset to the internal asset collections

Parameters
Property Description
$type
string

The type of the asset: 'js' || 'css' || 'rss'

$path
string

The path to the asset

$attributes
array

The attributes for the asset

Returns
mixed

protected controllerMethodExists (string $methodName) : bool

Inherited from ControllerBehavior

Returns true in case if a specified method exists in the extended controller.

Parameters
Property Description
$methodName
string

Specifies the method name

Returns
bool

protected extensionHideField ($name)

Inherited from ControllerBehavior
Parameters
Property Description
$name
mixed
Returns
mixed

protected extensionHideMethod ($name)

Inherited from ControllerBehavior
Parameters
Property Description
$name
mixed
Returns
mixed

protected getAssetEntryBuildPath (array $asset) : string

Inherited from ControllerBehavior

Internal helper, attaches a build code to an asset path

Parameters
Property Description
$asset
array

Stored asset array

Returns
string

protected getAssetScheme (string $asset) : string

Inherited from ControllerBehavior

Internal helper, get asset scheme

Parameters
Property Description
$asset
string

Specifies a path (URL) to the asset.

Returns
string

protected getLocalPath (string | null $relativePath)

Inherited from ControllerBehavior
Parameters
Property Description
$relativePath
string | null
Returns
mixed

protected getSession (string $key = null, string $default = null) : string

Inherited from ControllerBehavior

Retrieves a widget related key/value pair from session data.

Parameters
Property Description
$key
string

Unique key for the data store.

$default
string

A default value to use when value is not found.

Returns
string

protected handleViewException (Throwable $e, integer $obLevel) : void

Inherited from ControllerBehavior

Handle a view exception.

Parameters
Property Description
$e
Throwable
$obLevel
integer
Returns
void

protected hideAction (mixed $methodName)

Inherited from ControllerBehavior

Protects a public method from being available as an controller action.

These methods could be defined in a controller to override a behavior default action. Such methods should be defined as public, to allow the behavior object to access it. By default public methods of a controller are considered as actions. To prevent this occurrence, methods should be hidden by using this method.

Parameters
Property Description
$methodName
mixed

Specifies a method name.

Returns
mixed

protected makeSessionId () : string

Inherited from ControllerBehavior

Returns a unique session identifier for this widget and controller action.

Returns
string

protected putSession (string $key, mixed $value) : void

Inherited from ControllerBehavior

Saves a widget related key/value pair in to session data.

Parameters
Property Description
$key
string

Unique key for the data store.

$value
mixed

The value to store.

Returns
void

protected removeDuplicates () : void

Inherited from ControllerBehavior

Removes duplicate assets from the entire collection.

Returns
void
Copyright © 2024 Winter CMS