Mecanismo de relatório inteligente - edição comunitária
Smart Report Engine é uma estrutura de relatórios PHP fácil de usar que permite a criação sem esforço de relatórios profissionais programaticamente dentro de seus projetos.
Começando
1- Você tem a opção de clonar a edição comunitária do Smart Report Engine ou baixá-la diretamente desta página de download
2- Após o download, extraia a pasta compactada para revelar a estrutura do SmartReportEngine. O conteúdo será semelhante ao seguinte:
├── SmartReportingEngine/
├── sre_config/
└── config.php
├── sre_reports/
├── db/
└── example.sql
├── examples/
└── sre_bootstrap.php
3- Para iniciar seu primeiro projeto em seu servidor, você precisa importar um banco de dados MySQL de amostra. Este processo permitirá que você comece a usar o Smart Report Engine sem problemas.
- Dentro do pacote baixado do Smart Report Engine, localize o arquivo "/db/example.sql" no diretório "db". Este arquivo SQL contém os comandos necessários para criar e preencher uma única tabela MySQL chamada 'items'
- Selecione o banco de dados MySQL para a configuração do seu primeiro projeto. Você pode optar por um banco de dados existente ou criar um novo especificamente para este projeto.
- Importe o arquivo “example.sql” para o banco de dados MySQL escolhido. Isso criará a tabela "itens" e a preencherá com os dados iniciais.
4- Configure a String de Conexão do banco de dados
- Navegue até o diretório "sre_config" no pacote Smart Report Engine Community Edition. Lá você encontrará o arquivo “config.php”. Abra este arquivo usando qualquer editor de texto de sua preferência.
- No arquivo "config.php" você encontrará uma seção dedicada à configuração do banco de dados. Atualize a cadeia de conexão com os detalhes apropriados do banco de dados MySQL para onde você importou o arquivo SQL de exemplo durante a terceira etapa. Certifique-se de fornecer o nome do host, nome do banco de dados, nome de usuário e senha corretos em seus respectivos campos.
5- Salve as alterações no arquivo "config.php".
6- No diretório "/examples" da Community Edition, você encontrará três exemplos úteis para começar a usar o Smart Report Engine. Para executar qualquer um desses exemplos, basta acessar seus URLs em seu navegador. Isso permitirá que você visualize o relatório gerado com base no código de cada exemplo.
7- Caso prefira construir os projetos de exemplo do zero, prossiga com a etapa 8 do processo de instalação.
NOTA: Independentemente da sua escolha, as seções passo a passo do código fornecerão explicações para o código em cada exemplo.
8- Para começar a escrever seu primeiro projeto, você precisará de um novo script PHP. Para os fins deste tutorial, você pode adicionar o script ao diretório raiz da edição da comunidade, junto com o arquivo “sre_bootstrap.php”. Se você baixou manualmente a edição da comunidade (sem usar o Composer), você precisará exigir o arquivo de carregamento automático "sre_bootstrap.php" em seu código, conforme demonstrado no exemplo abaixo. Caso seu código seja colocado em locais diferentes para outros projetos, certifique-se de ajustar o caminho para este arquivo de carregamento automático de acordo. Siga estas etapas para iniciar seu projeto:
- Crie um novo script PHP para o seu projeto.
- Opcionalmente, coloque o script no diretório raiz da edição da comunidade (mesmo nível de "sre_bootstrap.php") para o propósito deste tutorial.
- Em seu primeiro novo projeto, tente escrever o seguinte código PHP simples. Deve funcionar sem problemas.
use SRE E ngine C ustomEngine ;
use SRE E ngine R eportOptions ;
require_once " sre_bootstrap.php " ;
try {
$report = new ReportOptions ();
$report - > select_tables( " items " )
- > set_grouping( " country " )
- > set_title( " Items Per country " )
->select_all_fields ();
$engine = new CustomEngine( $report ) ;
$report_path = $engine->create_report ();
if ( $report_path ) {
// The user will be redirected to the URL of the generated report. All generated reports are stored as subdirectories under /sre_reports.
header( " location: " . $report_path ) ;
exit ();
}
} catch (Exception $e ) {
echo $e->getMessage ();
}
Gerar este relatório
Passo a passo do código: entendendo o exemplo
O código fornecido demonstra um exemplo básico de uso eficaz do Smart Report Engine. Vamos percorrer o código passo a passo para entender como ele funciona:
- Namespaces: o código fornecido utiliza dois namespaces, "SREEngineCustomEngine" e "SREEngineReportOptions". Esses namespaces ajudam a organizar e acessar partes específicas do código.
- Exigindo "sre_bootstrap.php": Se você baixou manualmente a edição da comunidade (sem usar o Composer), você precisa adicionar um arquivo especial chamado "sre_bootstrap.php" ao seu código.
- Criando o objeto ReportOptions: O código inicializa um objeto da classe "ReportOptions". Este objeto é responsável por definir as opções necessárias para o seu relatório. Você pode personalizar diversas opções, lembrando que algumas funcionalidades são exclusivas da edição comercial.
- Passando o objeto ReportOptions para CustomEngine: Depois de definir as opções de relatório, você passa o objeto "ReportOptions" para o construtor da classe "CustomEngine". Esta classe cuida da criação do seu relatório com base nas opções fornecidas.
- Chamando a função CreateReport: Para gerar seu relatório, você chama a função "CreateReport" usando o objeto "CustomEngine". Esta função processa as opções definidas e gera o relatório. Após a criação bem-sucedida, ele retorna a URL do relatório. Todos os relatórios gerados usando o Smart Report Engine serão salvos automaticamente no diretório "sre_reports".
Links importantes
- Mais exemplos
- Comparação detalhada de licenças Para ajudá-lo a entender melhor as distinções entre as edições comunitárias e comerciais, fornecemos uma visão geral concisa nesta página. Ele destaca as principais diferenças nos recursos e casos de uso de cada versão.
- Solução de problemas do Smart Report Engine O objetivo desta seção da documentação é orientar os usuários através de pontos de verificação essenciais a serem considerados ao encontrar quaisquer problemas durante o processo de geração de relatórios com o Smart Report Engine. Além disso, exploraremos o recurso de registro do Smart Report Engine, que auxilia na solução de possíveis problemas que possam surgir nos relatórios gerados.
- Documentação do Smart Report Engine Nesta seção, você descobrirá documentação abrangente e exemplos para cada classe, método e constante integrados do Smart Report Engine.
- O que há de novo Esta seção abrangerá os recursos mais recentes introduzidos no Smart Report Engine.
- Página inicial do mecanismo de relatório inteligente
- Contate-nos
Licença da edição comunitária
A Community Edition permite que você:
- Experimente o Smart Report Engine (apenas recursos não Premium).
- Utilize gratuitamente o Smart Report Engine para uso pessoal.
- Integre livremente o Smart Report Engine em projetos gratuitos de código aberto, desde que você mantenha nossas reivindicações de direitos autorais.
A Community Edition restringe você de:
- Acessando recursos Premium.
- Integração do Smart Report Engine em projetos comerciais ou SaaS.
- Remoção da declaração "Desenvolvido por" dos relatórios gerados pela edição comunitária do Smart Report Maker.
NOTA: Ao usar qualquer uma de nossas edições comerciais, você terá acesso a todos os recursos premium, bem como à remoção de todas as restrições da comunidade mencionadas acima.
Mecanismo de relatório inteligente Pro
Smart Report Engine Pro é uma versão avançada do Smart Report Engine, concedendo acesso a todos os seus recursos premium. Custando apenas US$ 64 por uma licença Team, a edição Pro oferece inúmeras vantagens, incluindo:
- Acesso completo a todos os recursos Premium.
- Pode ser usado em projetos SaaS e comerciais.
- Integração fácil com qualquer sistema de login baseado em sessão existente.
- Ausência de atribuição “Powered by” no rodapé dos relatórios gerados.
- Um ano gratuito de atualizações gratuitas.
- Um desconto de 70% em taxas de atualização futuras (após o período de atualização gratuita).
- Suporte prioritário ao cliente.
- A capacidade de implantar o Smart Report Engine em um número ilimitado de servidores ou projetos.
- A Licença Team permite o uso por até 7 desenvolvedores, enquanto a Licença Enterprise permite um número ilimitado de desenvolvedores dentro da organização.
- Royal grátis (sem cobrança extra) quando você entrega o Smart Report Engine com seu produto comercial.
Autor
Webuccino Criando produtos fáceis de usar desde 2007