Contentserv PHP API

CSGuiUpload extends CSGuiComponent
in package

The CSGuiComponent is the root class of all CSGui classes and represents any HTML representable component

The usage of all CSGui classes is the same:

  • Get an object through a call to the corresponding CSGui::create[Component]
  • Configure the object by setter functions
  • Output custom HTML where ever you like
  • Finally call the getHtml method on the object and echo the returned html code

The CSGuiComponent delivers therefore only the makeHtml function as well as popup handler code.

Tags

Table of Contents

DROPZONE_CLASS  = 'CSUploadDropZone'
Public constant that defines the class to be used in dropzone areas
$isDisabled  : mixed
$isPortal  : mixed
$popup  : mixed
$popupIDField  : mixed
$popupUrl  : mixed
__construct()  : mixed
addCSSCode()  : void
Adds a css snippet to the windows internal css code as they are used in the head Note that links to urls within the file must be relative to the forward.php
addCSSLink()  : void
Adds a link to the windows external cascading style sheets Note that - that the admin.css is included by default - the link to the file is from the browsers point of view relative to the forward.php - that links to urls within the file are relative to the css file location.
addEventListener()  : void
Ads an event listener.
addFormAttributes()  : void
Adds attributes to the form HTML tag.
addFormClass()  : void
Adds a CSS class to the form.
addJSAPI()  : void
Preloads a js API library instead of using CS.loadAPI in the code
addJSCode()  : void
Adds a js code snippet to the windows internal js scripts as they are used in the head or directly to the component
addJSLink()  : void
Adds a link to the windows external js scripts Note that the link to the file is from the browsers point of view relative to the forward.php
addJSUtils()  : void
Preloads a js util library instead of using CS.loadUtils in the code
enableJQuery()  : void
Enables JQuery by loading all required libraries
enableJQueryEasy()  : void
Enables JQuery easy by loading all required libraries (experimental only)
enableJQueryPlugin()  : bool
Enables jQuery plugin.
enableJQueryUI()  : void
Enables JQuery UI by loading all required libraries (experimental only)
enablePluginCalls()  : mixed
Enables / disables all calls to CSGuiComponent plugins, if it is not wanted
getActionUrl()  : string
Returns the form action.
getAllowedFileTypes()  : array<string|int, mixed>
Returns allowed file types.
getAvailablePlugins()  : array<string|int, CSGuiUploadPlugin>
Returns all CSGuiUploadPlugin plugins
getContainerHtml()  : string
Returns HTMl for Upload container
getController()  : object
returns the controller of this gui component
getDefaultActionUrl()  : string
Returns the default action URL.
getEncodedSetting()  : mixed|string
Returns overall settings.
getEnctype()  : string
Returns the enctype
getFormAttributes()  : string
Returns all necessary form attributes as string.
getFormClass()  : string
Returns all defined form CSS classes.
getFormHtml()  : string
Returns the complete HTML of the form.
getFormMethod()  : string
Returns the form method.
getFormName()  : string
Returns the form name (id).
getHiddenInputHtml()  : string
Returns hidden input HTML.
getHtmlFileInputName()  : string
Returns the input name of the input type=file Input HTML Tag.
getInitJs()  : string
Returns the javascript init call for the component.
getInnerFormHtml()  : string
Returns the inner form HTML.
getSettings()  : array<string|int, mixed>
Returns overall settings.
getSingleUpload()  : bool
Determines if uploader is in SingleUpload mode.
getUploadFolder()  : string
Returns the defined upload folder by setUploadFolder-method
isAllowedToUpload()  : bool
Checks if an upload is allowed on the system.
isAllowedToUploadFileTypeToUploadFolder()  : bool
Checks if the given FileType is allowed to be uploaded.
isPortal()  : bool
Returns whether the component is used in the portal
makeForwardUrl()  : mixed
makeHtml()  : string
Returns the complete HTML representation of the component
onCloseUpload()  : void
Adds an event listener to the global close upload button which can be enabled with setCloseButtonVisible-method.
popupAddCheckboxItem()  : void
Adds a checkbox popup item to the end of the current component's popup
popupAddItem()  : void
Adds a popup item to the end of the current component's popup
popupAddJavascriptFunction()  : void
Adds a Javascript method to the components Javascript which can be used to display a popup.
popupAddSeparator()  : void
Adds a popup separator item to the end of the current component's popup
popupAddSubMenuDefinition()  : void
Adds a definition (Icon, GroupIdentifier, GroupIndex) for a sub menu entry.
popupEnableDebugMode()  : mixed
popupEvaluateCode()  : mixed
Provides a condition which must be true if the popup item should be available
popupGetJavascript()  : string
Creates a javascript onContext='...' code, which can be inserted in a html component
popupGetMultipleRequestID()  : bool
This function may be used to check whether the request is a popupRequest for multiple elements.
popupGetRequestID()  : string
If a user request a popup the id describing the kind of request is returned here This function may also be used to check whether the request is a popupRequest.
popupInsertItem()  : void
Adds a popup item into a specified location of the current component's popup
popupMakeHtml()  : mixed
Creates the final popup html code
popupRemoveAllItems()  : void
Completely removes all popup items from the component
popupRemoveItem()  : void
Remove one items from the popup for the component
popupRemoveItemsByNamespace()  : void
Remove multiple from the popup specified by the namespace. All items having all the passed namespaces will be removed even if they are having more than the passed.
popupSetCharset()  : string
Sets the encoding for the popup components
popupSetDefaultPopup()  : void
Sets the default popup for the component
popupSetRequestID()  : void
Overwrites the id returned by popupSetRequestID
popupSetUrl()  : void
Changes the url where the popup should be loaded from.
popupSetVisible()  : void
Enables or disables the visiblity of the popup.
popupUseDefaultItem()  : void
Adds a standard popup item to the end of the current component's popup
removeEventListener()  : bool
Removes an EventListener from the editor.
setActionUrl()  : void
Set the form action.
setAdditionalParams()  : void
Sets additional params.
setAllowedFileTypes()  : void
Sets the desired "allowed" file types.
setCloseButtonVisible()  : void
Enabled the close upload button.
setController()  : void
sets the controller for the gui component
setDuplicate()  : void
Sets the duplicate flag.
setEnctype()  : void
Sets form enctype.
setFileConfigurationVisible()  : void
Defines whether the file configuration is visible for the files in the upload dialog.
setFileName()  : void
Sets the new desired FileName (with extension) of uploaded files
setFileNamePrefix()  : void
Sets a file name prefix
setFormMethod()  : void
Sets the form method.
setFormName()  : void
Sets the form id and name of the form Form name and id are set to be the same value.
setHideFormTag()  : void
Sets a flag to hide the form.
setMamFileId()  : void
Sets a MamFile ID.
setMaxFileSize()  : $this|CSGuiUpload
Defines the max file size (for singe file)
setMultiDropZones()  : void
Sets the multiDropZones boolean in settings array
setOverwrite()  : void
Sets the overwrite flag.
setPortalMode()  : void
Sets the component to the browsers portal
setSingleUpload()  : void
Sets the component to SingleUpload, allowing to upload only one file.
setUploadFolder()  : void
Sets the upload folder for files.
throwError()  : void
Throws a CSException

Constants

DROPZONE_CLASS

Public constant that defines the class to be used in dropzone areas

public mixed DROPZONE_CLASS = 'CSUploadDropZone'
Tags

Properties

$isDisabled

public mixed $isDisabled = \false
Tags
access

private

Methods

__construct()

public __construct() : mixed
Tags
Return values
mixed —

addCSSCode()

Adds a css snippet to the windows internal css code as they are used in the head Note that links to urls within the file must be relative to the forward.php

public addCSSCode(string $sCode) : void
Parameters
$sCode : string

the code of the css without any <style> elements

Tags
access

public

Return values
void —

addCSSLink()

Adds a link to the windows external cascading style sheets Note that - that the admin.css is included by default - the link to the file is from the browsers point of view relative to the forward.php - that links to urls within the file are relative to the css file location.

public addCSSLink(string $sCsslink) : void
Parameters
$sCsslink : string

the href of the css file

Tags
access

public

Return values
void —

addEventListener()

Ads an event listener.

public addEventListener(string $sEventName, string $sEventCodeJs) : void

Possible Events:

  • BeforeUpload
  • BeforeFileUpload
  • AfterFileUpload
  • AfterUpload
  • CancelUpload
  • SelectFile
  • DeselectFile
Parameters
$sEventName : string

The event name.

$sEventCodeJs : string

The javascript code. "his"-scope is the current uploader (CSGuiUploadApi). "event" is the event native browser event object. "data"-parameter is available depending on event type.

Tags
Return values
void —

addFormAttributes()

Adds attributes to the form HTML tag.

public addFormAttributes(string $sFormAttributes) : void
Parameters
$sFormAttributes : string
Tags
Return values
void —

addFormClass()

Adds a CSS class to the form.

public addFormClass(string $sFormClass) : void
Parameters
$sFormClass : string
Tags
Return values
void —

addJSAPI()

Preloads a js API library instead of using CS.loadAPI in the code

public addJSAPI(string $api) : void
Parameters
$api : string

the name of the CS API library in the ../admin/modules/[MODULE]/CS[MODULE].js directory

Tags
access

public

Return values
void —

addJSCode()

Adds a js code snippet to the windows internal js scripts as they are used in the head or directly to the component

public addJSCode(string $sCode) : void
Parameters
$sCode : string

the code of the js without any <javasctipt> elements

Tags
access

public

Return values
void —

addJSLink()

Adds a link to the windows external js scripts Note that the link to the file is from the browsers point of view relative to the forward.php

public addJSLink(string $sHref) : void
Parameters
$sHref : string

the href of the js

Tags
access

public

Return values
void —

addJSUtils()

Preloads a js util library instead of using CS.loadUtils in the code

public addJSUtils(string $util) : void
Parameters
$util : string

the name of the CS Util library in the ../admin/core/utils/js/ directory

Tags
access

public

Return values
void —

enableJQuery()

Enables JQuery by loading all required libraries

public enableJQuery() : void
Tags
Return values
void —

enableJQueryEasy()

Enables JQuery easy by loading all required libraries (experimental only)

public enableJQueryEasy() : void
Tags
Return values
void —

enableJQueryPlugin()

Enables jQuery plugin.

public enableJQueryPlugin(string $sPluginName) : bool

For possible plugins see ADMIN_LOCAL/lib/javascript/jquery/plugins subfolder.

Parameters
$sPluginName : string

The name of the jquery plugin (case sensitive) and without the "jquery." prefix. To load the jquery.cookie.js plugin give only "cookie" as param.

Tags
Return values
bool —

Whenever the plugin path was found or not.

enableJQueryUI()

Enables JQuery UI by loading all required libraries (experimental only)

public enableJQueryUI() : void
Tags
Return values
void —

enablePluginCalls()

Enables / disables all calls to CSGuiComponent plugins, if it is not wanted

public static enablePluginCalls([bool $enabled = false ]) : mixed
Parameters
$enabled : bool = false

whether plugin calls may be used

Tags
Return values
mixed —

getActionUrl()

Returns the form action.

public getActionUrl() : string
Tags
Return values
string —

getAllowedFileTypes()

Returns allowed file types.

public getAllowedFileTypes() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —

getAvailablePlugins()

Returns all CSGuiUploadPlugin plugins

public getAvailablePlugins() : array<string|int, CSGuiUploadPlugin>
Tags
Return values
array<string|int, CSGuiUploadPlugin> —

getContainerHtml()

Returns HTMl for Upload container

public getContainerHtml() : string
Tags
Return values
string —

getController()

returns the controller of this gui component

public getController() : object
Tags
access

public

Return values
object —

the controller of the gui component

getDefaultActionUrl()

Returns the default action URL.

public getDefaultActionUrl() : string
Tags
Return values
string —

getEncodedSetting()

Returns overall settings.

public getEncodedSetting([bool $bFormatWithHtmlEntities = true ]) : mixed|string
Parameters
$bFormatWithHtmlEntities : bool = true

If settings should be formatted with htmlentities

Tags
Return values
mixed|string —

getEnctype()

Returns the enctype

public getEnctype() : string
Tags
Return values
string —

getFormAttributes()

Returns all necessary form attributes as string.

public getFormAttributes() : string
Tags
Return values
string —

getFormClass()

Returns all defined form CSS classes.

public getFormClass() : string
Tags
Return values
string —

getFormHtml()

Returns the complete HTML of the form.

public getFormHtml() : string
Tags
Return values
string —

getFormMethod()

Returns the form method.

public getFormMethod() : string
Tags
Return values
string —

getFormName()

Returns the form name (id).

public getFormName() : string

Form name and id are same.

Tags
Return values
string —

getHiddenInputHtml()

Returns hidden input HTML.

public getHiddenInputHtml() : string
Tags
Return values
string —

getHtmlFileInputName()

Returns the input name of the input type=file Input HTML Tag.

public getHtmlFileInputName() : string
Tags
Return values
string —

getInitJs()

Returns the javascript init call for the component.

public getInitJs([bool $bWithScriptTags = TRUE ]) : string
Parameters
$bWithScriptTags : bool = TRUE

If the return string should contain script-tags

Tags
Return values
string —

getInnerFormHtml()

Returns the inner form HTML.

public getInnerFormHtml() : string
Tags
Return values
string —

getSettings()

Returns overall settings.

public getSettings() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —

getSingleUpload()

Determines if uploader is in SingleUpload mode.

public getSingleUpload() : bool
Tags
Return values
bool —

getUploadFolder()

Returns the defined upload folder by setUploadFolder-method

public getUploadFolder() : string
Tags
Return values
string —

isAllowedToUpload()

Checks if an upload is allowed on the system.

public isAllowedToUpload() : bool
Tags
Return values
bool —

isAllowedToUploadFileTypeToUploadFolder()

Checks if the given FileType is allowed to be uploaded.

public isAllowedToUploadFileTypeToUploadFolder(string $sFileType[, string $sUploadFolder = '' ]) : bool
Parameters
$sFileType : string
$sUploadFolder : string = ''
Tags
Return values
bool —

isPortal()

Returns whether the component is used in the portal

public static isPortal() : bool
Tags
access

protected

Return values
bool —

whether the portal mode is activated

makeForwardUrl()

public static makeForwardUrl(mixed $url[, mixed $useRequestParams = array() ]) : mixed
Parameters
$url : mixed
$useRequestParams : mixed = array()
Tags
access

protected

Return values
mixed —

makeHtml()

Returns the complete HTML representation of the component

public makeHtml() : string

May be called only once for each object in most cases.

Tags
Return values
string —

some html code for JS, CSS tags

onCloseUpload()

Adds an event listener to the global close upload button which can be enabled with setCloseButtonVisible-method.

public onCloseUpload(string $sJsCode) : void
Parameters
$sJsCode : string

A javascript code. See addEventListener-method for further information.

Tags
Return values
void —

popupAddCheckboxItem()

Adds a checkbox popup item to the end of the current component's popup

public popupAddCheckboxItem(mixed $sLabel, mixed $sJavascript[, mixed $bIsEnabled = true ][, mixed $bIsSelected = false ][, mixed $sAccessKey = '' ][, mixed $bEvalCondition = true ][, mixed $mNamespaces = array() ][, mixed $sGroupIdentifier = '' ], mixed $iGroupIndex) : void
Parameters
$sLabel : mixed
$sJavascript : mixed
$bIsEnabled : mixed = true
$bIsSelected : mixed = false
$sAccessKey : mixed = ''
$bEvalCondition : mixed = true
$mNamespaces : mixed = array()
$sGroupIdentifier : mixed = ''
$iGroupIndex : mixed
Tags
access

public

Return values
void —

popupAddItem()

Adds a popup item to the end of the current component's popup

public popupAddItem(string $sLabel[, string $sJavascript = '' ][, int $bIsEnabled = true ][, string $sIconPath = '' ][, string $sAccessKey = '' ][, bool $bEvalCondition = true ][, array<string|int, mixed>|string $mNamespaces = array() ][, string $sGroupIdentifier = '' ], int $iGroupIndex) : void
Parameters
$sLabel : string

label of the popup item. It can use '//' to create a submenu, e.g. 'submenu_label//sub_submenu_label//label'

$sJavascript : string = ''

Javascript code to call with the popup item

$bIsEnabled : int = true

can be false if the popup item should be visible but disabled

$sIconPath : string = ''

Image of the item relative to the admin/images/popup/ directory

$sAccessKey : string = ''

Keyboard access key of the popup item

$bEvalCondition : bool = true

If the condition should be evaluated.

$mNamespaces : array<string|int, mixed>|string = array()

The namespace for the button like "workflow"

$sGroupIdentifier : string = ''

The identifier to add the popup item to a group, which has separator at the beginning and at the end.

$iGroupIndex : int

The index of the group. The index will be used to order the groups. The lowest index will be taken of all popup items inside of a group.

Tags
access

public

Return values
void —

popupAddJavascriptFunction()

Adds a Javascript method to the components Javascript which can be used to display a popup.

public popupAddJavascriptFunction([string $jsName = 'displayComponentPopup' ]) : void

It can be called with the given name and the requested POPUPID and event (event object) as argument, e.g. displayComponentPopup(ID, event)

Parameters
$jsName : string = 'displayComponentPopup'

the name of the Javascript method, if it should be different from the standard 'displayComponentPopup'

Tags
Return values
void —

popupAddSeparator()

Adds a popup separator item to the end of the current component's popup

public popupAddSeparator([string $evalCondition = true ][, string $subMenu = '' ]) : void
Parameters
$evalCondition : string = true

optional php condition to be evaluated as true to let the popup item be available

$subMenu : string = ''

optional sub menu the separator should be placed within. It can use '//' to add the seperator within a submenu, e.g. 'submenu_label//subsubmenu_label'

Tags
access

public

Return values
void —

popupAddSubMenuDefinition()

Adds a definition (Icon, GroupIdentifier, GroupIndex) for a sub menu entry.

public popupAddSubMenuDefinition(string $sSubMenuLabel, string $sIcon[, string $sGroupIdentifier = '' ], int $iGroupIndex) : void
Parameters
$sSubMenuLabel : string

The target sub menu label

$sIcon : string

THe icon of the sub menu.

$sGroupIdentifier : string = ''

The group identifier

$iGroupIndex : int

The index of the group.

Tags
Return values
void —

popupEnableDebugMode()

public popupEnableDebugMode() : mixed
Tags
access

private

Return values
mixed —

popupEvaluateCode()

Provides a condition which must be true if the popup item should be available

public popupEvaluateCode(mixed $evalCode) : mixed

Sometimes it is necessary to evaluate further code to define a $evalCondition. As the condition only returns one value, this can not be done there. Therefore any phpCode can be evaluated using the popupEvaluateCode method. Here e.g. conditions can be stored in variables which can be used in the $evalCondition later. {RecordID} can be used to get the id of the current selected item

Parameters
$evalCode : mixed
Tags
access

public

Return values
mixed —

popupGetJavascript()

Creates a javascript onContext='...' code, which can be inserted in a html component

public popupGetJavascript(string $id[, string $innerHtml = "" ][, string $elementName = 'span' ][, string $embedAttribute = 'oncontextmenu' ][, string $additionalAttributes = "" ][, string $popupUrl = '' ][, string $popupIDField = '' ][, string $jsCode = '' ]) : string
Parameters
$id : string

The value which will can be received using the popupGetRequestID() method

$innerHtml : string = ""

The content of the optional html element is not empty. If this value is not set the $id is used instead

$elementName : string = 'span'

An optional html element name which will contain the attribute

$embedAttribute : string = 'oncontextmenu'

The attribute which should contain the JavaScript code

$additionalAttributes : string = ""

Additional attributes which should be additionally added to the oncontext command

$popupUrl : string = ''

Overwrites the standard url where the popup is defined

$popupIDField : string = ''

Overwrites the standard IDField for the popup which will be added to the request and is necessary to get the results using the popupGetRequestID method if it has been modified

$jsCode : string = ''

The JavaScript code which should be evaluated before the contextmenu is shown

Tags
Return values
string —

The JavaScript code or a complete html element which will create the popup request

popupGetMultipleRequestID()

This function may be used to check whether the request is a popupRequest for multiple elements.

public popupGetMultipleRequestID() : bool
Tags
Return values
bool —

whether a popup request for multiple items have been sent

popupGetRequestID()

If a user request a popup the id describing the kind of request is returned here This function may also be used to check whether the request is a popupRequest.

public popupGetRequestID() : string
Tags
Return values
string —

the ID for which a popup is requested

popupInsertItem()

Adds a popup item into a specified location of the current component's popup

public popupInsertItem(mixed $mIndex, mixed $sLabel[, mixed $sJavascript = '' ][, mixed $bIsEnabled = true ][, mixed $sIconPath = '' ][, mixed $sAccessKey = '' ][, mixed $bEvalCondition = true ][, mixed $mNamespaces = array() ][, mixed $sGroupIdentifier = '' ], mixed $iGroupIndex) : void
Parameters
$mIndex : mixed
$sLabel : mixed
$sJavascript : mixed = ''
$bIsEnabled : mixed = true
$sIconPath : mixed = ''
$sAccessKey : mixed = ''
$bEvalCondition : mixed = true
$mNamespaces : mixed = array()
$sGroupIdentifier : mixed = ''
$iGroupIndex : mixed
Tags
access

public

Return values
void —

popupMakeHtml()

Creates the final popup html code

public popupMakeHtml(mixed $PopupID) : mixed
Parameters
$PopupID : mixed
Tags
access

protected

Return values
mixed —

popupRemoveAllItems()

Completely removes all popup items from the component

public popupRemoveAllItems([array<string|int, mixed> $keep = array() ][, bool $recursive = false ]) : void
Parameters
$keep : array<string|int, mixed> = array()

the labels of the items which may be kept

$recursive : bool = false

whether this action should be applied to all subcomponents as subtrees in CSGuiMixedTrees

Tags
access

public

Return values
void —

popupRemoveItem()

Remove one items from the popup for the component

public popupRemoveItem(string $label[, string|bool $evalCondition = true ][, array<string|int, mixed>|string $aNamespaces = array() ]) : void
Parameters
$label : string

label of the popup item

$evalCondition : string|bool = true

optional php condition to be evaluated as true to let the popup item be available {RecordID} can be used to get the id of the current selected item

$aNamespaces : array<string|int, mixed>|string = array()

Either a simple string for a namespace like "workflow" or an array for further specification like array("Workflow", "123"). All items having the same label and all namespaces passed set (even if they are having more) will be removed.

Tags
access

public

Return values
void —

popupRemoveItemsByNamespace()

Remove multiple from the popup specified by the namespace. All items having all the passed namespaces will be removed even if they are having more than the passed.

public popupRemoveItemsByNamespace([array<string|int, mixed> $aNamespaces = array() ]) : void
Parameters
$aNamespaces : array<string|int, mixed> = array()

An array containing all the defined namespaces for the popup items to be removed

Tags
Return values
void —

popupSetCharset()

Sets the encoding for the popup components

public popupSetCharset(mixed $charset) : string
Parameters
$charset : mixed
Tags
Return values
string —

$charset the new characterset

popupSetDefaultPopup()

Sets the default popup for the component

public popupSetDefaultPopup(CSGuiPopup $popup) : void
Parameters
$popup : CSGuiPopup

Popup object to use as popup for the component

Tags
access

protected

Return values
void —

popupSetRequestID()

Overwrites the id returned by popupSetRequestID

public popupSetRequestID(string $id) : void
Parameters
$id : string

the value of the id to overwrite

Tags
Return values
void —

popupSetUrl()

Changes the url where the popup should be loaded from.

public popupSetUrl([string $popupUrl = '' ][, string $idField = 'POPUP_ID' ][, bool $recursive = false ]) : void

It can be set if the pure forward name is not sufficient or another file should be used for a popup request This is an important option to add additional GET parameters, which should be available again for popups You can add additionalParameters to the forward url using the & seperator, e.g 'destination.php&param1=true'

Parameters
$popupUrl : string = ''

the url where the popup is defined

$idField : string = 'POPUP_ID'

the IDField for the popup which will be added to the request and is necessary to get the results using the popupGetRequestID method if it has been modified

$recursive : bool = false

whether this action should be applied to all subcomponents as subtrees in CSGuiMixedTrees

Tags
access

public

Return values
void —

popupSetVisible()

Enables or disables the visiblity of the popup.

public popupSetVisible([bool $visibility = null ]) : void

If a popupAddItem is called before, the popup is automatically set to visible . If you only create the popup menu when recieving the popupGetRequestID parameter you have to enable the popup menu manually. You can even hide the popup completly be setting the $visibility to false

Parameters
$visibility : bool = null

whether the component has a visible popup menu

Tags
access

public

Return values
void —

popupUseDefaultItem()

Adds a standard popup item to the end of the current component's popup

public popupUseDefaultItem(string $label[, string|bool $evalCondition = true ]) : void

The popupitems defined using the popupSetDefaultPopup can be reused after popupRemoveAllItems has been called. This offers the possibility to reuse working popupitems in a userdefined popupmenu The type of popup item which should be used is defined by the $label parameter. This label represents the label of the original item

Parameters
$label : string

label of the popup item

$evalCondition : string|bool = true

php condition to be evaluated as true to let the popup item be available

Tags
access

public

Return values
void —

removeEventListener()

Removes an EventListener from the editor.

public removeEventListener(string $sEventName) : bool
Parameters
$sEventName : string
Tags
Return values
bool —

setActionUrl()

Set the form action.

public setActionUrl(string $sActionUrl) : void
Parameters
$sActionUrl : string
Tags
Return values
void —

setAdditionalParams()

Sets additional params.

public setAdditionalParams(array<string|int, mixed> $aParams) : void

This params are forwarded with the POST request of file upload. It is possible to retrieve them in CSFileUploadPlugin with getUploadParam-method. Not primitive values are converted into an JSON.

Parameters
$aParams : array<string|int, mixed>
Tags
Return values
void —

setAllowedFileTypes()

Sets the desired "allowed" file types.

public setAllowedFileTypes(string|array<string|int, mixed> $aFileTypes) : void

Attention! The function filters not allowed file types.

Parameters
$aFileTypes : string|array<string|int, mixed>

A comma separated like "csv, xml" or an array of file types

Tags
Return values
void —

setCloseButtonVisible()

Enabled the close upload button.

public setCloseButtonVisible([bool $bVisible = true ]) : void

To interact (event) with the button you have to add an event listener:

  • with JS: oMyUploadInstance.onGlobalCloseUpload(fn);
  • with PHP: $oMyUploadInstance->onCloseUpload('...');
Parameters
$bVisible : bool = true
Tags
Return values
void —

setController()

sets the controller for the gui component

public setController(object $oController) : void
Parameters
$oController : object

the controller for the gui component

Tags
access

public

Return values
void —

setDuplicate()

Sets the duplicate flag.

public setDuplicate([bool $bDuplicate = true ]) : void

If the uploaded files should be duplicates if a file is already existing.

Parameters
$bDuplicate : bool = true
Tags
Return values
void —

setEnctype()

Sets form enctype.

public setEnctype(string $sEnctype) : void
Parameters
$sEnctype : string
Tags
Return values
void —

setFileConfigurationVisible()

Defines whether the file configuration is visible for the files in the upload dialog.

public setFileConfigurationVisible(bool $bIsVisible) : void
Parameters
$bIsVisible : bool

The boolean value whether the file configuration is visible for the files in the upload dialog.

Tags
Return values
void —

setFileName()

Sets the new desired FileName (with extension) of uploaded files

public setFileName(string $sFileName) : void
Parameters
$sFileName : string
Tags
Return values
void —

setFileNamePrefix()

Sets a file name prefix

public setFileNamePrefix(string $sPrefix) : void
Parameters
$sPrefix : string
Tags
Return values
void —

setFormMethod()

Sets the form method.

public setFormMethod(mixed $sFormMethod) : void
Parameters
$sFormMethod : mixed
Tags
Return values
void —

setFormName()

Sets the form id and name of the form Form name and id are set to be the same value.

public setFormName(string $sFormName) : void
Parameters
$sFormName : string
Tags
Return values
void —

setHideFormTag()

Sets a flag to hide the form.

public setHideFormTag() : void
Tags
Return values
void —

setMamFileId()

Sets a MamFile ID.

public setMamFileId(int $sMamFileId) : void

If set all added files will be uploaded to given ID.

Parameters
$sMamFileId : int
Tags
Return values
void —

setMaxFileSize()

Defines the max file size (for singe file)

public setMaxFileSize(int $iSize) : $this|CSGuiUpload
Parameters
$iSize : int

File size in BYTES (without any extension like MB, GB...)

Tags
Return values
$this|CSGuiUpload —

setMultiDropZones()

Sets the multiDropZones boolean in settings array

public setMultiDropZones([bool $bEnable = false ]) : void
Parameters
$bEnable : bool = false
Tags
Return values
void —

setOverwrite()

Sets the overwrite flag.

public setOverwrite([bool $bOverwrite = true ]) : void

If uploaded files should overwrite already existing files.

Parameters
$bOverwrite : bool = true
Tags
Return values
void —

setPortalMode()

Sets the component to the browsers portal

public static setPortalMode([mixed $isPortal = true ]) : void
Parameters
$isPortal : mixed = true
Tags
access

protected

Return values
void —

setSingleUpload()

Sets the component to SingleUpload, allowing to upload only one file.

public setSingleUpload([bool $bSingeUpload = true ]) : void
Parameters
$bSingeUpload : bool = true
Tags
Return values
void —

setUploadFolder()

Sets the upload folder for files.

public setUploadFolder(string $sUploadFolder) : void
Parameters
$sUploadFolder : string

A relative path to ADMIN

Tags
Return values
void —

throwError()

Throws a CSException

public static throwError(string $sMessage, int $iCode) : void
Parameters
$sMessage : string
$iCode : int
Tags
Return values
void — 

        

        
    




    

    

                

    

        

            
Search results