Tutoriais - RibaFS Portal

Criação de Plugin para o CakePHP 3

2017-08-31T21:23:29-03:00

Criação de Plugin para o CakePHP 3

Irei relatar como criei o plugin twbs-cake-css:
https://github.com/ribafs/twbs-cake-css

Eu criei um plugin que controla a autenticação em aplicativos do Cake, que é o
https://github.com/ribafs/cake-control-br

E neste plugin, para melhorar o aspecto, adicionei o plugin twbs-cake-plugin:
https://github.com/elboletaire/twbs-cake-plugin

Acontece que o twbs-cake-plugin usa less ao invés de css puro e é meio lento. Então resolvi editar o mesmo e criar um que ficasse como eu queria, somente com CSS, mais simples e mais rápido. Resolvi usar o Bootstrap, apenas com CSS.

Baixei o Bootstrap:
http://getbootstrap.com/docs/4.0/getting-started/download/
Eu ainda usei a versão 3, que vinha com as fontes glyphicons.

Baixei o twbs-cake-plugin

Mudei o plugin acima para deixar como eu queria:

Comecei eliminando a pasta config com o arquivo bootstrap.php. Ele chama dois outros plugins que não usarei.

Todo o conteúdo da pasta /src eu usarei como está sem nenhuma modificação, pois ela contém o template para que o bake gere o conteúdo com o CSS, apenas mudarei o layout default.ctp.

Veja como ficou o layout default.ctp:

<?php
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since 0.10.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/

$cakeDescription = 'CakePHP: the rapid development php framework';
?>
<!DOCTYPE html>
<html>
<head>
<?= $this->Html->charset() ?>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
<?= $cakeDescription ?>:
<?= $this->fetch('title') ?>
</title>
<?= $this->Html->meta('icon') ?>

<?= $this->Html->css('base.css') ?>
<?= $this->Html->css('bootstrap.min.css') ?>
<?= $this->Html->script('bootstrap.min') ?>

<?= $this->fetch('meta') ?>
<?= $this->fetch('css') ?>
<?= $this->fetch('script') ?>
</head>
<body>
<style>
/* Remover as duas linhas abaixo, caso o texto do site fique com letras muito grandes */
html { font-size: 14px; }
body { font-size: 14px; }
</style>

<nav class="top-bar expanded" data-topbar role="navigation">
<ul class="title-area large-3 medium-4 columns">
<li class="name">
<h1><a href="http://backup/portal/"><?= $this->fetch('title') ?></a></h1>
</li>
</ul>
<div class="top-bar-section">
<ul class="right">
<li><a target="_blank" href="http://book.cakephp.org/3.0/">Documentation</a></li>
<li><a target="_blank" href="http://api.cakephp.org/3.0/">API</a></li>
</ul>
</div>
</nav>
<?= $this->Flash->render() ?>
<div class="container clearfix"> <!-- Assim <div class="clearfix"> ocupará toda a tela-->
<?= $this->fetch('content') ?>
</div>
<footer>
</footer>
</body>
</html>

Agora vejamos como ficou o conteúdo da pasta /webroot:

/css
bootstrap.min.css
/fonts
glyphicons-halflings-regular.ttf
/js
bootstrap.min.js

Um arquivo muito importante é o composer.json, que contém informações para a instalação pelo composer:

{
    "name": "ribafs/twbs-cake-css",
    "authors": [
        {
            "name": "Ribamar FS",
            "email": "ribafs@gmail.com",
            "homepage": "http://racotecnic.com",
            "role": "Developer"
        }
    ],
    "description": "Twitter Bootstrap Plugin for CakePHP 3",
    "type": "cakephp-plugin",
    "keywords": ["cakephp", "bootstrap", "plugin", "template"],
    "license": "MIT",
    "support": {
        "issues": "https://github.com/ribafs/twbs-cake-css/issues",
        "source": "https://github.com/ribafs/twbs-cake-css.git"
    },
    "homepage": "https://github.com/ribafs/twbs-cake-css",
    "require": {
        "cakephp/cakephp": "^3.3"
    },
        "autoload": {
            "psr-4": {
            "Bootstrap\\": "src"
        }
    }
}

Outro arquivo importante, que no GitHub funciona como o index.html em sites, é o README.md. Ele geralmente contém o help ensinando a instalar e outras informações.

README.md

Simple plugin to implement Bootstrap in CakePHP 3
===================================================

This plugin is a fork of the Twitter Bootstrap Plugin
https://github.com/elboletaire/twbs-cake-plugin

This plugin only use CSS, dont use Less.

It also contains bake templates that will help you starting *twitter-bootstraped*
CakePHP webapps.

General Features
----------------

- Bake templates.
- Generic Bootstrap layout.

Installation
------------

### Adding the plugin

You can easily install this plugin using composer as follows:

```bash
composer require ribafs/twbs-cake-css
```

### Enabling the plugin

After adding the plugin remember to load it in your `config/bootstrap.php` file:

```php
bin/cake plugin load Bootstrap
```

This will load the CSS for you.

### Add Template to src/Controller/AppController.php
```php
public function beforeRender(Event $event)
{
$this->viewBuilder()->theme('Bootstrap');
...
```

### Baking views

You can bake your views using the twitter bootstrap templates bundled with this
plugin. To do so, simply specify the `bootstrap` template when baking your files:

```bash
bin/cake bake all amigos --theme Bootstrap
```

License
-------

The MIT License (MIT)

Faltou apenas a licença, que mantive a mesma: MIT.

Caso tenha interesse pela publicação no Packgist veja o artigo:
http://ribafs.org/portal/cakephp-3/tutoriais/projeto-no-github

Criando um Projeto no GitHub

2017-06-25T16:23:38-03:00

Como Criar um Projeto hospedado no GitHub e no Packagist

Ainda tem um terceiro projeto envolvido, o Composer.
O Composer funciona de forma transparente entre ambos, usado pelo Packagist.

Criando um arquivo compojer.json

Projeto em PHP na dobradinha GitHub e Packagist

Ainda tem um terceiro projeto encolvido, o Composer.
O Composer funciona de forma transparente entre ambos

GitHub
- Criar conta
- Criar novo repositório
- Enviar código fonte para o repositório

1) Crie seu projeto em PHP
- Use um código existente
- Crie um novo
- Faça um fork de algum projeto do GitHub e customise

2) Criando a estrutura do seu projeto
2.1) cd /var/www/html
mkdir meu-projeto
cd meu-projeto
composer init

Responder as perguntas

Package name (<vendor>/<name>) [ribafs/meu-projeto]: (apenas tecle enter para aceitar)

Description []: Meu Primeiro projeto com o Packageist

Author [, n to skip]: Ribamar FS <ribafs@gmail.com>

Minimum Stability []: dev
Opções: dev, alpha, beta, RC ou stable

Package Type (e.g. library, project, metapackage, composer-plugin) []: project

License []: MIT

Define your dependencies.

Would you like to define your dependencies (require) interactively [yes]? no
(Nesta primeira etapa - no)

Would you like to define your dev dependencies (require-dev) interactively [yes]? no

{
"name": "ribafs/meu-projeto",
"description": "Meu Primeiro projeto com o Packageist",
"type": "project",
"license": "MIT",
"authors": [
{
"name": "Ribamar FS",
"email": "ribafs@gmail.com"
}
],
"minimum-stability": "dev",
"require": {}
}

Do you confirm generation [yes]?

Concluído

Referência sobre o composer - https://getcomposer.org/doc/04-schema.md

A estrutura do projeto deve ficar assim (sugestão/recomendação):

/meu-projeto
/src (código fonte do meu projeto)
/vendor (diretório criado pelo Composer para armazenar as dependências)
composer.json
README.md
index.php

3) Abrigar meu-projeto no GitHub
- Criar uma conta no GitHub - https://github.com/
- Criar um repositório para meu-projeto

Adicionar uma chave SSH

Em seu desktop Linux execute:

cd
ssh-keygen -t rsa -b 4096 -C "contato@ribafs.org"
Enter
Enter
Enter

Checando a senha
ls -al ~/.ssh

Capturando o hash da senha

cat ~/.ssh/id_rsa.pub

Copie a chave mostrada desde ssh-rsa ... até seu e-mail, incluso.

Vá ate'o GitHub, faça login e clique acima em sua foto e Settings
SSH and GPG keys
New SSH key

Entre com um Title (Residência)

E cole na caixa Key abaixo

E clique em Add SSH key

Ao criar um repositório no GitHub ele recebe o estágio de desenvolvimento, com um nome:
master-dev

Nesta fase informamos no composer.json assim:
"minimum-stability": "dev",

Quando considerarmos que já está usável e queremos oferecer para o mundo, então

distribuimos assim:
composer require ribafs/cake-control:dev-master

Ou
editando o composer.json do raiz do aplicativo para adicionar a linha abaixo na seção require:
"ribafs/cake-control": "master-dev"

No Packagist ele aparece como
dev-master

Quando considerar que o projeto está estável crie um Release e dê um número para o mesmo.
Agora pode oferecer duas versões: a estável e a em desenvolvimento, assim:

Dev
composer require ribafs/cake-control:dev-master

Estável
composer require ribafs/cake-control-twbs

Depois que configuramos o Packagist e sincrinizamos as atualizações somente precisamos interagir com
nosso código no GitHub, o Packagist e o Composer ficam transparentes.

4) Enviar meu-projeto para o repositório do GitHub
cd /var/www/html/meu-projeto

git config --global user.email "contato@ribafs.org"
git config --global user.name "Ribamar FS"
git init
git add .
git commit -m "Primeiro commit"
git remote add origin git@github.com:ribafs/cake-control.git
git push -f origin master

Para enviar novamente após alterações
remover a pasta .git
e repetir os passos acima

O projeto está agora hospedado no GitHub e pronto para ser abrigado pelo Packagist.

5) Criando o Pacote no Packagist

Acesse https://packagist.org/
Crie uma conta
Faça login
Clique em Submit a Package

Cole a linha a seguir, lembrando que o nome do pacote deve ser em minúsculas, palavras compostas separadas por hífen:

git@github.com:ribafs/cake-control.git

E clique em Check

Se retornar correto aceite e faça o submit

6) Atualizações

Cada vez que atualizar o projeto no GitHub precisa atualizar no Packageist
- Vá para sua conta no packagist
- Settings
- My Packages
- Clique no projeto
- Clique em Update (botão verde)

Para tornar automáticas as atualizações
- Vá para seu repositório no GitHub
- Clique em Settings
- Integration & services
- Services - Add service - packagist
- User - ribafs
- Token - o token da sua API (Acesse o site do packagist - login - Profile e copie o token gerado e cole aqui)
- Domain - packagist.org
- Marque Active
Clique em Update service abaixo
Clique acima e à direita em Test service
Caso receba a mensagem "Okay, the test payload is on its way." já poderá ir ao Packagist e abrir seu projeto que não
mais aparecerá a mensagem de que precisa atualizar.

Agora as atualizações foram automatizadas.

Você está pronto para compartilhar seu projeto com o mundo.

Para instalar um plugin (ex.: cake-control), crie um aplicativo em Cake com composer

cd aplicativo
composer require ribafs/cake-control

Mas, desta forma somente será possível após criar um release do projeto no GitHub.
Enquanto não conclue satisfatoriamente seu projeto, poderá divulgar para testes assim:

Editar o composer.json:

Adicionar na seção require-dev a linha

"require-dev": {
"psy/psysh": "@stable",
"cakephp/debug_kit": "~3.2",
"cakephp/bake": "~1.1",
"ribafs/cake-control": "master-dev"
},

Depois executar:

composer update

Ou então diretamente para linha de comando:

composer require ribafs/cake-control:dev-master

Como remover plugin:

Removível somente se bem inicialmente.

composer remove cakephp/localized

Remover manualmente a linha no bootstrap.php e todo o código adicionado ao vendor
além da linha respectiva no composer.json

Referências:

Composer - https://getcomposer.org/doc/03-cli.md
http://blog.jgrossi.com/2013/creating-your-first-composer-packagist-package/
Markdown tutorial - http://www.markdowntutorial.com/ (a linguagem usada pelo GitHub)

Dicas úteis
https://gist.github.com/

Aplicativo de Exemplo

2017-06-25T16:23:38-03:00

Pequeno Aplicativo usando CakePHP 3 que contém código fora do padrão de um CRUD.

Com comunicação entre Model, Controller e View.

Aplicativo didático que mostra código de regra de negócios em pequeno aplicativo.

financas

Componente cake-control-br

2017-06-25T16:11:30-03:00

Usando o Componente cake-control-br para controlar o acesso ao aplicativo

Criar app
composer create-project --prefer-dist cakephp/app control1

Instalar Plugin

cd control1
composer require ribafs/cake-control-br

Configurar banco de dados
Crie o banco e importe o script existente na pasta docs do plugin baixado. Depois edite config/app.php para configurar o banco.

Aproveite e configure também o controller default em config/routes.php para um de seu interesse.

Habilitar o plugin
bin/cake plugin load CakeControlBr --bootstrap

Download do plugin
https://github.com/ribafs/cake-control-br/archive/master.zip

Descompactar e abrir o diretório docs

bootstrap_cli.php para a control1/config (Com isso o Bake gerarará Users com login e logout)
AppController.php para control1/src/Controller

Gerar código com template

cd control1

bin/cake bake all groups -t CakeControlBr
bin/cake bake all users -t CakeControlBr
bin/cake bake all permissions -t CakeControlBr
bin/cake bake all customers -t CakeControlBr

Usuários e permissões

Existem 4 usuários, cada um com permissões diferentes:
super - com senha super também tem total permissão em tudo.
admin - com senha admin tem total permissão nas tabelas groups, users e permissions.
manager - com senha manager tem total permissão somente nas tabelas diferentes de
groups, users e permissions.
user - com senha user não tem nenhuma permissão no aplicativo, apenas de efetuar login.

Em AppController.php você pode definir o controller default para usuários não administradores. Caso não use a tabela customers troque logo no início do AppController por uma de suas tabelas na linha:

protected $noAdmins = 'Customers';

Mais detalhes em

https://ribafs.github.io/cakephp/cake-control.pdf