PHPackages                             szagot/helper - 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. szagot/helper

ActiveLibrary

szagot/helper
=============

Classes estilo HELPER para Configuração de Sistemas e controle de Banco e Requisições

1.0.2(1y ago)132PHPPHP >=8.0

Since Jul 7Pushed 1y ago1 watchersCompare

[ Source](https://github.com/szagot/Helper)[ Packagist](https://packagist.org/packages/szagot/helper)[ RSS](/packages/szagot-helper/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (4)Used By (0)

Helper
======

[](#helper)

[![Helper: Conexão com o Banco e API](wiki/assets/helper.png)](wiki/assets/helper.png)

Conjunto de classes auxiliadoras para projetos pequenos que não utilizam grandes frameworks.

Este helper possui auxiliares para:

- Conexão e Consulta em Banco (Conn)
- Controle de recebimento de requisições (Server/Uri)
- Saída simplificada em JSON para API (Server/Output)
- Execução de requisições (HttpRequest)

Adicionando ao projeto
----------------------

[](#adicionando-ao-projeto)

```
composer require szagot/helper
```

Detalhamento de cada Helper
---------------------------

[](#detalhamento-de-cada-helper)

> **Obs**.: Há um projeto de backend de uma API de jogo que usa quase todos os Helpers dessa classe. Se quiser utilizar ele como exemplo, é o [szagot/ancient-backend](https://github.com/szagot/ancient-backend)

### Conexão ao Banco: `\Szagot\Helper\Conn`

[](#conexão-ao-banco-szagothelperconn)

Conectando ao banco

```
$conn = new Connection(
    'banco',
    'localhost',
    'root',
    'senha'
);
```

Preparando base para execuções na conexão

```
Query::setConn($conn);
```

Fazendo uma consulta diretamente

```
$search = Query::exec(
    'SELECT * FROM tabela WHERE name LIKE :name',
    [
        'name' => "%{$name}%",
    ],
    MinhaClassePersonalizada::class
)
```

Fazendo a mesma requisição acima Crud

```
try {
    $search = Crud::search(MinhaClassePersonalizada::class, 'name', "%{$name}%");
} catch (ConnException $e) {
    exit($e);
}
```

Fazendo uma pesquisa customizada

```
try {
    $search = Crud::searchCustom(
    MinhaClassePersonalizada::class,
    'name LIKE :name AND age >= :age',
    [
        'name' => '%fulano%',
        'age' => 18,
    ]
    );
} catch (ConnException $e) {
    exit($e);
}
```

Fazendo uma inserção direta

```
Query::exec(
    'INSERT INTO tabela (campo1, campo2) VALUES (:campo1, :campo2)',
    [
        'campo1' => $valor1,
        'campo2' => $valor2,
    ],
    MinhaClassePersonalizada::class
)

$id = Query::getLastLog()?->getLastId() ?? null;
```

Fazendo uma inserção com Crud

```
try {
    $id = Crud::insert(MinhaClassePersonalizada::class, $minhaInstancia);
} catch (ConnException $e) {
    exit($e);
}
```

#### Utilizando o Crud

[](#utilizando-o-crud)

Para utilizar o Crud de modo correto, é necessário:

- Criar uma conexão do tipo Connection
- Adicionar ela na Query
- Ter models que tenham sido estendidos de aModel
- Usar os attributes obrigatórios Table e PrimaryKey
- Se um campo do seu model for extra, isto é, não tiver um campo de mesmo nome na tabela, use o atributo opcional IgnoreField

> **Obs**.: No caso de tabelas personalizadas que não possuam primary Key, utilize Query diretamente, sem Crud.

Exemplo básico:

```
// Model
#[Table(name: 'nome_da_tabela_do_banco')]
class MinhaClassePersonalizada extends \Szagot\Helper\Conn\Model\aModel
{
    #[PrimaryKey]
    protected int     $id;
    protected ?string $campo1;
    protected ?string $campo2;

    #[IgnoreField]
    protected OutraClasse $campoQueNaoPertenceATabela;
}

// Preparando conexão
Query::setConn(
    new Connection(
        'banco',
        'localhost',
        'root',
        ''
    )
);

// Pegando um registro específico: ID = 1
try {
    /** @var MinhaClassePersonalizada $minhaInstancia */
    $minhaInstancia = Crud::get(MinhaClassePersonalizada::class, 1);
} catch (ConnException $e) {
    exit($e);
}
```

> **ATENÇÃO!** Se a chave primária não é do tipo de auto incremento, não esqueça de informar isso no atributo
> PrimaryKey seguinte forma:

```
// Model
#[Table(name: 'nome_da_tabela_do_banco')]
class MinhaClassePersonalizadaSemAutoIncremento extends \Szagot\Helper\Conn\Model\aModel
{
    #[PrimaryKey(autoIncrement: false)]
    protected string  $code;
    protected ?string $campo1;
    protected ?string $campo2;
}
```

---

### Controle de Recebimento Requisições: `\Szagot\Helper\Server`

[](#controle-de-recebimento-requisições-szagothelperserver)

Emitindo saída do tipo JSON (`Content-type: application/json`):

```
use Szagot\Helper\Server\Output;

// Saída com sucesso
Output:success($arrayDeSaida);

// Erro
Output::error('Deu ruim');
```

Você também pode especificar um cabeçalho da saída diferente do Padrão:

```
// Saída com sucesso
Output:success($arrayDeSaida, Output::POST_SUCCESS);

// Erro
Output::error('Deu ruim', Output::ERROR_NOT_FOUND);
```

> **Obs**.: `Output::success` ou `Output::error` emitem a saída e matam a aplicação. Nada mais é executado após isso.

Pegando as requisições:

```
use Szagot\Helper\Server\Uri;
use Szagot\Helper\Server\Models\Parameter;

$uri = Uri::newInstance();

// IP de quem fez a requisição
$requestIp = $uri->getRequestIp();
// Cabeçalhos da requisição recebida
$headers = getHeaders()
// Método (GET, POST, PUT, PATCH, DELETE, OPTION)
$method = $uri->getMethod();
// URL completa da requisição. Exemplo: "http://localhost:8080/pagina/opcao/detalhe"
$url = $uri->getUrl();
// String da Uri. Exemplo: "pagina/opcao/detalhe"
$uri = $uri->getTextUri();
// Primeira posição da Uri. Exemplo: "pagina"
$page = $uri->getUri(0);
// Arquivo de name "file" enviado
$file = $uri->getFile('file');
// Todos os arquivos enviados
$files = $uri->getFiles();

// Pegando parâmetros
$name = $uri->getParameter('name');
// Validando se o parâmetro "isGamer" foi informado na requisição
if($uri->parameterExists('isGamer')){
    $isGamer = $uri->getParameter('isGamer', Parameter::FILTER_BOOL);
}
```

**Alterando comportamento da URI**:

Caso sua API esteja hospedada em uma pasta diferente da raiz do servidor, você pode determinar o caminho fixo como `root` da aplicação.

Dessa forma ele será ignorado pelos métodos.

Exemplo: Vamos supor que seu serviços esteja dentro de "", você pode fazer:

```
use Szagot\Helper\Server\Uri;

$uri = Uri::newInstance('caminho/da/aplicacao');

$uriTxt = $uri->getTextUri();
$page = $uri->getUri(0);
$id = $uri->getUri(1);
```

No exemplo acima, se uma requisição for feita para "", os valores das variáveis serão:

```
$uriTxt: "pagina/20"
$page..: "produto"
$id....: "20"
```

> **Obs**.: Se o `root` for informado com `newInstance()` ou com `setRoot()`, você não precisa informar novamente em outro ponto da sua aplicação. Toda instância feita de Uri manterá o root, a menos que você informe novamente com outros valores.

**Sobre os parâmetros**:

`$uri->getParameter('parametro')` ou `$uri->getParameters()` se refere a qualquer parâmetro enviado, quer via body, quer via FormData ou mesmo Query String.

Em caso de duplicidade, os parâmetros informados no body terão prioridade.

Para pegar apenas o Body da requisição, use `$uri->getBody()`. Isso irá devolver um `stdClass` do body.

Ou use `$uri->getBody(false)` para devolver em formato string original.

---

### Execução de Requisições: `Szagot\Helper\HttpRequest`

[](#execução-de-requisições-szagothelperhttprequest)

Efetuando uma requisição

```
use Szagot\Helper\Request\HttpRequest;

// URI do API
$uri = 'https://api.site.com.br/v1/collection';

// Preparando header
$header = [
    'Content-Type: application/json',
    'User-Agent: Exemplo',
];

// Preparando body
$body = [
    'campo1' => 'valor de exemplo',
    'campo2' => 99.9,
];

// Enviando requisição do tipo POST com Auth Basic
$envioExemplo = new HttpRequest( $uri, 'POST', $header );
$envioExemplo
    ->setBodyContent($body)
    ->setBasicUser('usuario')
    ->setBasicPass('senha')
    ->execute();

// Pegando dados do retorno
$response = $envioExemplo->getResponse();
$responseBody = $response->getBody();
$responseHttpStatus = $response->getStatus();
```

Se deseja enviar um arquivo na requisição, basta dar um addFileToRequest() após o setBodyContent(), da seguinte forma:

```
// Arquivo
$file = $uri->getFile('file');
$body = [
    'campo1' => 'valor de exemplo',
    'campo2' => 99.9,
];

$envioExemplo
    ->setBodyContent($body)
    ->addFileToRequest($file)
    ->execute();

// Pegando dados do retorno
$response = $envioExemplo->getResponse();
$responseBody = $response->getBody();
$responseHttpStatus = $response->getStatus();
```

###  Health Score

26

—

LowBetter than 43% of packages

Maintenance33

Infrequent updates — may be unmaintained

Popularity10

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity47

Maturing project, gaining track record

 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.

###  Release Activity

Cadence

Every ~2 days

Total

3

Last Release

675d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/fe3ca4829f067edc0cc6b7611a3bee0535439f3cedf7166b75f8327f9a51f982?d=identicon)[szagot](/maintainers/szagot)

---

Top Contributors

[![szagot](https://avatars.githubusercontent.com/u/4570461?v=4)](https://github.com/szagot "szagot (33 commits)")

### Embed Badge

![Health badge](/badges/szagot-helper/health.svg)

```
[![Health](https://phpackages.com/badges/szagot-helper/health.svg)](https://phpackages.com/packages/szagot-helper)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)