OpenPSA API Documentation
\
midcom
datamanager
extension
transformer
type
helper
indexer
storage
container
template
validation
dba
events
grid
provider
routing
workflow

\midcom_helper_filesync_exporter

Base class used for writing pure code components, retrieves a few common variables from the component's current environment.

Note, that the request data, for ease of use, already contains the L10n Databases of the Component and MidCOM itself located in this class. They are stored as 'l10n' and 'l10n_midcom'. Also available as 'config' is the current component configuration.

Summary

Methods
Properties
Constants
__construct()
__get()
__isset()
set_active_leaf()
add_stylesheet()
get_workflow()
export()
create()
$_component
$delete_missing
$root_dir
$_i18n
$_l10n
$_l10n_midcom
$_config
No constants found
delete_missing_folders()
delete_missing_files()
No protected properties found
N/A
No private methods found
$_services
N/A

Properties

$_component

$_component : string

The name of the component, e.g. net.nehmer.static. Should be used whenever the component's name is required instead of hardcoding it.

Type

string

$delete_missing

$delete_missing : boolean

Whether to delete elements from file system that do not exist in database

Type

boolean

$root_dir

$root_dir :

Type

$_i18n

$_i18n : \midcom_services_i18n

A handle to the i18n service.

Type

\midcom_services_i18n

$_l10n

$_l10n : \midcom_services_i18n_l10n

The components' L10n string database.

Type

\midcom_services_i18n_l10n

$_l10n_midcom

$_l10n_midcom : \midcom_services_i18n_l10n

The global MidCOM string database.

Type

\midcom_services_i18n_l10n

$_config

$_config : \midcom_helper_configuration

The current configuration.

Type

\midcom_helper_configuration

$_services

$_services : array

Array that holds the already instantiated services

Type

array

Methods

__construct()

__construct(string  $root_dir, boolean  $delete_missing = false)

Initializes the class.

Parameters

string $root_dir

The export root directory
boolean $delete_missing

whether to delete missing items from database

__get()

__get(  $field)

Parameters

$field

__isset()

__isset(  $field)

Parameters

$field

set_active_leaf()

set_active_leaf(  $leaf_id)

Parameters

$leaf_id

add_stylesheet()

add_stylesheet(string  $url, string  $media = false)

Convenience shortcut for adding CSS files

Parameters

string $url

The stylesheet URL
string $media

The media type(s) for the stylesheet, if any

get_workflow()

get_workflow(string  $identifier, array  $options = array()) : \midcom\workflow\dialog

Parameters

string $identifier
array $options

Returns

\midcom\workflow\dialog

export()

export()

create()

create(string  $type) : \midcom_helper_filesync_exporter

Dynamically create exporter instances.

The returned instances will be created, but not initialized.

Parameters

string $type

type

Returns

\midcom_helper_filesync_exporter —

The newly created exporter instance.

delete_missing_folders()

delete_missing_folders(array  $foldernames,   $path)

Parameters

array $foldernames
$path

delete_missing_files()

delete_missing_files(array  $filenames,   $path)

Parameters

array $filenames
$path