Примеры

 

Полный код примера можно найти на GitHub по данной ссылке.

 

 

 

Для использования продукта, достаточно загрузить ZIP архив продукта со страницы Downloads нашего сайта, распаковать его, и скопировать содержимое папки /PHP на ваш Web сервер. Данная папка представляет собой Web проект, который содержит все необходимые файлы и ресурсы для работы продукта, а также примеры по работе с вьювером и дизайнером.

 

Для установки продукта в уже существующий проект, достаточно из папки /PHP скопировать папку /vendor в корневую директорию проекта, либо воспользоваться менеджером зависимостей Composer, выполнив следующую консольную команду:

 

console

 

composer require stimulsoft/reports-php

 

 

 

При работе с продуктом, в большинстве случаев достаточно использовать только PHP код, который обеспечивает работу всех основных возможностей. Для более детальной настройки продукта и использования всех возможностей, необходимо использовать JavaScript код. Далее будет описано два варианта использования тех или иных возможностей – при помощи PHP функций и при помощи JavaScript функций. Можно использовать либо первый, либо второй вариант в зависимости от потребностей.

 

Для использования генератора отчетов в Web проекте, необходимо добавить скрипты в блок <head> на PHP странице. Это можно сделать при помощи PHP класса StiJavaScript, в конструкторе нужно указать тип компонента для развёртывания:

 

index.php

 

<head>

<?php

$js = new \Stimulsoft\StiJavaScript(\Stimulsoft\StiComponentType::Report);

$js->renderHtml();

?>

</head>

 

 

 

Также предусмотрена возможность подключения всех необходимых скриптов при помощи <script> блока. Все скрипты продукта нахотятся в директории vendor/stimulsoft/reports-php/scripts/:

 

index.php

 

<head>

<script src="vendor/stimulsoft/reports-php/scripts/stimulsoft.reports.js" type="text/javascript"></script>

</head>

 

 

 

Для работы дашбордов понадобится подключить следующий пакет:

 

console

 

composer require stimulsoft/dashboards-php

 

 

 

В случае использования PHP кода все необходимые скрипты будут подключены автоматически, изменение кода не требуется. В случае использования JavaScript кода понадобится добавить соответствующий файл скрипта, содержащий всё необходимое для работы с аналитическими панелями:

 

index.php

 

<head>

<script src="vendor/stimulsoft/reports-php/scripts/stimulsoft.reports.js" type="text/javascript"></script>

<script src="vendor/stimulsoft/dashboards-php/scripts/stimulsoft.dashboards.js" type="text/javascript"></script>

</head>

 

 

 

После этого, можно использовать PHP классы и функции для работы с отчетами, которые необходимо разместить внутри <script> блока. Например, требуется загрузить отчет из файла и выполнить его построение:

 

index.php

 

<script type="text/javascript">

<?php

$report = new \Stimulsoft\Report\StiReport();

$report->loadFile('reports/SimpleList.mrt');

$report->render('onAfterRender');

$report->renderHtml();

?>

 

function onAfterRender() {

alert('Done!');

}

</script>

 

 

Информация

 

Наши продукты Stimulsoft Reports.PHP и Stimulsoft Dashboards.PHP не имеют нативного ядра генератора отчетов на PHP, построение и экспорт отчета выполняется на стороне клиента при помощи JavaScript кода. Поэтому, при использании PHP кода для работы с компонентами, необходимо вызвать функцию renderHtml(), которая добавит на Web страницу соответствующий JavaScript код для выполнения всех необходимых действий.

 

 

 

При необходимости, те же действия можно выполнить, используя JavaScript функции:

 

index.php

 

<script type="text/javascript">

var report = new Stimulsoft.Report.StiReport();

report.loadFile("reports/SimpleList.mrt");

report.renderAsync(function() {

alert("Done!");

})

</script>

 

 

 

Управление URL для загрузки JavaScript файлов генератора отчетов

По умолчанию все .js файлы продукта загружаются по URL относительно расположения текущего PHP скрипта. В некоторых случаях это поведение требуется изменить, для этого предусмотрены две опции для класса StiJavaScript. Для использования абсолютного пути для загрузки всех скриптов продукта, необходимо установить опцию useRelativeUrls в значение true:

 

index.php

 

<?php

  $js = new \Stimulsoft\StiJavaScript(\Stimulsoft\StiComponentType::Report);

  $js->useRelativeUrls = true;

?>

 

 

 

Для корректировки относительного пути предусмотрена опция relativePath, для которой необходимо задать строковое значение, которое будет использовано при формировании URL адреса загрузки скриптов. При этом опция useRelativeUrls должна быть выключена (использовано значение по умолчанию).

 

index.php

 

<?php

  $js = new \Stimulsoft\StiJavaScript(\Stimulsoft\StiComponentType::Report);

  $js->relativePath = '../../';

?>

 

 

 

Различные варианты развертывания и оптимизации рассмотрены в разделе Уменьшение времени загрузки скриптов.