\Kendo\UI\FileManager

A PHP wrapper for Kendo UI FileManager.

Inherits from \Kendo\UI\Widget.

Usage

To use FileManager in a PHP page instantiate a new instance, configure it via the available configuration methods and output it by echo-ing the result of the render method.

Using Kendo FileManager

<?php
// Create a new instance of FileManager and specify its id
$fileManager = new \Kendo\UI\FileManager('FileManager');

// Configure it
$fileManager->breadcrumb(true)

// Output it

echo $fileManager->render();
?>

Methods

Configures or disables the Breadcrumb component.

Returns

\Kendo\UI\FileManager

Parameters

$value boolean|\Kendo\UI\FileManagerBreadcrumb|array

Example - using boolean

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->breadcrumb(true);
?>

Example - using \Kendo\UI\FileManagerBreadcrumb 

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$breadcrumb = new \Kendo\UI\FileManagerBreadcrumb();
$delimiterIcon = 'value';
$breadcrumb->delimiterIcon($delimiterIcon);
$fileManager->breadcrumb($breadcrumb);
?>

Example - using array

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$delimiterIcon = 'value';
$fileManager->breadcrumb(array('delimiterIcon' => $delimiterIcon));
?>

command

Fired when server command is executed (copy, move, delete or rename).The event is useful to get feedback when server commands has failed or succeeded and take additional actions based on the status. For additional information check the command event documentation.

Returns

\Kendo\UI\FileManager

Parameters

$value string|\Kendo\JavaScriptFunction

Example - using string which defines a JavaScript function

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->command('function(e) { }');
?>

Example - using string which defines a JavaScript name

<script>
    function onCommand(e) {
        // handle the command event.
    }
</script>
<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->command('onCommand');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->command(new \Kendo\JavaScriptFunction('function(e) { }'));
?>

contextMenu

Configures the ContextMenu of the FileManager.

Returns

\Kendo\UI\FileManager

Parameters

$value boolean|\Kendo\UI\FileManagerContextMenu|array

Example - using boolean

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->contextMenu(true);
?>

Example - using \Kendo\UI\FileManagerContextMenu 

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$contextMenu = new \Kendo\UI\FileManagerContextMenu();
$activate = new \Kendo\JavaScriptFunction('function() { }');
$contextMenu->activate($activate);
$fileManager->contextMenu($contextMenu);
?>

Example - using array

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$activate = new \Kendo\JavaScriptFunction('function() { }');
$fileManager->contextMenu(array('activate' => $activate));
?>

dataBinding

Fired before the widget binds to its data source. For additional information check the dataBinding event documentation.

Returns

\Kendo\UI\FileManager

Parameters

$value string|\Kendo\JavaScriptFunction

Example - using string which defines a JavaScript function

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->dataBinding('function(e) { }');
?>

Example - using string which defines a JavaScript name

<script>
    function onDataBinding(e) {
        // handle the dataBinding event.
    }
</script>
<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->dataBinding('onDataBinding');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->dataBinding(new \Kendo\JavaScriptFunction('function(e) { }'));
?>

dataBound

Fired when the widget is bound to data from its data source. For additional information check the dataBound event documentation.

Returns

\Kendo\UI\FileManager

Parameters

$value string|\Kendo\JavaScriptFunction

Example - using string which defines a JavaScript function

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->dataBound('function(e) { }');
?>

Example - using string which defines a JavaScript name

<script>
    function onDataBound(e) {
        // handle the dataBound event.
    }
</script>
<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->dataBound('onDataBound');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->dataBound(new \Kendo\JavaScriptFunction('function(e) { }'));
?>

dataSource

Sets the data source of the widget.

Returns

\Kendo\UI\FileManager

Parameters

$value \Kendo\Data\DataSource|array

Example - using \Kendo\Data\DataSource 

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$dataSource = new \Kendo\Data\DataSource();
$fileManager->dataSource($dataSource);
?>

Example - using array

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$schema = new \Kendo\Data\DataSourceSchema();
$fileManager->dataSource(array('schema' => $schema));
?>

dialogs

Specifies the composite Dialog widgets of the FileManager.

Returns

\Kendo\UI\FileManager

Parameters

$value \Kendo\UI\FileManagerDialogs|array

Example - using \Kendo\UI\FileManagerDialogs 

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$dialogs = new \Kendo\UI\FileManagerDialogs();
$upload = new \Kendo\UI\FileManagerDialogsUpload();
$dialogs->upload($upload);
$fileManager->dialogs($dialogs);
?>

Example - using array

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$upload = new \Kendo\UI\FileManagerDialogsUpload();
$fileManager->dialogs(array('upload' => $upload));
?>

draggable

Enables or disables the drag and drop features of the FileManager.

Returns

\Kendo\UI\FileManager

Parameters

$value boolean

Example

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->draggable(true);
?>

drop

Fired when a file is dragged and dropped over a folder. For additional information check the drop event documentation.

Returns

\Kendo\UI\FileManager

Parameters

$value string|\Kendo\JavaScriptFunction

Example - using string which defines a JavaScript function

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->drop('function(e) { }');
?>

Example - using string which defines a JavaScript name

<script>
    function onDrop(e) {
        // handle the drop event.
    }
</script>
<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->drop('onDrop');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->drop(new \Kendo\JavaScriptFunction('function(e) { }'));
?>

error

Fired when a error in the DataSource happen. For additional information check the error event documentation.

Returns

\Kendo\UI\FileManager

Parameters

$value string|\Kendo\JavaScriptFunction

Example - using string which defines a JavaScript function

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->error('function(e) { }');
?>

Example - using string which defines a JavaScript name

<script>
    function onError(e) {
        // handle the error event.
    }
</script>
<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->error('onError');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->error(new \Kendo\JavaScriptFunction('function(e) { }'));
?>

execute

Fired when a command is executed. For additional information check the execute event documentation.

Returns

\Kendo\UI\FileManager

Parameters

$value string|\Kendo\JavaScriptFunction

Example - using string which defines a JavaScript function

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->execute('function(e) { }');
?>

Example - using string which defines a JavaScript name

<script>
    function onExecute(e) {
        // handle the execute event.
    }
</script>
<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->execute('onExecute');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->execute(new \Kendo\JavaScriptFunction('function(e) { }'));
?>

height

Configures the height of the FileManager.

Returns

\Kendo\UI\FileManager

Parameters

$value float|string

Example - using float

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->height(1);
?>

Example - using string

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->height('value');
?>

initialView

Configures the initial view of the FileManager.

Returns

\Kendo\UI\FileManager

Parameters

$value string

Example

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->initialView('value');
?>

messages

Defines the text of the localizable UI parts of the FileManager.

Returns

\Kendo\UI\FileManager

Parameters

$value \Kendo\UI\FileManagerMessages|array

Example - using \Kendo\UI\FileManagerMessages 

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$messages = new \Kendo\UI\FileManagerMessages();
$toolbar = new \Kendo\UI\FileManagerMessagesToolbar();
$messages->toolbar($toolbar);
$fileManager->messages($messages);
?>

Example - using array

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$toolbar = new \Kendo\UI\FileManagerMessagesToolbar();
$fileManager->messages(array('toolbar' => $toolbar));
?>

Fired when navigation occurs. For additional information check the navigate event documentation.

Returns

\Kendo\UI\FileManager

Parameters

$value string|\Kendo\JavaScriptFunction

Example - using string which defines a JavaScript function

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->navigate('function(e) { }');
?>

Example - using string which defines a JavaScript name

<script>
    function onNavigate(e) {
        // handle the navigate event.
    }
</script>
<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->navigate('onNavigate');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->navigate(new \Kendo\JavaScriptFunction('function(e) { }'));
?>

open

Fired when a file is opened (with double click). For additional information check the open event documentation.

Returns

\Kendo\UI\FileManager

Parameters

$value string|\Kendo\JavaScriptFunction

Example - using string which defines a JavaScript function

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->open('function(e) { }');
?>

Example - using string which defines a JavaScript name

<script>
    function onOpen(e) {
        // handle the open event.
    }
</script>
<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->open('onOpen');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->open(new \Kendo\JavaScriptFunction('function(e) { }'));
?>

previewPane

Configures the Preview Pane of the FileManager.

Returns

\Kendo\UI\FileManager

Parameters

$value \Kendo\UI\FileManagerPreviewPane|array

Example - using \Kendo\UI\FileManagerPreviewPane 

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$previewPane = new \Kendo\UI\FileManagerPreviewPane();
$metaFields = array();
$previewPane->metaFields($metaFields);
$fileManager->previewPane($previewPane);
?>

Example - using array

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$metaFields = array();
$fileManager->previewPane(array('metaFields' => $metaFields));
?>

resizable

Configures the resizable features of the FileManager.

Returns

\Kendo\UI\FileManager

Parameters

$value boolean

Example

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->resizable(true);
?>

select

Fired when selection changes. For additional information check the select event documentation.

Returns

\Kendo\UI\FileManager

Parameters

$value string|\Kendo\JavaScriptFunction

Example - using string which defines a JavaScript function

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->select('function(e) { }');
?>

Example - using string which defines a JavaScript name

<script>
    function onSelect(e) {
        // handle the select event.
    }
</script>
<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->select('onSelect');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->select(new \Kendo\JavaScriptFunction('function(e) { }'));
?>

toolbar

Configures the Toolbar of the FileManager

Returns

\Kendo\UI\FileManager

Parameters

$value boolean|\Kendo\UI\FileManagerToolbar|array

Example - using boolean

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->toolbar(true);
?>

Example - using \Kendo\UI\FileManagerToolbar 

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$toolbar = new \Kendo\UI\FileManagerToolbar();
$click = new \Kendo\JavaScriptFunction('function() { }');
$toolbar->click($click);
$fileManager->toolbar($toolbar);
?>

Example - using array

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$click = new \Kendo\JavaScriptFunction('function() { }');
$fileManager->toolbar(array('click' => $click));
?>

upload

Configures the composite Upload widget of the FileManager. Accepts the same options as the kendoUpload widget.

Returns

\Kendo\UI\FileManager

Parameters

$value \Kendo\UI\FileManagerUpload|array

Example - using \Kendo\UI\FileManagerUpload 

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$upload = new \Kendo\UI\FileManagerUpload();
$directory = true;
$upload->directory($directory);
$fileManager->upload($upload);
?>

Example - using array

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$directory = true;
$fileManager->upload(array('directory' => $directory));
?>

uploadUrl

Sets the upload url for the Upload widget.

Returns

\Kendo\UI\FileManager

Parameters

$value string

Example

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->uploadUrl('value');
?>

views

Configures every view registered for the FileManager.

Returns

\Kendo\UI\FileManager

Parameters

$value \Kendo\UI\FileManagerViews|array

Example - using \Kendo\UI\FileManagerViews 

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$views = new \Kendo\UI\FileManagerViews();
$grid = new \Kendo\UI\FileManagerViewsGrid();
$views->grid($grid);
$fileManager->views($views);
?>

Example - using array

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$grid = new \Kendo\UI\FileManagerViewsGrid();
$fileManager->views(array('grid' => $grid));
?>

width

Configures the width of the FileManager.

Returns

\Kendo\UI\FileManager

Parameters

$value float|string

Example - using float

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->width(1);
?>

Example - using string

<?php
$fileManager = new \Kendo\UI\FileManager('FileManager');
$fileManager->width('value');
?>
In this article
Related articles
Not finding the help you need?