umvc

UMVC Framework

Versão 2.0.2-2024-12-13

Uma estrutura simples de aplicação da web que implementa o padrão arquitetônico do Model-View-View-Controller (MVC).

Principais recursos

• Visualizações simples baseadas em html/php com hierarquia de renderização
• Conexão de banco de dados baseada em PDO com o construtor de consultas baseado em matriz (apenas o MySQL está implementado atualmente)
• Classes de modelos fáceis de usar
• Tradução simples de controle de URL para controlador/método com passagem automática de parâmetros
• Suporte a migração do banco de dados
• O login do usuário via SAML (usando esse recurso precisa composer require "simplesamlphp/simplesamlphp:^2.2" )

Módulos

A UMVC suporta módulos, consulte Configuração/componentes.

Suporte de codecepção

A estrutura suporta testes funcionais com seu plug -in da estrutura. O codecepção instalado globalmente deve ser compatível com necessário (atualmente v3.1.2)

Linha de comando

A UMVC suporta CLI. Você pode criar seus próprios comandos. Os comandos embutidos são:

• migrar

Executar comandos como php app $command $action $parameters

Instalação

A estrutura pode ser incluída em seu projeto com o compositor. Run composer require uhi67/umvc:dev-master . O projeto novo e vazio pode ser criado usando composer create-project --prefer-dist uhi67/umvc-app name . Isso fornecerá um novo aplicativo vazio usando a estrutura UMVC no diretório nomeado. Escolha qualquer nome que você preferir.

Primeiros passos para construir seu aplicativo usando umvc

AVISO: Esta parte está em construção. Saiba mais sobre as classes mencionadas no docblock da definição de classe.

1. Crie composer.json do seu aplicativo e inclua uh67/umvc , por exemplo, composer init --name myname/myapp --require uhi67/umvc:* .
2. Execute composer update .
3. Copie vendor/uh67/umvc/app para a raiz do seu aplicativo. Este é o lançador dos comandos da CLI.
4. Cópia vendor/uh67/umvc/www/index.php e .htaccess no diretório www do seu aplicativo. Este é o roteador da interface da web.
5. Crie a configuração do seu aplicativo no arquivo config/config.php , consulte o modelo no vendor/uh67/umvc/config/config-template.php .
6. Crie um diretório runtime gravável pelo servidor da web para colocar arquivos temporários.
7. Crie o diretório www/assets gravável pelo servidor da web para colocar arquivos de ativos em cache de vários componentes.

Crie seu aplicativo usando o padrão MVC

1. Crie seus controladores nos controllers DIR, usando appcontrollers namespace e os derivam do uhi67umvcController .
2. Crie as visualizações no Dir views , no formato simples de PHTML, e organize -as de acordo com views/controller/action.php Estrutura.
3. Crie seus modelos no diretório models . Os modelos de banco de dados são uhi67umvcModel , os modelos sem banco de dados são uhi67umvcBaseModel .

Outros princípios básicos

1. As migrações são para versões e gravação de alterações no banco de dados no código -fonte. Coloque a migração entra no diretório migrations .
2. O layout é uma visão especial para incorporar todas as outras visualizações. Coloque os layouts no diretório views/layouts . As visualizações podem chamar outras visualizações parciais.
3. Você pode definir comandos da CLI no diretório commands , derivando da classe uhi67umvcCommand . Existem algum comando embutido na estrutura. O comando php app lista todos os comandos disponíveis, ambos internos e personalizados.
4. Um simples suporte de localização baseado em arquivos está incorporado. Coloque suas traduções em arquivos messges/la.php em que "LA" é o idioma para o qual deseja traduzir.

Configurações e propriedades de componentes

Todos os componentes, a maioria das classes UMVC, incluindo a própria classe de aplicativos, é um uhi67umvcComponent . Component implementa os recursos da propriedade : Magic Getter e Setter usa métodos GetProperty e SetProperty. Component é configurável : o construtor aceita uma matriz de configuração contendo valores para propriedades públicas.

Componentes internos

1. MySqlConnection - para conectar -se ao banco de dados. Inclui SQL Query Builder. Atualmente, a única implementação da Connection .
2. FileCache - a única implementação do CacheInterface .
3. SamlAuth - A única implementação para AuthManager .
4. L10n -Localização simples, padrão-incluído automaticamente, traduz apenas mensagens UMVC.
5. L10nFile -A localização baseada em arquivo para traduzir mensagens do seu aplicativo.

Outras classes básicas que você pode usar

1. Form -Um widget com exibição embutida para exibir e processar formulários HTML usando seus modelos.
2. Grid (widget, mas a visualização embutida ainda está ausente)-para exibir listas de modelos paginados e filtrados.
3. Query - representa uma consulta SQL parametrizada e flexível na estrutura do PHP. O comando SQL pode ser construído a partir dele.
4. Request - representa a solicitação HTTP, pode ser usada para buscar parâmetros GET e POST.
5. Session - representa a sessão atual do PHP, pode ser usada para obter e definir variáveis.

Scripts de entrada, URLs e roteamento

O script de entrada única para o aplicativo da Web é o www/index.php . Respectivamente, o script de entrada única para o aplicativo da CLI é o arquivo app . Ambos devem ser copiados para o diretório de aplicativos do vendor/uhi67/umvc/ diretório.

As regras www/.htaccess redirecionam todas as solicitações não achadas para o www/index.php . No entanto, os ativos estáticos são servidos diretamente no diretório www. Saiba mais sobre como servir os ativos da biblioteca mais tarde.

O index.php inicializa o automóvel, carrega a configuração principal, cria o objeto principal (classe definida na configuração, geralmente uhi67/umvc/App ou seu descendente). A configuração principal segue as regras do Component configurável.

Roteamento

Todo o URL formado como https: // myapp/acontroller/anaction é processado da seguinte maneira:

uhi67/umvc/App analisa a solicitação, calcula a classe de controlador real (derivada do uhi67/umvc/Controller ) para usar, cria o controlador e executa o método de ação solicitado. Como no exemplo acima, o AController refere -se à sua classe de controlador no diretório do seu controllers como Acontrollercontroller , e a anação refere -se ao método de ação (como Actionanaction ).

Se o nome da ação estiver ausente no URL, o actionDefault será executado. Se o nome do controlador também estiver ausente, o MaiorController configurado será usado. Também é possível criar um URL com um nome de ação do controlador padrão sem especificar o nome do controlador - a única restrição que você não pode ter um controlador com o mesmo nome que esta ação.

O comando Al Cli formado como php app acontroller/anaction é processado da seguinte maneira:

uhi67/umvc/App analisa a solicitação, calcula a classe de controlador real (derivada do uhi67/umvc/Command ) para usar, cria o controlador e executa o método de ação solicitado. Como no exemplo acima, o AController refere -se à sua classe de controlador no diretório commands como Acontrollercontroller , e o ANAction refere -se ao método de ação (como Actionanaction ). Os comandos embutidos podem ser executados da mesma maneira. Um comando com o mesmo nome em nosso aplicativo substitui o comando interno.

Usando URLs na ação do seu controlador

As partes da solicitação atual de URL podem ser acessadas como:

• Caminho: a parte do caminho passou para o controlador (o nome do controlador já mudou)
• Consulta: a parte da consulta da solicitação original, como uma matriz associativa

Para criar um novo URL usando nomes de controlador e ação e parâmetros optioanl Qurey, use um dos seguintes:

• $ this-> app-> createurl (['controlador/ação', 'key' => 'queryValue', ..., '#' => 'fragment'])-Todas as partes são opcionais
• retornar $ this-> app-> redirecion ([...])-para encerrar a ação com um redirecionamento

Servindo ativos da biblioteca

Nos seus arquivos de visualização, você pode consultar seus ativos estáticos localizados no diretório www de maneira estática, por exemplo <link href="/assets/css/app.css" rel="stylesheet"> . Pelo contrário, se você deseja se referir a um arquivo de ativo localizado em algum lugar da biblioteca de fornecedores criada com compositor, poderá usá-los da seguinte maneira:

• <script src="<?= $this->linkAssetFile('npm-asset/bootstrap/dist', 'js/bootstrap.bundle.min.js') ?>"></script>

A função linkAssetFile copia todos os arquivos do diretório no primeiro argumento no diretório de cache de ativos sob o www e cria um URL válido para o arquivo no segundo argumento. Nota: O primeiro argumento identifica um pacote de ativos. Somente a primeira chamada para qualquer pacote copia os arquivos. Todas as chamadas subsequentes para o mesmo pacote gera apenas o link para o arquivo.

O cache do ativo é esvaziado pelo comando composer install . O cache de ativos é sempre www/asset/cache e não é configurável.

Outros tópicos (em breve)

• Log
• Estrutura básica para atualizar um modelo usando o formulário
• Paginação em grade e filtragem
• Validação do modelo
• Ajudantes (aulas apenas com métodos estáticos)

...

Informações de desenvolvimento da estrutura

Instalação testes de unidade independentes e internos

Este repositório contém um aplicativo de teste interno para testes de unidade de codecepção interna. O único objetivo do aplicativo de teste no diretório tests é poder executar testes de unidade e não um aplicativo de amostra para começar.

Etapas de instalação independentes:

• git clone
• composer update
• Crie tests/_data/test-config.php com base no modelo
• Crie o banco de dados umvc-test de acordo com as configurações do banco de dados em tests/_data/test-config.php
• Execute php vendor/bin/codecept run unit para testes de unidade

Mais testes de unidade estão chegando ...

Teste no Docker

Um ambiente de teste dockerizado embutido pode ser usado para testar com diferentes versões de PHP e banco de dados.

Passos:

1. Configure a versão de banco de dados necessária em tests/docker-compose.yml (faça clones deste arquivo de modelo)
2. Configure a versão PHP em tests/docker/Dockerfile (as etapas de instalação da extensão podem mudar)
3. Configure as portas usadas e a base-base em tests/.env
4. Construa a pilha usando docker compose up --build -d (nos tests dir)
5. Seu contêiner PHP agora deve ser 'umvc-php-1'
6. Executar testes de unidade com docker exec -it umvc-php-1 php vendor/bin/codecept run unit

Alterar log

Versão 2.0.2-"2024-12-13"

• URLPATH, BASEURL FILES
• Armadilhas de depuração removidas

Versão 2.0.1-"2024-12-04"

• Install :: Creardir () agora também exclui arquivos .Gitkeep e .gitignore

Versão 2.0-"2024-10-11"

• Requer Php 8.2
• Corrija o uso de base

Versão 1.4-2024-07-25

• Consulta :: filterInReferredModels () adicionado
• Caches vazios: Skip .gitignore Arquivos
• Guia UMVC e consulte o aplicativo UMVC
• Fixes de compatibilidade PHP 8
• Outras correções

Versão 1.3.1-2023-03-27

• SQL Builder: Use tableName como alias padrão
• Migrar/Wait Command adicionado
• Conexão adiada de conexão
• renderização localizada

Versão 1.3-2022-12-03

• Questões de transação SQL de migração
• Compatibilidade do MySQL 8.0, mantendo 5.7 compatibilidade
• APP: Visualizar caminho fixo
• Verificação da configuração da CLI
• Aphelper :: waitfor ()
• Correção do teste de unidade
• Um aplicativo de teste Dockerizado simples com o Guia de teste está incluído
• Docker: aguardando a inicialização do contêiner de banco de dados (abordagem simples)
• Documentação de primeiros passos adicionada

Versão 1.2.1-2022-10-02

• Twig/Twig <2.15.3 Correção de vulnerabilidades (composer.lock)
• AuthManager :: ActionLogin () adicionado para corrigir o problema de retorno de login padrão

Versão 1.2-2022-09-20

• Bugfixes, correções phpdoc
• Linkbutton A assinatura mudou
• Connection :: Connect está de volta
• Métodos de informação de conexão (getTables (), etc)
• Métodos MySqlConnection Dropxxx
• Migrar/redefinir comando
• Testes de unidade, aplicativo de teste (rascunho)
• ShowException Mensagem anterior fixa
• Modelo de verificação de chave primária
• Samlauth: atualizar o registro do usuário apenas no login
• Criação de arquivos de versão removida

Versão 1.1-2022-08-30

• Melhorias no Registro de Ativos (Controller :: RegisterAssets (), etc)
• Html :: img () adicionado
• Sessão, solicitação, aulas de arquivo de arquivo
• Localização (App :: L (), App :: $ Locale, L10N, L10NFILE, ETC)
• APP: parâmetro de layout padrão
• Render Bugfixes
• Samlauth :: get () corrigido

Notas de atualização para a versão 1.1

• App :: Asset () As chamadas devem ser substituídas pelo app :: linkassetfile () chamadas (usando os mesmos argumentos)