PHPackages diogoadc/sunday-framework - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Framework](/categories/framework) 4. / 5. diogoadc/sunday-framework ArchivedProject[Framework](/categories/framework) diogoadc/sunday-framework ========================= Uma framework criada para pessoas que querem aprender sobre o universo do backend, porém, possui somente os dias de domingo para praticar. 17[3 issues](https://github.com/Diogo2550/Sunday-Framework/issues)PHP Since May 2Pushed 5y ago1 watchersCompare [ Source](https://github.com/Diogo2550/Sunday-Framework)[ Packagist](https://packagist.org/packages/diogoadc/sunday-framework)[ RSS](/packages/diogoadc-sunday-framework/feed)WikiDiscussions master Synced 6d ago READMEChangelog (2)DependenciesVersions (1)Used By (0) Sunday Framework ================ [](#sunday-framework) O Sunday Framework (SF) é um projeto criado por Diogo Alves, estudante do Instituto Federal do Rio de Janeiro (IFRJ) - *Campus* Arraial do Cabo, com um intuito simples e prático: Criar uma API de forma simples em seu tempo livre, ou melhor dizendo, aos seus dias de domingo. O objetivo do projeto é possibilitar a criação de uma API PHP sem necessitar de um amplo conhecimento sobre programação ou sobre desenvolvimento backend, tornando-se assim, perfeita para desenvolvedores frontend que precisam testar seus aplicativos e/ou estudantes que sentem curiosidade e gostaria de ver um aplicativo backend funcionando. ### Objetivo [](#objetivo) O Sunday Framework tentará abstrair ao máximo todo o processo "complicado" por trás de uma aplicação backend para, tanto facilitar quanto, principalmente, agilizar o processo de criação de um app. Dentre as funcionalidades previstas para serem criadas estão: - Criação automática de banco de dados e tabelas (MySQL). - Roteamento automático através de controllers. - Inserção automática de dados no banco através de modelos. ### Futuras features [](#futuras-features) - Uma CLI (Command Line Interface - Interface de linha de comando) que possibilite a criação agilizada de models e controllers, assim como, atualização/criação da base de dados. - Modo de debug, possibilitando a criação de arquivos de logs para depuração aprofundada de seus códigos. - Uma interface que facilite o envio de emails. - Uma interface (ou pacote) que possibilite o uso de jason web tokens, para autenticações. --- ### Links [](#links) - [Requerimentos](#Requerimentos) - [Instalação](#Instala%C3%A7%C3%A3o) - Como usar --- ### Requerimentos [](#requerimentos) - [Xampp](https://www.apachefriends.org/pt_br/index.html "Xampp") - PHP 7.4.0 ou maior - MySQL - De preferência ter o [composer](https://getcomposer.org/download/ "composer") instalado - Vontade de criar uma API Para utilizar o Sunday Framework é necessário o uso de um servidor local, a linguagem php instalada em sua versão 7.4 ou superior e, até o presente momento, o banco de dados MySQL. Por isso, recomenda-se que se instale o xampp da apache pois o mesmo já vem com todos esses recursos em apenas um pacote. ### Instalação [](#instalação) Caso você possua o composer instalado em sua máquina, basta entrar no diretório de projetos do seu servidor local - no caso do apache é a pasta *htdocs* dentro da pasta raiz do xampp - e rodar em algum console o comando: `composer create-project diogoadc/sunday-framework:dev-master` e tudo estará funcionando automaticamente. Todavia, caso você não tenha instalado o composer, é possível instalar o Sunday Framework simplesmente fazendo um clone deste repositório e descompactando a pasta no diretório de projetos do seu servidor local. ### Novidades da versão 0.3 [](#novidades-da-versão-03) Dentre as mudanças presentes na versão 0.3, podemos citar: - Implementação do autoload com a padronização psr-4, isso permite que seus códigos se tornem livres das dezenas de 'require'/'include' fazendo o uso de namespaces. - Implementação melhorada do tipo DateTime no banco de dados. - Uma série de correções de bugs e outros problemas relatados. ### Como usar [](#como-usar) #### Introdução [](#introdução) Até o momento, o SF possui, de padrão, uma hierarquia de pastas que não deve em hipótese alguma ser alterada. Cada pasta, com sua respectiva função será listada a seguir: [![Sunday Framework Estrutura de Pastas](https://camo.githubusercontent.com/c6ea52db625611fff481479e3700176e0ad66ffd9482e5df6ef2fe35eeb04ab6/68747470733a2f2f692e696d6775722e636f6d2f6830594c4e51612e706e67 "Sunday Framework Estrutura de Pastas")](https://camo.githubusercontent.com/c6ea52db625611fff481479e3700176e0ad66ffd9482e5df6ef2fe35eeb04ab6/68747470733a2f2f692e696d6775722e636f6d2f6830594c4e51612e706e67) #### Estrutura de Pastas: [](#estrutura-de-pastas) \*\*\_Core: \*\*Possui o coração do Framework. **Controllers:** Pasta responsável por armazenar todos os controladores das rotas. **Models:** Pasta responsável por armazenas todos os modelos de dados. \*\*Public: \*\*Pasta que até o presente momento não possui uma utilidade. **vender:** Pasta pertencente ao composer. #### Arquivos: [](#arquivos) **.gitignore:** Arquivo pertencente ao Github \*\*.htaccess: \*\*Arquivo responsável pelo roteamento. Não o altere! **composer.json:** Arquivo pertencente ao composer **index.php:** O arquivo inicial de sua aplicação. Será abordado futuramente. **LICENSE:** Arquivo de licença. \*\*README.md: \*\*Arquivo do github. **RestAPI.php:** Arquivo responsável pela sua API. Não o altere em hipótese alguma! **settings.json:** Arquivo de configuração. Atualmente serve somente para configurar o banco de dados. Os únicos arquivos/pastas que devem ser alterados são os arquivos\*\* index.php\*\* e **settings.json** e as pastas **Models** e **Controllers**. A seguir, cada um dos itens citados será explicado. #### index.php [](#indexphp) Atualmente o index.php tem uma função bem específica. A única linha que deve ser alterada é a linha que contém: `$con->createConnetion()->autoCreateDatabase()->autoCreateTables();` O método 'autoCreateDatabase()' irá criar automaticamente a database informada dentro do settings.json. O método 'autoCreateTables()' irá criar automaticamente as tabelas no banco de dados de acordo com os models existentes na pasta Models. Caso não deseja que isso aconteça automaticamente, basta apagar a chamada destas 2 funções, ou seja, a linha deverá ficar: `$con->createConnection();` #### settings.json [](#settingsjson) O settings.json é o arquivo responsável pela conexão com o banco de dados. Nele você terá de fornecer o host, username, password e o nome do banco de dados presentes em seu MySQL (ou PHPMyAdmin). #### Models [](#models) A pasta models é responsável por guardar todos os models de sua aplicação mas... o que é um model? Um model é basicamente um retrato de uma tabela, ou seja, um model é uma classe que contém todos os atributos que a tabela terá no banco de dados. A estrutura básica de um model é: ``` // A classe terá de ter a nomenclatura Nome + Model, ondem o nome pode ser entendido como o nome da tabela. // Todo model deverá herdar da classe BaseModel class ExampleModel extends BaseModel { // Um protected $primaryKey é necessário para dizer qual é a chave primária da tabela. O seu valor deverá ser a propriedade que será a chave primária entre aspas. protected $primaryKey = 'id'; // Demas propriedades publicas de acordo com sua necessidade public int $id; public DateTime $dt_nasc; public function __construct() { } } ``` **Atenção:** Utilize sempre propriedades pública em seus Models. Propriedades private não serão atribuídas ao banco de dados! **Atenção 2:** Crie somente 1 model por arquivo. O arquivo deverá ter o mesmo nome que o model! **OBS:** O SF vem com um model e um controller padrão para que se tenha um compreendimento maior do funcionamento! #### Características de um model [](#características-de-um-model) Um model possui a propriedade "protected $primaryKey" que deverá receber como valor o nome do atributo que será a chave primaria da tabela. Ex: ``` protected $primaryKey = 'cpf'; ``` essa linha informará à API que o cpf será a chave primária. Todo model possui um método chamado "patchValues(array)" que recebe um array associativo qualquer e preenche o model com os valores que tiver no array. Caso queira, também poderá preenche-lo manualmete. #### Controllers [](#controllers) A pasta controller é a responsável por tudo o que acontecerá em sua API. Ela criará suas rotas automaticamente e responderá requisições de acordo com o que for programada para fazer. Uma rota normal em sua API será descrita como: ``` // Todos os parâmetros são opcionais! URL_Base/controller/metodo/parametro1/parametro2/parametro3/... ``` Assim que for criado um novo arquivo de controller, automaticamente aquele rota será acessível através da url e, cada função pública é um possível end-point (url) de rota. **OBS:** Todos os controllers possuem 4 rotas "padrões", um get, post, put e delete; ou seja, caso seja criada uma função "get()" no controller "contatos", somente de enviar uma solitação do tipo get para "url\_base/contato" irá acessar o método get(). Assim como os models, os controllers também possuem uma estrutura padrão que deve ser seguida que será explicada a seguir: ``` // Todo controller deverá ter a nomeclatura "nome + Controller" (Em Pascal Case) // Todo controller deverá herdar da classe BaseController. class ExampleController extends BaseController { // Função opcional public function get($id = null) { } // Função opcional public function post() { } // Função opcional public function delete($id) { } // Função opcional public function put() { } } ``` O fluxo de um controller é bem simples de se compreender. > Para cada função pública criada, você terá um novo end-point Ou seja, caso você crie uma: `public function pegarTodosOsElementos()`você poderá acessar essa rota a qualquer momento. #### Características de um controller [](#características-de-um-controller) O SF funciona em torno dos controllers e dos models. Dentro do controller é possível acessar o método ``` $this->query->insert(model) $this->query->update(model); $this->query->select(model); $this->query->delete(model); $this->query->where(model, atributo); ... ``` O query é o cara responsável por contruir as queries sem que seja necessário escreve-las. Após você "montar" sua query como um quebra cabeça, você poderá utilizar a classe 'repository' para acessar o banco de dados. Os métodos que você irá são: ``` $this->repository->select($this->query); $this->repository->selectAll($this->query); $this->repository->insert($this->query); $this->repository->update($this->query); $this->repository->delete($this->query); ``` Dado ao que foi dito até o momento, um fluxo básico de uma função no controller seria. - Montar a query com um model. - Realizar a query no banco de dados. Ex: ``` // Cria um model $model = new UserModel; // Preenche um model com seus dados $model->patchValues($this->data); // Monta uma query de select que pegará os valoes onde o id é igual ao id do model dado $this->query->select($model)->where($model, 'id'); // Executa a query e retorna o valor pra fora da API return $this->respository->select($this->query); ``` **Obs:** É possível escrever tanto ``` $this->query->select($model); $this->query->where($model, 'id'); ``` quanto ``` $this->query->select($model)->where($model, 'id'); ``` Os dois modos são equivalentes. --- Todo controller possui um atributo com os dados enviados no corpo de uma requisição HTTP em formato json. Para acessa-la basta fazer: ``` $this->data; ``` Informações importantes ======================= [](#informações-importantes) - O Sunday Framework foi criado para trabalhar somente com requisições que usam json. - Caso queira testar sua API sem ter criado um aplicativo para acessa-la, recomendo que utilize algum aplicativo com esse objetivo como o Postman. - O Framework ainda está em fase de desenvolvimento. Sua versão atual é a 0.2.0. - Bugs podem ser encontrados, caso encontre, por favor reporte aqui no Github para que sejam consertados. - A documentação não está completa. Infelizmente, ainda muitas coisas irão mudar e devido a isso, não vale a pena escrever a forma com que se faz tudo com ela. - Muito obrigado pela compreensão, caso tenha alguma dúvida pode entrar em contato comigo por email ou aqui pelo github. Email: ### Health Score 12 — LowBetter than 0% of packages Maintenance0 Infrequent updates — may be unmaintained Popularity6 Limited adoption so far Community7 Small or concentrated contributor base Maturity30 Early-stage or recently created project Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://avatars.githubusercontent.com/u/47594980?v=4)[Diogo Alves](/maintainers/Diogo2550)[@Diogo2550](https://github.com/Diogo2550) --- Top Contributors [![Diogo2550](https://avatars.githubusercontent.com/u/47594980?v=4)](https://github.com/Diogo2550 "Diogo2550 (12 commits)") ### Embed Badge ![Health badge](/badges/diogoadc-sunday-framework/health.svg) ``` [![Health](https://phpackages.com/badges/diogoadc-sunday-framework/health.svg)](https://phpackages.com/packages/diogoadc-sunday-framework) ``` ### Alternatives [laravel/telescope An elegant debug assistant for the Laravel framework. 5.2k67.8M192](/packages/laravel-telescope)[spiral/roadrunner RoadRunner: High-performance PHP application server and process manager written in Go and powered with plugins 8.4k12.2M84](/packages/spiral-roadrunner)[nolimits4web/swiper Most modern mobile touch slider and framework with hardware accelerated transitions 41.8k177.2k1](/packages/nolimits4web-swiper)[laravel/dusk Laravel Dusk provides simple end-to-end testing and browser automation. 1.9k36.7M259](/packages/laravel-dusk)[laravel/prompts Add beautiful and user-friendly forms to your command-line applications. 708181.8M596](/packages/laravel-prompts)[cakephp/chronos A simple API extension for DateTime. 1.4k47.7M121](/packages/cakephp-chronos) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)