wiki:WF/criarestruturapastas

Version 10 (modified by viani, 10 years ago) (diff)

--

Criar Estrutura de Pastas

1 Descrição

A estrutura básica de pastas é utilizada para manter organização e coerência em nomenclatura e organização dos arquivos utilizados pela aplicação. A nomenclatura segue conceitos da arquitetura Model - View - Controler (MVC) tendo obrigatoriamente que contemplar locais para armazenamento dos arquivos relacionados as camadas. A pasta view somente será criada caso exista visualização HTML na aplicação.

A estrutura básica de pastas apresenta no mínimo o seguinte formato:

  • model
    • vo
    • dao
    • bo
  • view
    • templates
    • js
    • css
    • images
    • budgets
  • conf

As pastas tem que permitir acesso e execução ao grupo de usuários relacionados ao servidor HTTP e não deverá ser criada em uma área de acesso via protocolo HTTP. Os arquivos necessários para a visualização dos artefatos HTML como javascript, estilos e imagens são forncecidos por script PHP. O acesso ao conteúdo das pastas devem ser implementado de acordo com as funcionalidades da ferramenta ou linguagem de programação, ou seja o acesso a um arquivo não é fornecido diretamente pelo servidor web mas por uma aplicação capaz de ler o arquivo solicitado.

Os objetos de negócio são armazenados no subdiretório bo, da pasta model, e extendem de uma classe abstrata com definições padrão para camada model, podendo implementar métodos construtores e destrutores. Objetos de persistência de dados, devem ser armazendos na pasta dao e arquivos responsáveis por fornecer as propriedades utilizadas pelos arquivos dao devem ser armazendos na pasta vo.

A pasta view oferece uma estrutura hierárquica que representa as necessidades do desenvolvimento de aplicações que utilizem interfaces HTML e a nomenclatura utilizada é bastante intuitiva para os desenvolvedores de aplicações, exceto a pasta budgets que deve ser utilizada pelo desenvolvedor para armazenar artefatos que não cabem, por definição, nas outras pastas como arquivos de áudio, vídeo e arquivos pdf. A pasta templates guarda os arquivos usados pelo framework para geração do documento HTTP a ser enviado para o cliente.

Os arquivos de configuração do sistema, constantes e mensageria devem ser armazenados na pasta conf.

2 Atores

Desenvolvedores da aplicação

3 Pré-condições

Desenvolvedor deve possuir acesso administrativo à aplicação

4 Eventos

Desenvolvedor da aplicação utiliza ferramenta para a geração da estrutura de arquivos e permissões, baseado no arquivo de configuração gerado pelo caso de uso Definir Aplicação. {A1}{E1}

5 Eventos Alternativos

{A1}a. Desenvolvedor do sistema cria estrutura de pastas via comandos do sistema operacional

{A1}b. Desenvolvedor do sistema cria permissões de acesso as pastas

6 Tratamento de Erros

{E1} Caso não consiga criar pasta sistema envia mensagem M1, se o usuário opta por Cancelar encerra o fluxo, caso opte por Ignorar executa a próxima instrução, se optar por Tentar novamente o sistema deve executar a linha que provocou o erro.

7 Mensagem

{M1} Não foi possivel criar a pasta {Nome da Pasta} Ignorar | Tentar Novamente | Cancelar

8 Pós-condições

Estrutura básica de pastas para ser utilizada pela aplicação.

9 Regras de Negócio

Não relevante.

10 Telas Envolvidas

Não relevante.

11 Notas