codeandcode / start
Installs: 40
Dependents: 0
Suggesters: 0
Security: 0
Stars: 3
Watchers: 3
Forks: 1
Open Issues: 1
Language:CSS
Type:project
Requires
- php: >=5.5
- codeandcode/auth-start: 1.*
- codeandcode/micro-fwk: dev-master
- codeandcode/simplebase-start: 1.*
This package is not auto-updated.
Last update: 2024-04-17 18:51:20 UTC
README
Comece sua viagem no mundo da programação WEB, com PHP + MVC.
Introdução
Start é um micro framework de aplicação web. Acreditamos que o desenvolvimento deve ser uma experiência agradável e eficiente. O Start tenta facilitar a vida do desenvolvedor iniciante, disponibilizando os seguintes recursos:
Banco de dados ORM expressivo e intuitivo
Vários back-ends para armazenamento de sessão e cache
Motor de renderização simples e rápido
Sistemas de autenticação
Sistemas de rotas
Envio de email
Sistema de upload
Site: http://start.codeandcode.com.br/
Instalação
1 - Dependências do Projeto
php 5.5+
composer
mysql
Instalação
2 - Instalação do Projeto
Para instalar as dependências do projeto, execute os seguintes comando:
composer create codeandcode/start
ou
git clone https://github.com/code-and-code/start.git
cd start
composer install
importe o arquivo SQL start_DB.sql
3 - Inicializando do Projeto
Para iniciar a aplicação, siga as instruções:
php -S servidor:porta -t ./pasta_de_inicialização
Exemplo:
php -S 127.0.0.1:8080 -t ./public
Banco de dados: As configurações de comunicação com o Banco de Dados está localizada em : [App/config/app]
'database' => [
'host' => '127.0.0.1',
'dbname' => 'hotspot',
'username' => 'root',
'password' => ''
],
4 - Models
Para construir uma model, crie um classe que extende da classe Model, localizada em: Cac\Model\Model;
Deve referenciar a tabela que a model irá se comunicar.
Pode criar métodos de relacionamento utilizando os methodos:
hasMany(Class) -> um pra muitos
hasOne(Class) -> um pra um
belongsTo(Class) ou belongsTo(Class, 'coluna_externa', 'coluna_interna') -> um pra um invertido.
Métodos de query;
all() -> busca todos registros da tabela
find($id) -> busca determinado registro através do ID
where($name,$operator,$value) -> clausula de comparação
andWhere($name,$operator,$value) -> clausula de comparação com oprador AND
orWhere($name,$operator,$value) -> clausula de comparação com operador OR
create(array $attributes) -> cria registro com os atributos passados por parametro
update(array $attributes) -> atualiza o registro com os atributos passados por parametro
delete() -> deleta registro
fill(array $attributes) -> preenche os atributos do objeto
toArray() -> transforma um objeto em Array
getAttributes() -> captura quais atributos aquele objeto possui
get() -> Lista o resultado da consulta
first() -> trás o primeiro registro da tabela
Controle de Criação e Atualização
Para ter abilitar esse controle, só é preciso que a tabela tenha as seguintes colunas:
created_at -> do tipo dateTime, not null
updated_at -> do tipo dateTime, not null
Exemplo - Model:
<?php
namespace App\Models;
use Cac\Model\Model;
class User extends Model
{
protected $table = "users";
}
Exemplo - Relacionamento
Tabelas
users
id - integer
email - string
profile_id - integer
profile
id - integer
name - string
friends
id - integer
user_id - integer
friend_id - integer
**Models**
<?php
namespace App\Models;
use Cac\Model\Model;
class User extends Model {
protected $table = “users”;
public function Profile()
{
return $this->hasOne(Profile::class);
}
public function Friends()
{
return $this->hasMany(Friend::class);
}
}
class Profile extends Model {
protected $table = “profiles”;
public function User()
{
return $this->belongsTo(User::class);
}
}
class Friend extends Model {
protected $table = “friends”;
public function User()
{
return $this->belongsTo(User::class,‘id’,‘user_id’);
}
public function Friend()
{
return $this->belongsTo(User::class,‘id’,‘friend_id’);
}
}
5 - Sistema de Rotas
Uma Application Service Provider proverá o sistema de rotas.
Localizada no diretório [App\Providers\StartProvider.php]
Na classe StartProvider é possível mapear as rotas separadamente, sendo que o método boot() deve executar as rotas.
Exemplo:
class StartProvider extends ServiceProvider
{
protected $namespace = 'App\Controllers';
public function boot()
{
$this->mapRoutes();
$this->userRoutes();
}
public function mapRoutes()
{
//pode passar as rotas no metodo
Router::get(['route' => '/', 'namespace' => $this->namespace,'controller' => 'HomeController','action' => 'index']);
//pode passar parametros na rota
Router::get(['route' => '/$var', 'namespace' => $this->namespace,'controller' => 'HomeController','action'=>'index']);
}
/*
* exemplo por arqui externo
*/
public function userRoutes()
{
//pode criar um arquivo com as rotas separadamente e incluir esse arquivo no método
include __DIR__.'/../routes/user.php';
}
}
6 - Controller
Para construir uma controler, crie um classe que extende da classe Action, localizada em: Cac\Controller\Action;
<?php
namespace App\Controllers;
use App\Models\User;
use Cac\Controller\Action;
class UserController extends Action
{
public function index()
{
** Codigo **
}
}
7 - View
Para fazer uma chamada de view através da controle, use o metodo "$this->render('caminho_da_view', ['varieis ou objetos'])" usando o "echo" para imprimir na tela.
public function index()
{
echo $this->render('user.index', ['user' => $this->user->all()]);
}
Construção do arquivo de view
[nome_da_view.html.twig]
Helpers
auth() -> retorna usuário logado
guest() -> verifica se o usuário esta logado
view() -> retorna view
include() -> inclue uma view
extends -> extende uma view
block -> sessão reservada no HTML
display() -> dispara o alerta na tela
assets() -> busca arquivos no diretorio [public/assets]
Mais informações https://github.com/twigphp/Twig
Para usar lógica utilize as tags de interpretação
{% %}
Exemplos Condicionais:
{% if guest() == true %}
{{ include( view(‘auth._infologin’) ) }}
{% else %}
<li><a href=“/auth”>Entrar</a></li>
{% endif %}
Exemplo Repetição
{% for user in users %}
<tr>
<td>{{ user.id }} </td>
<td>{{ user.email }}</td>
</tr>
{% endfor %}
Para exibir uma variável na view utilize as tags de interpretação
{{ }}
Para Configurar a view, vá ao diretório [App\config\mail.php].
'layout' => [ 'folder' => '../App/views/',
'tag' => ['{','}'],
'extension' => '.html.twig',
'cache' => 'storage/compilation_cache'
],
8 - Envio de E-mail
Para realizar o envio de email, utilize a classe Mail localizada em: App\Support\Mail. new Mail('endereço_que_será_enviado', HTML(renderizado) ou menssagem, 'Título do Email', html(true, false));
<?php
namespace App\Controllers;
use Cac\Support\Mail;
use App\Models\User;
use Cac\Controller\Action;
class UserController extends Action
{
public function sendEmail()
{
new Mail(['email@dominio.com.br' => 'Nome'], "Menssagem", 'Assunto', false);
}
}
Como desparar email com mensagem em HTML.
Use o metodo render('caminho_da_view', [objeto]) para construir um HTML.
<?php
namespace App\Controllers;
use Cac\Support\Mail;
use App\Models\User;
use Cac\Controller\Action;
class UserController extends Action
{
public function sendEmail()
{
$html = $this->render('site.email.answer');
new Mail(['email@dominio.com.br' => 'Nome'], $html, 'Assunto', true);
}
}
Para Configurar o envio de email, vá ao diretório [App\config\mail.php] e informe as suas configurações de email.
<?php
return [
'default' => [ 'Host' => 'webmail.dominio.com.br',
'Port' => 587,
'SMTPSecure' => 'tls',
'SMTPAuth' => true,
'SMTPDebug'=> false,
'Username' => 'email_de_desparo@dominio.com.br',
'Password' => '******'
]
];
9 - Upload
Para fazer o Upload de arquivo, crie um objeto usando a classe File localizada em: Cac\Support\File , passando como parametro o arquivo e o diretório que será criado automaticamente na pasta [public] onde deverá ser gravado o arquivo. Dê um nome ao arquivo, com o objeto file em mãos use os seguintes metodos:
mimeType(array) -> para informar o tipo do arquivo
maxSize() -> para informar o tamanho máximo que o arquivo deve ter
upload() -> realizar upload
Exemplo:
<?php
namespace App\Controllers;
use App\Models\User;
use Cac\Controller\Action;
class UserController extends Action
{
public function upload()
{
$file = new File($_FILES['file'],images);
$nameFile = md5(date('H:m:s:'));
$file->setName($nameFile)->mimeType(['image/png','image/jpeg', 'image/jpg'])->maxSize('3MB')->upload();
}
}
Para Configurar os diretórios de upload, vá ao diretório [App\config\mail.php].
'file' => [
'folder' => 'images'
]
10 - Cache
Para usar o sistema de caches, pode-se usar o seguintes métodos:
<?php
namespace App\Controllers;
use App\Models\User;
use Cac\Controller\Action;
class UserController extends Action
{
public function getCache()
{
Cache::get(‘key’); -> caputa o cache com determinado indice
}
public function setCache()
{
Cache::set(‘key’,‘value’); -> cria um cache passando o Indice e seu valor
}
public function deleteCache()
{
Cache::delete(‘key’); -> deleta o cache com determinado indice
}
}
Para Configurar o sistema de cache, vá ao diretório [App\config\app.php].
'cache' => [
'active' => true,
'folder' => 'storage/cache',
]
11 - Helpers
O sistema inclui uma variedade de funções globais “helper” PHP. Muitas dessas funções são usadas pelo próprio framework.
config() -> retorina o arquivo de configuração no arquivo passado por parametro.
Ex: config('app.database.username')
auth() -> retorna o objeto do usuário logado.
Ex: if(auth())
{
echo auth()->email;
}else
{
echo 'NÃO LOGADO';
}
guest() -> verifica se está logado ou não
Ex: if(guest())
{
echo 'LOGADO';
}else
{
echo 'NÃO LOGADO';
}
arrayToObject() -> converte array para objeto
Ex: $array = ['email' => 'teste@teste.com'];
$obj = arrayToObject($array);
echo $obj->email;
objectToArray() -> converte objeto para array
Ex: $obj = new Class();
$obj->email = 'teste@teste.com';
$array = objectToArray($obj);
echo $array['email'];
assets() -> Carrega arquivos disponíveis no diretório [Public/assets]. Geralmente usado na view.
Ex: <link rel="stylesheet" href="{{ assets('home/css/main.css') }}"/>
A configuração para URL raiz '/' fica no diretório [App/config/app], quando for para produção deve trocar o valor da posição 'url' para novo dominio.
'url' => 'http://127.0.0.1:8080'
dd() -> Mostra informações sobre o objeto ou variável, substitui a função nativa do php "var_dump"
Ex: dd($obj);
12 - Application Service Provider
É possível criar providers para promover serviços e configurações. Para isso basta criar uma classe que extende de uma classe ServiceProvider, como mostra o exemplo a baixo. Porém é obrigatório a existencias dos métodos públicos:
boot()
mapRoutes()
Exemplo:
<?php
namespace App\Providers;
use Cac\Provider\ServiceProvider;
class StartProvider extends ServiceProvider
{
protected $namespace = 'App\Controllers';
public function boot()
{
$this->mapRoutes();
$this->userRoutes();
}
public function mapRoutes()
{
** Código **
}
}
13 - Fash Message
Para disparar notificações (alertas) para o usuário, usasse a função "back() ou alert()" passando por parametro a mensagem e o tipo dela. Essa função voltará a tela anterior informando a menssagem.
Tipos de mesnssagens : error, success, warning, info
Exemplo :
public function umMetodoNaController()
{
try{
**realiza uma operação**
return back('Operação realizada com sucesso!!! :) ', 'success');
}catch (\Exception $e){
return back($e->getMessage(), 'error');
}
}
Na View principal, coloque o codigo abaixo que ficará escutando as menssagens :
{% if hasMessages() == true %}
{{ display() }}
{% endif %}
14 - Validation
Para uma validação mais complexa dos atributos da classe que considera obrigatório, é necessário adcionar mais um atributo a sua model.
public $requested = [];
A variável $request recebe um array, com os atributos que devem ser obrigadorios da classe.
Exemplo :
<?php
namespace App\Models;
use Cac\Model\Model;
class User extends Model {
protected $table = "users";
public $requested = ['nome', 'email'];
}
OU fazer a chamada do metodo, passando o nome dos campos que quer verificar na determinada requisição.
Exemplo:
Validation::requiredBasic(['nome','email'], $_REQUEST);