Download the PHP package upflex/mixup without Composer
On this page you can find all versions of the php package upflex/mixup. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package mixup
MixUp
O MixUp foi criado para facilitar a escrita e organização de classes, e scripts relacionados a elas, em projetos baseados no Wordpress.
Utilizando as melhores práticas de OOP, um dos principais pilares do projeto é entregar uma estrutura de código testável e alinhado com os padrões de engenharia de software.
📑 Índice
- Pré-requisitos
- Instalação
- Configuração
- Exemplos
- Sugestão
- Contribuição
💻 Pré-requisitos
Antes de começar, verifique se você atendeu aos seguintes requisitos:
- [x] Instalou o
PHP v7.4+
- [x] Instalou o
WordPress
- [x] Configurou o
composer.json
conforme o guia nesse arquivo
📂 Instalação
Para instalar o MixUp, siga essas etapas:
1 - Acesse a pasta do seu plugin / tema do Wordpress e rode o comando:
2 - Acesse o painel do Wordpress e verifique se o plugin / tema está ativo.
⚙️ Configuração
Após ativação, a biblioteca estará pronta para uso nos seus temas e plugins.
Exemplo básico de um arquivo functions.php
ou meu-plugin.php
:
Lembre-se de adicionar no arquivo composer.json
, dos seus temas e plugins, os parâmetros para o autoload:
Observação: A classe Instance\Create utiliza os parâmetros do composer.json
para instância automática.
🗺️ Exemplos
Segue abaixo uma pequena lista de exemplos de uso:
Action / Filter: criação de um novo action / filter com auto-instância.
Higienização de campos: higienização dos parâmetros GET / POST.
PostType: criação de um novo tipo de post.
Shortcode: criação de um novo shortcode.
Taxonomia: criação de uma nova taxonomia.
Validação de campos: validação e higienização dos parâmetros GET / POST:
📫 Contribuição
Para contribuir com o projeto, siga estas etapas:
- Clone este repositório.
- Crie um branch:
git checkout -b <nome_branch>
. - Faça suas alterações e confirme-as:
git commit -m '<mensagem_commit>'
- Envie para o branch original:
git push origin <nome_branch>
- Crie a solicitação de pull request.
Como alternativa, consulte a documentação do GitHub em como criar uma solicitação pull.
🎓 Informações técnicas para contribuição
O plugin possui alguns componentes e estruturas essenciais para uso nas classes. Segue abaixo uma pequena lista:
Core: são classes e interfaces que fazem parte da estrutura principal do plugin.
- Base: classe responsável pela instância automática das classes filhas.
Instance: são classes responsáveis pela instância automática, predefinida na classe Base.
- Create: responsável pela criação da instância da classe.
- Finder: responsável pela localização das classes, definidas no arquivo principal do tema/plugin e indexando com o arquivo
composer.json
.Interfaces: são interfaces responsáveis pela predefinição das classes que as utilizam.
- IParent: responsável pela predefinição das classes que criam os tipos customizados de posts e taxonomias.
- Parent: são classes que organizam funções nativas do WordPress.
- PostType: responsável pela criação de tipos customizados de posts.
- Shortcode: responsável pela criação de shortcodes.
- Taxonomy: responsável pela criação das taxonomias.
Utils: são traits que podem ser adicionados as suas classes para melhor aproveitamento e legibilidade do seu código.
Fields: responsável pelo tratamento e uso de campos.
Sanitize: responsável pela sanitização dos parâmetros GET e POST, conforme no definição:
protected static function setFields(): array
Validate: responsável pela validação dos campos, conforme definição no método:
protected static function setFields(): array
- Email: responsável pela definição do template e envio de e-mail.
GroupingType: responsável pela definição do uso em taxonomias e tipos customizados de post. O método abaixo deve ser sempre adicionado nas classes:
public static function register(): void
Message: responsável pela definição do envio de mensagem, junto com o envio de e-mail. O método abaixo deve ser sempre adicionado nas classes:
protected static function send(): array
- Response: responsável pelo retorno de informações ao usuário ou outras classes.
- TemplateParts: responsável pela criação de template-parts nos plugins, seguindo a ideia do
get_template_parts()
nativo para temas.
😄 Seja um dos contribuidores
Quer fazer parte desse projeto? Siga o guia de contribuição acima.
⬆ Voltar ao topo