Использование
Для использования продукта, достаточно загрузить ZIP архив продукта со страницы Downloads нашего сайта, распаковать его, и скопировать содержимое папки /PHP на ваш Web сервер. Данная папка представляет собой Web проект, который содержит все необходимые файлы и ресурсы для работы продукта, а также примеры по работе с вьювером и дизайнером.
Для установки продукта в уже существующий проект, достаточно из папки /PHP скопировать папку /vendor в корневую директорию проекта, либо воспользоваться менеджером зависимостей Composer, выполнив следующую консольную команду:
console |
composer require stimulsoft/reports-php
|
Для работы дашбордов понадобится подключить следующий пакет:
console |
composer require stimulsoft/dashboards-php
|
При работе с продуктом, в большинстве случаев достаточно использовать только PHP код, который обеспечивает работу всех основных возможностей. Для более детальной настройки продукта и использования всех возможностей, необходимо использовать JavaScript код.
Для использования компонентов в Web проекте, достаточно подключить автоматический загрузчик скриптов в начале PHP файла. После этого, можно использовать все доступные PHP классы и функции для работы с отчетами и дашбордами:
index.php |
<?php require_once 'vendor/autoload.php';
... ?>
|
Для использования вьювера в Web-проекте, предназначен класс StiViewer. При помощи данного класса можно создать объект вьювера, установить необходимые настройки, присвоить отчет для просмотра, обрабатывать запросы и управлять событиями вьювера.
Пример отображения отчета во вьювере на HTML странице:
viewer.php |
<?php require_once 'vendor/autoload.php';
use Stimulsoft\Report\StiReport; use Stimulsoft\Viewer\StiViewer;
$viewer = new StiViewer(); $viewer->process();
$report = new StiReport(); $report->loadFile('reports/SimpleList.mrt'); $viewer->report = $report; ?>
<html> <head> <?php $viewer->javascript->renderHtml(); ?> </head> <body> <?php $viewer->renderHtml(); ?> </body> </html>
|
Полный код примера доступен на GitHub.
В этом примере последовательно выполняются следующие действия:
• | создается экземпляр объекта StiViewer; |
• | выполняется обработка текущего запроса; |
• | создается экземпляр объекта StiReport; |
• | выполняется загрузка шаблона отчета из файла SimpleList.mrt; |
• | созданный отчет присваивается вьюверу; |
• | в шаблоне HTML файла выполняется вывод необходимого JavaScript и HTML кода компонента. |
Метод $viewer->process() выполняет обработку текущего запроса, и, в случае успеха, автоматически возвращает результат на сторону клиента. Более подробно про это рассказано в разделе Обработчик событий.
Метод $viewer->javascript->renderHtml() выполняет вывод кода для подключения необходимых скриптов компонента. Метод $viewer->renderHtml() выполняет вывод JavaScript и HTML кода самого компонента. Предусмотрено несколько вариантов использования, более подробно про это рассказано в разделе Использование генератора отчетов.
Пример упрощённого отображения вьювера без использования HTML шаблона страницы:
viewer.php |
<?php require_once 'vendor/autoload.php';
use Stimulsoft\Report\StiReport; use Stimulsoft\Viewer\StiViewer;
$viewer = new StiViewer(); $viewer->process();
$report = new StiReport(); $report->loadFile('reports/SimpleList.mrt'); $viewer->report = $report;
$viewer->printHtml(); ?>
|
Полный код примера доступен на GitHub.