1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Backend\Block\Widget\Grid;
/**
* Interface ExportInterface
*
* @api
* @deprecated 100.2.0 in favour of UI component implementation
* @since 100.0.2
*/
interface ExportInterface
{
/**
* Retrieve grid export types
*
* @return array|bool
* @api
*/
public function getExportTypes();
/**
* Retrieve grid id
*
* @return string
* @api
*/
public function getId();
/**
* Render export button
*
* @return string
*/
public function getExportButtonHtml();
/**
* Add new export type to grid
*
* @param string $url
* @param string $label
* @return \Magento\Backend\Block\Widget\Grid
*/
public function addExportType($url, $label);
/**
* Retrieve a file container array by grid data as CSV
*
* Return array with keys type and value
*
* @return array
* @api
*/
public function getCsvFile();
/**
* Retrieve Grid data as CSV
*
* @return string
* @api
*/
public function getCsv();
/**
* Retrieve data in xml
*
* @return string
* @api
*/
public function getXml();
/**
* Retrieve a file container array by grid data as MS Excel 2003 XML Document
*
* Return array with keys type and value
*
* @param string $sheetName
* @return array
* @api
*/
public function getExcelFile($sheetName = '');
/**
* Retrieve grid data as MS Excel 2003 XML Document
*
* @return string
* @api
*/
public function getExcel();
}