Referência de classes e funções

attempt() public

Assinatura completa: public static function attempt(string $email, string $password, bool $remember = false): bool;

Descrição: Tenta autenticar por e-mail e senha e, se válido, inicia a sessão.

$result = \Framework\Auth\Auth::attempt($email, $password);

Retorno: bool — true quando a operação descrita (tenta autenticar por e-mail e senha e, se válido, inicia a sessão) é concluída; false quando não é confirmada. O bool não carrega mensagem de erro nem contagem de linhas.

Guia contextual de Auth

loginUser() public

Assinatura completa: public static function loginUser(object $user, bool $remember = false): void;

Descrição: Registra diretamente o usuário autenticado na sessão.

\Framework\Auth\Auth::loginUser($user);

Retorno: `void` — não devolve valor.

Guia contextual de Auth

setRememberToken() protected

Assinatura completa: protected static function setRememberToken(object $user): void;

Descrição: Define ou configura remember token.

Retorno: `void` — não devolve valor.

Guia contextual de Auth

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

recoverFromCookie() public

Assinatura completa: public static function recoverFromCookie(): bool;

Descrição: Tenta recuperar a autenticação a partir do cookie remember-me.

$result = \Framework\Auth\Auth::recoverFromCookie();

Retorno: bool — true quando a operação descrita (tenta recuperar a autenticação a partir do cookie remember-me) é concluída; false quando não é confirmada. O bool não carrega mensagem de erro nem contagem de linhas.

Guia contextual de Auth

logout() public

Assinatura completa: public static function logout(): void;

Descrição: Encerra a autenticação e invalida o estado remember-me.

\Framework\Auth\Auth::logout();

Retorno: `void` — não devolve valor.

Guia contextual de Auth

clearRememberCookie() protected

Assinatura completa: protected static function clearRememberCookie(): void;

Descrição: Remove, limpa ou consome remember cookie.

Retorno: `void` — não devolve valor.

Guia contextual de Auth

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

check() public

Assinatura completa: public static function check(): bool;

Descrição: Verifica se há um usuário autenticado e ativo.

$result = \Framework\Auth\Auth::check();

Retorno: bool — true quando há um usuário autenticado e ativo; false quando a condição não se confirma.

Guia contextual de Auth

guest() public

Assinatura completa: public static function guest(): bool;

Descrição: Verifica se não há usuário autenticado.

$result = \Framework\Auth\Auth::guest();

Retorno: bool — true quando não há usuário autenticado; false quando a condição não se confirma.

Guia contextual de Auth

user() public

Assinatura completa: public static function user(): ?object;

Descrição: Retorna o usuário autenticado ou null.

$result = \Framework\Auth\Auth::user();

Retorno: `?object` — valor opcional; pode ser `null`.

Guia contextual de Auth

id() public

Assinatura completa: public static function id(): ?int;

Descrição: Retorna o ID do usuário autenticado ou null.

$result = \Framework\Auth\Auth::id();

Retorno: `?int` — valor opcional; pode ser `null`.

Guia contextual de Auth

role() public

Assinatura completa: public static function role(): string;

Descrição: Retorna o papel do usuário autenticado.

$result = \Framework\Auth\Auth::role();

Retorno: string — papel do usuário na sessão autenticada; quando não há usuário, retorna a string 'guest'.

Guia contextual de Auth

is() public

Assinatura completa: public static function is(string $role): bool;

Descrição: Compara o papel atual com o papel informado.

$result = \Framework\Auth\Auth::is($role);

Retorno: bool — indica o resultado da operação descrita (compara o papel atual com o papel informado); true confirma o resultado e false indica que não foi confirmado, sem mensagem de erro.

Guia contextual de Auth

isAny() public

Assinatura completa: public static function isAny(string ...$roles): bool;

Descrição: Verifica se o papel atual pertence à lista informada.

$result = \Framework\Auth\Auth::isAny(...$roles);

Retorno: bool — true quando o papel atual pertence à lista informada; false quando a condição não se confirma.

Guia contextual de Auth

require() public

Assinatura completa: public static function require(string $redirectTo = 'auth/login'): void;

Descrição: Exige autenticação; caso contrário, redireciona para a rota indicada.

\Framework\Auth\Auth::require();

Retorno: `void` — não devolve valor.

Guia contextual de Auth

requireRole() public

Assinatura completa: public static function requireRole(string $role, string $redirectTo = 'dashboard'): void;

Descrição: Exige autenticação e o papel indicado; em caso contrário, redireciona.

\Framework\Auth\Auth::requireRole($role);

Retorno: `void` — não devolve valor.

Guia contextual de Auth

setUserModel() public

Assinatura completa: public static function setUserModel(string $modelClass): void;

Descrição: Define a classe de Model usada pela autenticação.

\Framework\Auth\Auth::setUserModel($modelClass);

Retorno: `void` — não devolve valor.

Guia contextual de Auth

buildSessionUser() protected

Assinatura completa: protected static function buildSessionUser(object $user): object;

Descrição: Cria ou gera session user.

Retorno: `object` — valor do tipo declarado na assinatura.

Guia contextual de Auth

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

__construct() public

Assinatura completa: public function __construct();

Descrição: Inicializa uma instância de Application.

$instance = new \Framework\Core\Application();

Retorno: Não declarado explicitamente na assinatura.

Guia contextual de Application

run() public

Assinatura completa: public function run(): void;

Descrição: Executa o ciclo principal da aplicação HTTP.

// $instance é uma instância inicializada de \Framework\Core\Application; argumentos seguem a assinatura acima.
$instance->run();

Retorno: `void` — não devolve valor.

Guia contextual de Application

isDebug() protected

Assinatura completa: protected function isDebug(): bool;

Descrição: Informa se o modo de depuração efetivo está ativo.

Retorno: bool — indica o resultado da operação descrita (informa se o modo de depuração efetivo está ativo); true confirma o resultado e false indica que não foi confirmado, sem mensagem de erro.

Guia contextual de Application

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

configureErrorHandling() protected

Assinatura completa: protected function configureErrorHandling(): void;

Descrição: Configura handlers globais de erro e exceção.

Retorno: `void` — não devolve valor.

Guia contextual de Application

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

setSecurityHeaders() protected

Assinatura completa: protected function setSecurityHeaders(): void;

Descrição: Envia os headers de segurança da resposta.

Retorno: `void` — não devolve valor.

Guia contextual de Application

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

handleException() protected

Assinatura completa: protected function handleException(\Throwable $e): void;

Descrição: Traduz exceção não tratada em resposta HTTP.

Retorno: `void` — não devolve valor.

Guia contextual de Application

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

resolveHttpCode() protected

Assinatura completa: protected function resolveHttpCode(\Throwable $e): int;

Descrição: Resolve o status HTTP correspondente à exceção.

Retorno: int — valor inteiro de resolve o status HTTP correspondente à exceção.

Guia contextual de Application

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

renderProductionError() protected

Assinatura completa: protected function renderProductionError(int $httpCode): void;

Descrição: Renderiza resposta de erro sem detalhes internos.

Retorno: `void` — não devolve valor.

Guia contextual de Application

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

renderDebugPage() protected

Assinatura completa: protected function renderDebugPage(\Throwable $e, array $ctx, int $httpCode): void;

Descrição: Renderiza página de diagnóstico para desenvolvimento.

Retorno: `void` — não devolve valor.

Guia contextual de Application

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

handlePhpError() public

Assinatura completa: public function handlePhpError(int $errno, string $msg, string $file, int $line): bool;

Descrição: Recebe erro PHP pelo handler registrado.

// $instance é uma instância inicializada de \Framework\Core\Application; argumentos seguem a assinatura acima.
$result = $instance->handlePhpError($errno, $msg, $file, $line);

Retorno: bool — indica o resultado da operação descrita (recebe erro PHP pelo handler registrado); true confirma o resultado e false indica que não foi confirmado, sem mensagem de erro.

Guia contextual de Application

handleShutdown() public

Assinatura completa: public function handleShutdown(): void;

Descrição: Processa erro fatal durante o shutdown.

// $instance é uma instância inicializada de \Framework\Core\Application; argumentos seguem a assinatura acima.
$instance->handleShutdown();

Retorno: `void` — não devolve valor.

Guia contextual de Application

extractSourceLines() protected

Assinatura completa: protected function extractSourceLines(string $file, int $line, int $padding = 8): array;

Descrição: Extrai linhas de contexto do arquivo associado ao erro.

Retorno: array — lista/estrutura retornada pelo método para extrai linhas de contexto do arquivo associado ao erro. As chaves e o formato são os definidos pela implementação indicada na descrição.

Guia contextual de Application

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

buildEnrichedTrace() protected

Assinatura completa: protected function buildEnrichedTrace(\Throwable $e): array;

Descrição: Cria ou gera enriched trace.

Retorno: array — lista/estrutura retornada pelo método para cria ou gera enriched trace. As chaves e o formato são os definidos pela implementação indicada na descrição.

Guia contextual de Application

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

logRequest() public

Assinatura completa: public function logRequest(): void;

Descrição: Registra detalhes da requisição no log.

// $instance é uma instância inicializada de \Framework\Core\Application; argumentos seguem a assinatura acima.
$instance->logRequest();

Retorno: `void` — não devolve valor.

Guia contextual de Application

transaction() protected

Assinatura completa: protected function transaction(callable $fn): mixed;

Descrição: Executa callback dentro de transação do Database.

Retorno: mixed — valor produzido/lido por executa callback dentro de transação do Database. Como o tipo declarado é mixed, verifique o valor concreto antes de tratar como escalar, array ou objeto.

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

fail() protected

Assinatura completa: protected function fail(string $message, array $errors = []): never;

Descrição: Interrompe o fluxo com a exceção de domínio da base.

Retorno: `never` — não retorna ao chamador (encerra ou lança exceção).

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

__construct() public

Assinatura completa: public function __construct(string $table, bool $isAlter = false);

Descrição: Inicializa uma instância de Blueprint.

$instance = new \Framework\Database\Blueprint($table);

Retorno: Não declarado explicitamente na assinatura.

Guia contextual de Blueprint

tinyInteger() public

Assinatura completa: public function tinyInteger(string $name): Column;

Descrição: Adiciona coluna TINYINT ao Blueprint.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->tinyInteger($name);

Retorno: `Column` — valor do tipo declarado na assinatura.

Guia contextual de Blueprint

unsignedTinyInteger() public

Assinatura completa: public function unsignedTinyInteger(string $name): Column;

Descrição: Adiciona coluna TINYINT UNSIGNED.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->unsignedTinyInteger($name);

Retorno: `Column` — valor do tipo declarado na assinatura.

Guia contextual de Blueprint

smallInteger() public

Assinatura completa: public function smallInteger(string $name): Column;

Descrição: Adiciona coluna SMALLINT.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->smallInteger($name);

Retorno: `Column` — valor do tipo declarado na assinatura.

Guia contextual de Blueprint

unsignedSmallInteger() public

Assinatura completa: public function unsignedSmallInteger(string $name): Column;

Descrição: Adiciona coluna SMALLINT UNSIGNED.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->unsignedSmallInteger($name);

Retorno: `Column` — valor do tipo declarado na assinatura.

Guia contextual de Blueprint

mediumInteger() public

Assinatura completa: public function mediumInteger(string $name): Column;

Descrição: Adiciona coluna MEDIUMINT.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->mediumInteger($name);

Retorno: `Column` — valor do tipo declarado na assinatura.

Guia contextual de Blueprint

unsignedMediumInteger() public

Assinatura completa: public function unsignedMediumInteger(string $name): Column;

Descrição: Adiciona coluna MEDIUMINT UNSIGNED.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->unsignedMediumInteger($name);

Retorno: `Column` — valor do tipo declarado na assinatura.

Guia contextual de Blueprint

integer() public

Assinatura completa: public function integer(string $name): Column;

Descrição: Adiciona coluna INT.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->integer($name);

Retorno: `Column` — valor do tipo declarado na assinatura.

Guia contextual de Blueprint

unsignedInteger() public

Assinatura completa: public function unsignedInteger(string $name): Column;

Descrição: Adiciona coluna INT UNSIGNED.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->unsignedInteger($name);

Retorno: `Column` — valor do tipo declarado na assinatura.

Guia contextual de Blueprint

bigInteger() public

Assinatura completa: public function bigInteger(string $name): Column;

Descrição: Adiciona coluna BIGINT.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->bigInteger($name);

Retorno: `Column` — valor do tipo declarado na assinatura.

Guia contextual de Blueprint

unsignedBigInteger() public

Assinatura completa: public function unsignedBigInteger(string $name): Column;

Descrição: Adiciona coluna BIGINT UNSIGNED.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->unsignedBigInteger($name);

Retorno: `Column` — valor do tipo declarado na assinatura.

Guia contextual de Blueprint

decimal() public

Assinatura completa: public function decimal(string $name, int $precision = 10, int $scale = 2): Column;

Descrição: Adiciona coluna DECIMAL.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->decimal($name);

Retorno: `Column` — valor do tipo declarado na assinatura.

Guia contextual de Blueprint

float() public

Assinatura completa: public function float(string $name, int $precision = 8, int $scale = 2): Column;

Descrição: Adiciona coluna FLOAT.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->float($name);

Retorno: `Column` — valor do tipo declarado na assinatura.

Guia contextual de Blueprint

double() public

Assinatura completa: public function double(string $name, int $precision = 8, int $scale = 2): Column;

Descrição: Adiciona coluna DOUBLE.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->double($name);

Retorno: `Column` — valor do tipo declarado na assinatura.

Guia contextual de Blueprint

char() public

Assinatura completa: public function char(string $name, int $length = 1): Column;

Descrição: Adiciona coluna CHAR.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->char($name);

Retorno: `Column` — valor do tipo declarado na assinatura.

Guia contextual de Blueprint

string() public

Assinatura completa: public function string(string $name, int $length = 255): Column;

Descrição: Adiciona coluna VARCHAR.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->string($name);

Retorno: `Column` — valor do tipo declarado na assinatura.

Guia contextual de Blueprint

text() public

Assinatura completa: public function text(string $name): Column;

Descrição: Adiciona coluna TEXT.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->text($name);

Retorno: `Column` — valor do tipo declarado na assinatura.

Guia contextual de Blueprint

mediumText() public

Assinatura completa: public function mediumText(string $name): Column;

Descrição: Adiciona coluna MEDIUMTEXT.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->mediumText($name);

Retorno: `Column` — valor do tipo declarado na assinatura.

Guia contextual de Blueprint

longText() public

Assinatura completa: public function longText(string $name): Column;

Descrição: Adiciona coluna LONGTEXT.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->longText($name);

Retorno: `Column` — valor do tipo declarado na assinatura.

Guia contextual de Blueprint

date() public

Assinatura completa: public function date(string $name): Column;

Descrição: Adiciona coluna DATE.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->date($name);

Retorno: `Column` — valor do tipo declarado na assinatura.

Guia contextual de Blueprint

time() public

Assinatura completa: public function time(string $name): Column;

Descrição: Adiciona coluna TIME.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->time($name);

Retorno: `Column` — valor do tipo declarado na assinatura.

Guia contextual de Blueprint

year() public

Assinatura completa: public function year(string $name): Column;

Descrição: Adiciona coluna YEAR.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->year($name);

Retorno: `Column` — valor do tipo declarado na assinatura.

Guia contextual de Blueprint

dateTime() public

Assinatura completa: public function dateTime(string $name): Column;

Descrição: Adiciona coluna DATETIME.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->dateTime($name);

Retorno: `Column` — valor do tipo declarado na assinatura.

Guia contextual de Blueprint

timestamp() public

Assinatura completa: public function timestamp(string $name): Column;

Descrição: Adiciona coluna TIMESTAMP.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->timestamp($name);

Retorno: `Column` — valor do tipo declarado na assinatura.

Guia contextual de Blueprint

boolean() public

Assinatura completa: public function boolean(string $name): Column;

Descrição: Adiciona coluna BOOLEAN.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->boolean($name);

Retorno: `Column` — valor do tipo declarado na assinatura.

Guia contextual de Blueprint

json() public

Assinatura completa: public function json(string $name): Column;

Descrição: Adiciona coluna JSON.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->json($name);

Retorno: `Column` — valor do tipo declarado na assinatura.

Guia contextual de Blueprint

enum() public

Assinatura completa: public function enum(string $name, array $values): Column;

Descrição: Adiciona coluna ENUM com opções.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->enum($name, $values);

Retorno: `Column` — valor do tipo declarado na assinatura.

Guia contextual de Blueprint

uuid() public

Assinatura completa: public function uuid(string $name): Column;

Descrição: Adiciona coluna UUID.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->uuid($name);

Retorno: `Column` — valor do tipo declarado na assinatura.

Guia contextual de Blueprint

id() public

Assinatura completa: public function id(string $name = 'id'): Column;

Descrição: Adiciona coluna identificadora auto-incremental.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->id();

Retorno: `Column` — valor do tipo declarado na assinatura.

Guia contextual de Blueprint

timestamps() public

Assinatura completa: public function timestamps(): void;

Descrição: Adiciona colunas de criação/atualização de timestamp.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$instance->timestamps();

Retorno: `void` — não devolve valor.

Guia contextual de Blueprint

softDeletes() public

Assinatura completa: public function softDeletes(): Column;

Descrição: Adiciona coluna de exclusão lógica.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->softDeletes();

Retorno: `Column` — valor do tipo declarado na assinatura.

Guia contextual de Blueprint

foreignId() public

Assinatura completa: public function foreignId(string $name): Column;

Descrição: Adiciona coluna de chave estrangeira.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->foreignId($name);

Retorno: `Column` — valor do tipo declarado na assinatura.

Guia contextual de Blueprint

index() public

Assinatura completa: public function index(string|array $columns, ?string $name = null): void;

Descrição: Define índice para coluna(s).

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$instance->index($columns);

Retorno: `void` — não devolve valor.

Guia contextual de Blueprint

unique() public

Assinatura completa: public function unique(string|array $columns, ?string $name = null): void;

Descrição: Define índice único para coluna(s).

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$instance->unique($columns);

Retorno: `void` — não devolve valor.

Guia contextual de Blueprint

dropColumn() public

Assinatura completa: public function dropColumn(string|array $columns): void;

Descrição: Remove, limpa ou consome column.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$instance->dropColumn($columns);

Retorno: `void` — não devolve valor.

Guia contextual de Blueprint

toCreateSql() public

Assinatura completa: public function toCreateSql(): string;

Descrição: Converte ou formata create sql.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->toCreateSql();

Retorno: string — texto/identificador de converte ou formata create sql.

Guia contextual de Blueprint

toAlterSql() public

Assinatura completa: public function toAlterSql(): array;

Descrição: Converte ou formata alter sql.

// $instance é uma instância inicializada de \Framework\Database\Blueprint; argumentos seguem a assinatura acima.
$result = $instance->toAlterSql();

Retorno: array — lista/estrutura retornada pelo método para converte ou formata alter sql. As chaves e o formato são os definidos pela implementação indicada na descrição.

Guia contextual de Blueprint

__construct() public

Assinatura completa: public function __construct(string $name, string $type);

Descrição: Inicializa uma instância de Column.

$instance = new \Framework\Database\Column($name, $type);

Retorno: Não declarado explicitamente na assinatura.

Guia contextual de Column

nullable() public

Assinatura completa: public function nullable(bool $value = true): static;

Descrição: Marca coluna como anulável.

// $instance é uma instância inicializada de \Framework\Database\Column; argumentos seguem a assinatura acima.
$result = $instance->nullable();

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Column

default() public

Assinatura completa: public function default(mixed $value, bool $raw = false): static;

Descrição: Define valor default da coluna.

// $instance é uma instância inicializada de \Framework\Database\Column; argumentos seguem a assinatura acima.
$result = $instance->default($value);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Column

rawExtra() public

Assinatura completa: public function rawExtra(string $sql): static;

Descrição: Define trecho SQL adicional conforme o contrato do builder.

// $instance é uma instância inicializada de \Framework\Database\Column; argumentos seguem a assinatura acima.
$result = $instance->rawExtra($sql);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Column

constrained() public

Assinatura completa: public function constrained(?string $table = null, string $column = 'id'): static;

Descrição: Define referência de chave estrangeira.

// $instance é uma instância inicializada de \Framework\Database\Column; argumentos seguem a assinatura acima.
$result = $instance->constrained();

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Column

onDelete() public

Assinatura completa: public function onDelete(string $action): static;

Descrição: Define ação da chave estrangeira ao excluir a linha referenciada.

// $instance é uma instância inicializada de \Framework\Database\Column; argumentos seguem a assinatura acima.
$result = $instance->onDelete($action);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Column

onUpdate() public

Assinatura completa: public function onUpdate(string $action): static;

Descrição: Define ação da chave estrangeira ao atualizar a linha referenciada.

// $instance é uma instância inicializada de \Framework\Database\Column; argumentos seguem a assinatura acima.
$result = $instance->onUpdate($action);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Column

toSql() public

Assinatura completa: public function toSql(): string;

Descrição: Converte ou formata sql.

// $instance é uma instância inicializada de \Framework\Database\Column; argumentos seguem a assinatura acima.
$result = $instance->toSql();

Retorno: string — texto/identificador de converte ou formata sql.

Guia contextual de Column

toForeignKeySql() public

Assinatura completa: public function toForeignKeySql(string $table): string;

Descrição: Converte ou formata foreign key sql.

// $instance é uma instância inicializada de \Framework\Database\Column; argumentos seguem a assinatura acima.
$result = $instance->toForeignKeySql($table);

Retorno: string — texto/identificador de converte ou formata foreign key sql.

Guia contextual de Column

getInstance() public

Assinatura completa: public static function getInstance(): static;

Descrição: Retorna a instância singleton da conexão PDO configurada.

$result = \Framework\Database\Database::getInstance();

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Database

query() public

Assinatura completa: public function query(string $sql): static;

Descrição: Prepara a instrução SQL e seleciona-a para os binds seguintes.

// $instance é uma instância inicializada de \Framework\Database\Database; argumentos seguem a assinatura acima.
$result = $instance->query($sql);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Database

bind() public

Assinatura completa: public function bind(string $param, mixed $value, ?int $type = null): static;

Descrição: Vincula um valor a um placeholder da instrução preparada.

// $instance é uma instância inicializada de \Framework\Database\Database; argumentos seguem a assinatura acima.
$result = $instance->bind($param, $value);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Database

execute() public

Assinatura completa: public function execute(): bool;

Descrição: Executa a instrução preparada.

// $instance é uma instância inicializada de \Framework\Database\Database; argumentos seguem a assinatura acima.
$result = $instance->execute();

Retorno: bool — true quando a operação descrita (executa a instrução preparada) é concluída; false quando não é confirmada. O bool não carrega mensagem de erro nem contagem de linhas.

Guia contextual de Database

fetchAll() public

Assinatura completa: public function fetchAll(): array;

Descrição: Retorna todas as linhas obtidas pela instrução executada.

// $instance é uma instância inicializada de \Framework\Database\Database; argumentos seguem a assinatura acima.
$result = $instance->fetchAll();

Retorno: array — lista/estrutura retornada pelo método para retorna todas as linhas obtidas pela instrução executada. As chaves e o formato são os definidos pela implementação indicada na descrição.

Guia contextual de Database

fetch() public

Assinatura completa: public function fetch(): object|false;

Descrição: Retorna a próxima linha como objeto ou false quando não há linha.

// $instance é uma instância inicializada de \Framework\Database\Database; argumentos seguem a assinatura acima.
$result = $instance->fetch();

Retorno: object|false — objeto correspondente à operação de consulta descrita (retorna a próxima linha como objeto ou false quando não há linha) quando há resultado; false quando não há registro/objeto válido.

Guia contextual de Database

fetchColumn() public

Assinatura completa: public function fetchColumn(int $col = 0): mixed;

Descrição: Retorna uma coluna da próxima linha obtida.

// $instance é uma instância inicializada de \Framework\Database\Database; argumentos seguem a assinatura acima.
$result = $instance->fetchColumn();

Retorno: mixed — valor produzido/lido por retorna uma coluna da próxima linha obtida. Como o tipo declarado é mixed, verifique o valor concreto antes de tratar como escalar, array ou objeto.

Guia contextual de Database

rowCount() public

Assinatura completa: public function rowCount(): int;

Descrição: Retorna a quantidade de linhas afetadas/retornadas pela instrução.

// $instance é uma instância inicializada de \Framework\Database\Database; argumentos seguem a assinatura acima.
$result = $instance->rowCount();

Retorno: int — valor inteiro de retorna a quantidade de linhas afetadas/retornadas pela instrução.

Guia contextual de Database

lastInsertId() public

Assinatura completa: public function lastInsertId(): string;

Descrição: Retorna o identificador da última inserção como string.

// $instance é uma instância inicializada de \Framework\Database\Database; argumentos seguem a assinatura acima.
$result = $instance->lastInsertId();

Retorno: string — ID gerado pela última inserção, representado como string pelo PDO.

Guia contextual de Database

beginTransaction() public

Assinatura completa: public function beginTransaction(): bool;

Descrição: Inicia uma transação PDO.

// $instance é uma instância inicializada de \Framework\Database\Database; argumentos seguem a assinatura acima.
$result = $instance->beginTransaction();

Retorno: bool — indica o resultado da operação descrita (inicia uma transação PDO); true confirma o resultado e false indica que não foi confirmado, sem mensagem de erro.

Guia contextual de Database

commit() public

Assinatura completa: public function commit(): bool;

Descrição: Confirma a transação aberta.

// $instance é uma instância inicializada de \Framework\Database\Database; argumentos seguem a assinatura acima.
$result = $instance->commit();

Retorno: bool — indica o resultado da operação descrita (confirma a transação aberta); true confirma o resultado e false indica que não foi confirmado, sem mensagem de erro.

Guia contextual de Database

rollback() public

Assinatura completa: public function rollback(): bool;

Descrição: Reverte a transação aberta.

// $instance é uma instância inicializada de \Framework\Database\Database; argumentos seguem a assinatura acima.
$result = $instance->rollback();

Retorno: bool — indica o resultado da operação descrita (reverte a transação aberta); true confirma o resultado e false indica que não foi confirmado, sem mensagem de erro.

Guia contextual de Database

inTransaction() public

Assinatura completa: public function inTransaction(): bool;

Descrição: Informa se há transação ativa.

// $instance é uma instância inicializada de \Framework\Database\Database; argumentos seguem a assinatura acima.
$result = $instance->inTransaction();

Retorno: bool — indica o resultado da operação descrita (informa se há transação ativa); true confirma o resultado e false indica que não foi confirmado, sem mensagem de erro.

Guia contextual de Database

transaction() public

Assinatura completa: public function transaction(callable $callback): mixed;

Descrição: Executa callback em transação e confirma ou reverte conforme o resultado.

// $instance é uma instância inicializada de \Framework\Database\Database; argumentos seguem a assinatura acima.
$result = $instance->transaction($callback);

Retorno: mixed — valor produzido/lido por executa callback em transação e confirma ou reverte conforme o resultado. Como o tipo declarado é mixed, verifique o valor concreto antes de tratar como escalar, array ou objeto.

Guia contextual de Database

execMigration() public

Assinatura completa: public function execMigration(string $sql): int|false;

Descrição: Executa SQL de DDL/migration diretamente via PDO.

// $instance é uma instância inicializada de \Framework\Database\Database; argumentos seguem a assinatura acima.
$result = $instance->execMigration($sql);

Retorno: int|false — quantidade de linhas afetadas pelo SQL de migration; false quando PDO::exec falha. Use apenas SQL de migration confiável.

Guia contextual de Database

getPdo() public

Assinatura completa: public function getPdo(): \PDO;

Descrição: Expõe a conexão PDO interna.

// $instance é uma instância inicializada de \Framework\Database\Database; argumentos seguem a assinatura acima.
$result = $instance->getPdo();

Retorno: `\PDO` — valor do tipo declarado na assinatura.

Guia contextual de Database

__wakeup() public

Assinatura completa: public function __wakeup(): never;

Descrição: Impede a restauração da instância singleton por desserialização.

// $instance é uma instância inicializada de \Framework\Database\Database; argumentos seguem a assinatura acima.
$result = $instance->__wakeup();

Retorno: `never` — não retorna ao chamador (encerra ou lança exceção).

Guia contextual de Database

up() public

Assinatura completa: abstract public function up(): void;

Descrição: Declara operações aplicadas pela migration.

// $instance é uma instância inicializada de \Framework\Database\Migration; argumentos seguem a assinatura acima.
$instance->up();

Retorno: `void` — não devolve valor.

Guia contextual de Migration

down() public

Assinatura completa: abstract public function down(): void;

Descrição: Declara operações para reverter a migration.

// $instance é uma instância inicializada de \Framework\Database\Migration; argumentos seguem a assinatura acima.
$instance->down();

Retorno: `void` — não devolve valor.

Guia contextual de Migration

__construct() public

Assinatura completa: public function __construct();

Descrição: Inicializa uma instância de Model.

$instance = new \Framework\Database\Model();

Retorno: Não declarado explicitamente na assinatura.

Guia contextual de Model

all() public

Assinatura completa: public function all(string $orderBy = 'id', string $direction = 'ASC'): array;

Descrição: Busca todos os registros visíveis do Model, em ordem configurável.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->all();

Retorno: array — lista/estrutura retornada pelo método para busca todos os registros visíveis do Model, em ordem configurável. As chaves e o formato são os definidos pela implementação indicada na descrição.

Guia contextual de Model

find() public

Assinatura completa: public function find(int $id): object|false;

Descrição: Busca um registro pelo ID.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->find($id);

Retorno: object|false — objeto correspondente à operação de consulta descrita (busca um registro pelo ID) quando há resultado; false quando não há registro/objeto válido.

Guia contextual de Model

findOrFail() public

Assinatura completa: public function findOrFail(int $id): object;

Descrição: Busca pelo ID ou lança RuntimeException quando não existe.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->findOrFail($id);

Retorno: `object` — valor do tipo declarado na assinatura.

Guia contextual de Model

findBy() public

Assinatura completa: public function findBy(string $column, mixed $value): object|false;

Descrição: Busca o primeiro registro por coluna e valor.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->findBy($column, $value);

Retorno: object|false — objeto correspondente à operação de consulta descrita (busca o primeiro registro por coluna e valor) quando há resultado; false quando não há registro/objeto válido.

Guia contextual de Model

findMany() public

Assinatura completa: public function findMany(array $ids): array;

Descrição: Busca registros cujos IDs estejam na lista informada.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->findMany($ids);

Retorno: array — lista/estrutura retornada pelo método para busca registros cujos IDs estejam na lista informada. As chaves e o formato são os definidos pela implementação indicada na descrição.

Guia contextual de Model

where() public

Assinatura completa: public function where(string $column, mixed $value, string $op = '='): static;

Descrição: Adiciona condição AND; operador padrão é igualdade.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->where($column, $value);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Model

orWhere() public

Assinatura completa: public function orWhere(string $column, mixed $value, string $op = '='): static;

Descrição: Adiciona condição OR; o operador padrão é igualdade.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->orWhere($column, $value);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Model

whereIn() public

Assinatura completa: public function whereIn(string $column, array $values, string $boolean = 'and'): static;

Descrição: Adiciona condição IN.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->whereIn($column, $values);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Model

whereNotIn() public

Assinatura completa: public function whereNotIn(string $column, array $values, string $boolean = 'and'): static;

Descrição: Adiciona condição NOT IN.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->whereNotIn($column, $values);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Model

whereNull() public

Assinatura completa: public function whereNull(string $column, string $boolean = 'and'): static;

Descrição: Adiciona condição IS NULL.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->whereNull($column);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Model

whereNotNull() public

Assinatura completa: public function whereNotNull(string $column, string $boolean = 'and'): static;

Descrição: Adiciona condição IS NOT NULL.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->whereNotNull($column);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Model

whereBetween() public

Assinatura completa: public function whereBetween(string $column, mixed $min, mixed $max, string $boolean = 'and'): static;

Descrição: Adiciona condição BETWEEN inclusiva.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->whereBetween($column, $min, $max);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Model

whereLike() public

Assinatura completa: public function whereLike(string $column, string $value, string $boolean = 'and'): static;

Descrição: Adiciona condição LIKE com conjunção AND/OR.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->whereLike($column, $value);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Model

whereRaw() public

Assinatura completa: public function whereRaw(string $sql, array $bindings = [], string $boolean = 'and'): static;

Descrição: Adiciona expressão SQL raw com bindings.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->whereRaw($sql);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Model

whereGroup() public

Assinatura completa: public function whereGroup(callable $callback, string $boolean = 'and'): static;

Descrição: Agrupa condições do callback entre parênteses.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->whereGroup($callback);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Model

join() public

Assinatura completa: public function join(string $table, string $first, string $operator, string $second, string $type = 'INNER'): static;

Descrição: Adiciona JOIN entre tabela e colunas indicadas.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->join($table, $first, $operator, $second);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Model

leftJoin() public

Assinatura completa: public function leftJoin(string $table, string $first, string $operator, string $second): static;

Descrição: Adiciona LEFT JOIN.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->leftJoin($table, $first, $operator, $second);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Model

groupBy() public

Assinatura completa: public function groupBy(string ...$columns): static;

Descrição: Adiciona colunas de agrupamento.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->groupBy(...$columns);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Model

having() public

Assinatura completa: public function having(string $condition): static;

Descrição: Adiciona cláusula HAVING em texto SQL.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->having($condition);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Model

orderBy() public

Assinatura completa: public function orderBy(string $column, string $dir = 'ASC'): static;

Descrição: Define coluna e direção da ordenação.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->orderBy($column);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Model

limit() public

Assinatura completa: public function limit(int $n): static;

Descrição: Define o limite de resultados.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->limit($n);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Model

offset() public

Assinatura completa: public function offset(int $n): static;

Descrição: Define o deslocamento da consulta.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->offset($n);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Model

select() public

Assinatura completa: public function select(string ...$cols): static;

Descrição: Define colunas selecionadas.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->select(...$cols);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Model

get() public

Assinatura completa: public function get(): array;

Descrição: Executa a consulta e retorna registros.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->get();

Retorno: array — lista/estrutura retornada pelo método para executa a consulta e retorna registros. As chaves e o formato são os definidos pela implementação indicada na descrição.

Guia contextual de Model

first() public

Assinatura completa: public function first(): object|false;

Descrição: Retorna o primeiro resultado ou false.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->first();

Retorno: object|false — objeto correspondente à operação de consulta descrita (retorna o primeiro resultado ou false) quando há resultado; false quando não há registro/objeto válido.

Guia contextual de Model

firstOrFail() public

Assinatura completa: public function firstOrFail(): object;

Descrição: Retorna o primeiro resultado ou lança RuntimeException.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->firstOrFail();

Retorno: `object` — valor do tipo declarado na assinatura.

Guia contextual de Model

pluck() public

Assinatura completa: public function pluck(string $column): array;

Descrição: Retorna valores de uma coluna nos resultados.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->pluck($column);

Retorno: array — lista/estrutura retornada pelo método para retorna valores de uma coluna nos resultados. As chaves e o formato são os definidos pela implementação indicada na descrição.

Guia contextual de Model

value() public

Assinatura completa: public function value(string $column): mixed;

Descrição: Retorna valor de coluna do primeiro resultado.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->value($column);

Retorno: mixed — valor produzido/lido por retorna valor de coluna do primeiro resultado. Como o tipo declarado é mixed, verifique o valor concreto antes de tratar como escalar, array ou objeto.

Guia contextual de Model

firstOrCreate() public

Assinatura completa: public function firstOrCreate(array $attributes, array $values = []): object;

Descrição: Busca por atributos e cria o registro se não existir.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->firstOrCreate($attributes);

Retorno: `object` — valor do tipo declarado na assinatura.

Guia contextual de Model

updateOrCreate() public

Assinatura completa: public function updateOrCreate(array $attributes, array $values = []): object;

Descrição: Busca por atributos e cria ou atualiza o registro.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->updateOrCreate($attributes);

Retorno: `object` — valor do tipo declarado na assinatura.

Guia contextual de Model

count() public

Assinatura completa: public function count(): int;

Descrição: Conta os registros da consulta.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->count();

Retorno: int — valor inteiro de conta os registros da consulta.

Guia contextual de Model

exists() public

Assinatura completa: public function exists(): bool;

Descrição: Verifica se a consulta encontra registro.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->exists();

Retorno: bool — true quando a consulta encontra registro; false quando a condição não se confirma.

Guia contextual de Model

create() public

Assinatura completa: public function create(array $data): string|false;

Descrição: Insere dados filtrados por fillable e retorna ID ou false.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->create($data);

Retorno: string|false — ID da linha inserida como string; retorna false quando o filtro fillable remove todos os dados e não há colunas para inserir.

Guia contextual de Model

insertMany() public

Assinatura completa: public function insertMany(array $rows): int;

Descrição: Insere várias linhas e retorna quantidade afetada.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->insertMany($rows);

Retorno: int — valor inteiro de insere várias linhas e retorna quantidade afetada.

Guia contextual de Model

update() public

Assinatura completa: public function update(int $id, array $data): bool;

Descrição: Atualiza registro pelo ID.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->update($id, $data);

Retorno: bool — true quando a operação descrita (atualiza registro pelo ID) é concluída; false quando não é confirmada. O bool não carrega mensagem de erro nem contagem de linhas.

Guia contextual de Model

updateWhere() public

Assinatura completa: public function updateWhere(array $data): bool;

Descrição: Atualiza condição fluente; exige WHERE.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->updateWhere($data);

Retorno: bool — true quando a operação descrita (atualiza condição fluente; exige WHERE) é concluída; false quando não é confirmada. O bool não carrega mensagem de erro nem contagem de linhas.

Guia contextual de Model

delete() public

Assinatura completa: public function delete(int $id): bool;

Descrição: Exclui registro pelo ID e pode usar soft delete.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->delete($id);

Retorno: bool — indica o resultado da operação descrita (exclui registro pelo ID e pode usar soft delete); true confirma o resultado e false indica que não foi confirmado, sem mensagem de erro.

Guia contextual de Model

deleteWhere() public

Assinatura completa: public function deleteWhere(): bool;

Descrição: Exclui registros da condição fluente; exige WHERE.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->deleteWhere();

Retorno: bool — indica o resultado da operação descrita (exclui registros da condição fluente; exige WHERE); true confirma o resultado e false indica que não foi confirmado, sem mensagem de erro.

Guia contextual de Model

forceDelete() public

Assinatura completa: public function forceDelete(int $id): bool;

Descrição: Remove fisicamente registro pelo ID.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->forceDelete($id);

Retorno: bool — true quando a operação descrita (remove fisicamente registro pelo ID) é concluída; false quando não é confirmada. O bool não carrega mensagem de erro nem contagem de linhas.

Guia contextual de Model

paginate() public

Assinatura completa: public function paginate(int $perPage = 15, int $page = 1): array;

Descrição: Retorna registros de uma página e metadados.

// $instance é uma instância inicializada de \Framework\Database\Model; argumentos seguem a assinatura acima.
$result = $instance->paginate();

Retorno: array — lista/estrutura retornada pelo método para retorna registros de uma página e metadados. As chaves e o formato são os definidos pela implementação indicada na descrição.

Guia contextual de Model

buildSelectSql() protected

Assinatura completa: protected function buildSelectSql(): string;

Descrição: Cria ou gera select sql.

Retorno: string — texto/identificador de cria ou gera select sql.

Guia contextual de Model

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

filterFillable() protected

Assinatura completa: protected function filterFillable(array $data): array;

Descrição: Valida ou normaliza fillable.

Retorno: array — lista/estrutura retornada pelo método para valida ou normaliza fillable. As chaves e o formato são os definidos pela implementação indicada na descrição.

Guia contextual de Model

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

resetBuilder() protected

Assinatura completa: protected function resetBuilder(): void;

Descrição: Limpa o estado fluente para nova operação.

Retorno: `void` — não devolve valor.

Guia contextual de Model

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

sanitizeIdentifier() protected

Assinatura completa: protected function sanitizeIdentifier(string $identifier): string;

Descrição: Valida ou normaliza identifier.

Retorno: string — texto/identificador de valida ou normaliza identifier.

Guia contextual de Model

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

sanitizeOperator() protected

Assinatura completa: protected function sanitizeOperator(string $op): string;

Descrição: Valida ou normaliza operator.

Retorno: string — texto/identificador de valida ou normaliza operator.

Guia contextual de Model

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

__construct() public

Assinatura completa: public function __construct();

Descrição: Resolve o Model configurado ou falha se ausente/inválido.

$instance = new \Framework\Database\Repository();

Retorno: Não declarado explicitamente na assinatura.

Guia contextual de Repository

all() public

Assinatura completa: public function all(): array;

Descrição: Delega busca ao Model associado.

// $instance é uma instância inicializada de \Framework\Database\Repository; argumentos seguem a assinatura acima.
$result = $instance->all();

Retorno: array — lista/estrutura retornada pelo método para delega busca ao Model associado. As chaves e o formato são os definidos pela implementação indicada na descrição.

Guia contextual de Repository

findById() public

Assinatura completa: public function findById(int $id): object|false;

Descrição: Busca por ID no Model associado.

// $instance é uma instância inicializada de \Framework\Database\Repository; argumentos seguem a assinatura acima.
$result = $instance->findById($id);

Retorno: object|false — objeto correspondente à operação de consulta descrita (busca por ID no Model associado) quando há resultado; false quando não há registro/objeto válido.

Guia contextual de Repository

create() public

Assinatura completa: public function create(array $data): string|false;

Descrição: Delega criação ao Model associado.

// $instance é uma instância inicializada de \Framework\Database\Repository; argumentos seguem a assinatura acima.
$result = $instance->create($data);

Retorno: string|false — ID/identificador produzido como string quando a criação descrita (delega criação ao Model associado) resulta em registro; false quando a implementação não produz ID. Erros de banco podem ser exceções.

Guia contextual de Repository

update() public

Assinatura completa: public function update(int $id, array $data): bool;

Descrição: Delega atualização ao Model associado.

// $instance é uma instância inicializada de \Framework\Database\Repository; argumentos seguem a assinatura acima.
$result = $instance->update($id, $data);

Retorno: bool — indica o resultado da operação descrita (delega atualização ao Model associado); true confirma o resultado e false indica que não foi confirmado, sem mensagem de erro.

Guia contextual de Repository

delete() public

Assinatura completa: public function delete(int $id): bool;

Descrição: Delega exclusão ao Model associado.

// $instance é uma instância inicializada de \Framework\Database\Repository; argumentos seguem a assinatura acima.
$result = $instance->delete($id);

Retorno: bool — indica o resultado da operação descrita (delega exclusão ao Model associado); true confirma o resultado e false indica que não foi confirmado, sem mensagem de erro.

Guia contextual de Repository

paginate() public

Assinatura completa: public function paginate(int $perPage = 15, int $page = 1): array;

Descrição: Delega paginação ao Model associado.

// $instance é uma instância inicializada de \Framework\Database\Repository; argumentos seguem a assinatura acima.
$result = $instance->paginate();

Retorno: array — lista/estrutura retornada pelo método para delega paginação ao Model associado. As chaves e o formato são os definidos pela implementação indicada na descrição.

Guia contextual de Repository

model() protected

Assinatura completa: protected function model(): Model;

Descrição: Retorna o Model associado.

Retorno: `Model` — valor do tipo declarado na assinatura.

Guia contextual de Repository

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

db() protected

Assinatura completa: protected function db(): Database;

Descrição: Retorna a instância Database usada pelo Repository.

Retorno: `Database` — valor do tipo declarado na assinatura.

Guia contextual de Repository

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

create() public

Assinatura completa: public static function create(string $table, callable $callback): void;

Descrição: Cria ou gera a operação de Schema.

\Framework\Database\Schema::create($table, $callback);

Retorno: `void` — não devolve valor.

Guia contextual de Schema

table() public

Assinatura completa: public static function table(string $table, callable $callback): void;

Descrição: Executa callback de definição de colunas para criar/alterar tabela.

\Framework\Database\Schema::table($table, $callback);

Retorno: `void` — não devolve valor.

Guia contextual de Schema

dropIfExists() public

Assinatura completa: public static function dropIfExists(string $table): void;

Descrição: Remove, limpa ou consome if exists.

\Framework\Database\Schema::dropIfExists($table);

Retorno: `void` — não devolve valor.

Guia contextual de Schema

drop() public

Assinatura completa: public static function drop(string $table): void;

Descrição: Remove, limpa ou consome a operação de Schema.

\Framework\Database\Schema::drop($table);

Retorno: `void` — não devolve valor.

Guia contextual de Schema

set() public

Assinatura completa: public static function set(object $user, object $tokenRecord): void;

Descrição: Define ou configura a operação de ApiAuthContext.

\Framework\Http\Api\ApiAuthContext::set($user, $tokenRecord);

Retorno: `void` — não devolve valor.

Guia contextual de ApiAuthContext

check() public

Assinatura completa: public static function check(): bool;

Descrição: Verifica a operação de ApiAuthContext.

$result = \Framework\Http\Api\ApiAuthContext::check();

Retorno: bool — true quando a operação de ApiAuthContext; false quando a condição não se confirma.

Guia contextual de ApiAuthContext

user() public

Assinatura completa: public static function user(): ?object;

Descrição: Retorna o usuário associado ao token Bearer validado.

$result = \Framework\Http\Api\ApiAuthContext::user();

Retorno: `?object` — valor opcional; pode ser `null`.

Guia contextual de ApiAuthContext

id() public

Assinatura completa: public static function id(): ?int;

Descrição: Retorna o ID do usuário autenticado pela API.

$result = \Framework\Http\Api\ApiAuthContext::id();

Retorno: `?int` — valor opcional; pode ser `null`.

Guia contextual de ApiAuthContext

token() public

Assinatura completa: public static function token(): ?object;

Descrição: Retorna o token autenticado no contexto atual.

$result = \Framework\Http\Api\ApiAuthContext::token();

Retorno: `?object` — valor opcional; pode ser `null`.

Guia contextual de ApiAuthContext

clear() public

Assinatura completa: public static function clear(): void;

Descrição: Remove, limpa ou consome a operação de ApiAuthContext.

\Framework\Http\Api\ApiAuthContext::clear();

Retorno: `void` — não devolve valor.

Guia contextual de ApiAuthContext

__construct() public

Assinatura completa: public function __construct( protected string $baseUri = '', protected array $defaultHeaders = [], protected int $defaultTimeout = 30 );

Descrição: Configura URI base, headers e timeout padrão.

$instance = new \Framework\Http\Api\ApiClient();

Retorno: Não declarado explicitamente na assinatura.

Guia contextual de ApiClient

get() public

Assinatura completa: public function get(string $uri, array $options = []): array;

Descrição: Executa chamada HTTP GET.

// $instance é uma instância inicializada de \Framework\Http\Api\ApiClient; argumentos seguem a assinatura acima.
$result = $instance->get($uri);

Retorno: array — lista/estrutura retornada pelo método para executa chamada HTTP GET. As chaves e o formato são os definidos pela implementação indicada na descrição.

Guia contextual de ApiClient

post() public

Assinatura completa: public function post(string $uri, array $options = []): array;

Descrição: Executa chamada HTTP POST.

// $instance é uma instância inicializada de \Framework\Http\Api\ApiClient; argumentos seguem a assinatura acima.
$result = $instance->post($uri);

Retorno: array — lista/estrutura retornada pelo método para executa chamada HTTP POST. As chaves e o formato são os definidos pela implementação indicada na descrição.

Guia contextual de ApiClient

put() public

Assinatura completa: public function put(string $uri, array $options = []): array;

Descrição: Executa chamada HTTP PUT.

// $instance é uma instância inicializada de \Framework\Http\Api\ApiClient; argumentos seguem a assinatura acima.
$result = $instance->put($uri);

Retorno: array — lista/estrutura retornada pelo método para executa chamada HTTP PUT. As chaves e o formato são os definidos pela implementação indicada na descrição.

Guia contextual de ApiClient

patch() public

Assinatura completa: public function patch(string $uri, array $options = []): array;

Descrição: Executa chamada HTTP PATCH.

// $instance é uma instância inicializada de \Framework\Http\Api\ApiClient; argumentos seguem a assinatura acima.
$result = $instance->patch($uri);

Retorno: array — lista/estrutura retornada pelo método para executa chamada HTTP PATCH. As chaves e o formato são os definidos pela implementação indicada na descrição.

Guia contextual de ApiClient

delete() public

Assinatura completa: public function delete(string $uri, array $options = []): array;

Descrição: Executa chamada HTTP DELETE.

// $instance é uma instância inicializada de \Framework\Http\Api\ApiClient; argumentos seguem a assinatura acima.
$result = $instance->delete($uri);

Retorno: array — lista/estrutura retornada pelo método para executa chamada HTTP DELETE. As chaves e o formato são os definidos pela implementação indicada na descrição.

Guia contextual de ApiClient

request() public

Assinatura completa: public function request(string $method, string $uri, array $options = []): array;

Descrição: Monta ApiRequest com método/opções e executa.

// $instance é uma instância inicializada de \Framework\Http\Api\ApiClient; argumentos seguem a assinatura acima.
$result = $instance->request($method, $uri);

Retorno: array — lista/estrutura retornada pelo método para monta ApiRequest com método/opções e executa. As chaves e o formato são os definidos pela implementação indicada na descrição.

Guia contextual de ApiClient

send() public

Assinatura completa: public function send(ApiRequest $req, bool $throwOnError = true): array;

Descrição: Executa ApiRequest ou lança ApiException.

// $instance é uma instância inicializada de \Framework\Http\Api\ApiClient; argumentos seguem a assinatura acima.
$result = $instance->send($req);

Retorno: array — lista/estrutura retornada pelo método para executa ApiRequest ou lança ApiException. As chaves e o formato são os definidos pela implementação indicada na descrição.

Guia contextual de ApiClient

parseHeaders() protected

Assinatura completa: protected function parseHeaders(string $raw): array;

Descrição: Converte ou formata headers.

Retorno: array — lista/estrutura retornada pelo método para converte ou formata headers. As chaves e o formato são os definidos pela implementação indicada na descrição.

Guia contextual de ApiClient

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

__construct() public

Assinatura completa: public function __construct( string $message, protected int $statusCode = 0, protected string $responseBody = '', protected array $responseJson = [], ?\Throwable $previous = null );

Descrição: Inicializa uma instância de ApiException.

$instance = new \Framework\Http\Api\ApiException($message);

Retorno: Não declarado explicitamente na assinatura.

Guia contextual de ApiException

statusCode() public

Assinatura completa: public function statusCode(): int;

Descrição: Retorna o status HTTP associado à falha da chamada.

// $instance é uma instância inicializada de \Framework\Http\Api\ApiException; argumentos seguem a assinatura acima.
$result = $instance->statusCode();

Retorno: int — valor inteiro de retorna o status HTTP associado à falha da chamada.

Guia contextual de ApiException

responseBody() public

Assinatura completa: public function responseBody(): string;

Descrição: Retorna o corpo bruto recebido na resposta.

// $instance é uma instância inicializada de \Framework\Http\Api\ApiException; argumentos seguem a assinatura acima.
$result = $instance->responseBody();

Retorno: string — texto/identificador de retorna o corpo bruto recebido na resposta.

Guia contextual de ApiException

responseJson() public

Assinatura completa: public function responseJson(): array;

Descrição: Retorna a resposta decodificada como JSON quando possível.

// $instance é uma instância inicializada de \Framework\Http\Api\ApiException; argumentos seguem a assinatura acima.
$result = $instance->responseJson();

Retorno: array — lista/estrutura retornada pelo método para retorna a resposta decodificada como JSON quando possível. As chaves e o formato são os definidos pela implementação indicada na descrição.

Guia contextual de ApiException

isConnectionError() public

Assinatura completa: public function isConnectionError(): bool;

Descrição: Verifica connection error.

// $instance é uma instância inicializada de \Framework\Http\Api\ApiException; argumentos seguem a assinatura acima.
$result = $instance->isConnectionError();

Retorno: bool — true quando connection error; false quando a condição não se confirma.

Guia contextual de ApiException

__construct() public

Assinatura completa: public function __construct( private string $method, private string $url );

Descrição: Cria descrição imutável de chamada HTTP.

$instance = new \Framework\Http\Api\ApiRequest($method, $url);

Retorno: Não declarado explicitamente na assinatura.

Guia contextual de ApiRequest

method() public

Assinatura completa: public function method(): string;

Descrição: Retorna método HTTP configurado.

// $instance é uma instância inicializada de \Framework\Http\Api\ApiRequest; argumentos seguem a assinatura acima.
$result = $instance->method();

Retorno: string — texto/identificador de retorna método HTTP configurado.

Guia contextual de ApiRequest

url() public

Assinatura completa: public function url(): string;

Descrição: Retorna URL resolvida.

// $instance é uma instância inicializada de \Framework\Http\Api\ApiRequest; argumentos seguem a assinatura acima.
$result = $instance->url();

Retorno: string — texto/identificador de retorna URL resolvida.

Guia contextual de ApiRequest

headers() public

Assinatura completa: public function headers(): array;

Descrição: Retorna headers configurados.

// $instance é uma instância inicializada de \Framework\Http\Api\ApiRequest; argumentos seguem a assinatura acima.
$result = $instance->headers();

Retorno: array — lista/estrutura retornada pelo método para retorna headers configurados. As chaves e o formato são os definidos pela implementação indicada na descrição.

Guia contextual de ApiRequest

query() public

Assinatura completa: public function query(): array;

Descrição: Localiza ou resolve a operação de ApiRequest.

// $instance é uma instância inicializada de \Framework\Http\Api\ApiRequest; argumentos seguem a assinatura acima.
$result = $instance->query();

Retorno: array — lista/estrutura retornada pelo método para localiza ou resolve a operação de ApiRequest. As chaves e o formato são os definidos pela implementação indicada na descrição.

Guia contextual de ApiRequest

body() public

Assinatura completa: public function body(): ?string;

Descrição: Retorna corpo configurado.

// $instance é uma instância inicializada de \Framework\Http\Api\ApiRequest; argumentos seguem a assinatura acima.
$result = $instance->body();

Retorno: `?string` — valor opcional; pode ser `null`.

Guia contextual de ApiRequest

bodyContentType() public

Assinatura completa: public function bodyContentType(): ?string;

Descrição: Retorna Content-Type do corpo.

// $instance é uma instância inicializada de \Framework\Http\Api\ApiRequest; argumentos seguem a assinatura acima.
$result = $instance->bodyContentType();

Retorno: `?string` — valor opcional; pode ser `null`.

Guia contextual de ApiRequest

timeout() public

Assinatura completa: public function timeout(): ?int;

Descrição: Retorna timeout em segundos.

// $instance é uma instância inicializada de \Framework\Http\Api\ApiRequest; argumentos seguem a assinatura acima.
$result = $instance->timeout();

Retorno: `?int` — valor opcional; pode ser `null`.

Guia contextual de ApiRequest

withPath() public

Assinatura completa: public function withPath(string $path): self;

Descrição: Retorna outra requisição com path aplicado.

// $instance é uma instância inicializada de \Framework\Http\Api\ApiRequest; argumentos seguem a assinatura acima.
$result = $instance->withPath($path);

Retorno: `self` — valor do tipo declarado na assinatura.

Guia contextual de ApiRequest

withHeader() public

Assinatura completa: public function withHeader(string $name, string $value): self;

Descrição: Retorna outra requisição com header adicional.

// $instance é uma instância inicializada de \Framework\Http\Api\ApiRequest; argumentos seguem a assinatura acima.
$result = $instance->withHeader($name, $value);

Retorno: `self` — valor do tipo declarado na assinatura.

Guia contextual de ApiRequest

withHeaders() public

Assinatura completa: public function withHeaders(array $headers): self;

Descrição: Retorna outra requisição com headers adicionais.

// $instance é uma instância inicializada de \Framework\Http\Api\ApiRequest; argumentos seguem a assinatura acima.
$result = $instance->withHeaders($headers);

Retorno: `self` — valor do tipo declarado na assinatura.

Guia contextual de ApiRequest

withQuery() public

Assinatura completa: public function withQuery(array $query): self;

Descrição: Retorna outra requisição com query string.

// $instance é uma instância inicializada de \Framework\Http\Api\ApiRequest; argumentos seguem a assinatura acima.
$result = $instance->withQuery($query);

Retorno: `self` — valor do tipo declarado na assinatura.

Guia contextual de ApiRequest

withJson() public

Assinatura completa: public function withJson(array $data): self;

Descrição: Retorna outra requisição com corpo JSON.

// $instance é uma instância inicializada de \Framework\Http\Api\ApiRequest; argumentos seguem a assinatura acima.
$result = $instance->withJson($data);

Retorno: `self` — valor do tipo declarado na assinatura.

Guia contextual de ApiRequest

withFormBody() public

Assinatura completa: public function withFormBody(array $data): self;

Descrição: Retorna outra requisição com corpo form.

// $instance é uma instância inicializada de \Framework\Http\Api\ApiRequest; argumentos seguem a assinatura acima.
$result = $instance->withFormBody($data);

Retorno: `self` — valor do tipo declarado na assinatura.

Guia contextual de ApiRequest

withBody() public

Assinatura completa: public function withBody(string $body, string $contentType): self;

Descrição: Retorna outra requisição com corpo bruto.

// $instance é uma instância inicializada de \Framework\Http\Api\ApiRequest; argumentos seguem a assinatura acima.
$result = $instance->withBody($body, $contentType);

Retorno: `self` — valor do tipo declarado na assinatura.

Guia contextual de ApiRequest

withBearerToken() public

Assinatura completa: public function withBearerToken(string $token): self;

Descrição: Retorna outra requisição com autenticação Bearer.

// $instance é uma instância inicializada de \Framework\Http\Api\ApiRequest; argumentos seguem a assinatura acima.
$result = $instance->withBearerToken($token);

Retorno: `self` — valor do tipo declarado na assinatura.

Guia contextual de ApiRequest

withBasicAuth() public

Assinatura completa: public function withBasicAuth(string $username, string $password): self;

Descrição: Retorna outra requisição com autenticação Basic.

// $instance é uma instância inicializada de \Framework\Http\Api\ApiRequest; argumentos seguem a assinatura acima.
$result = $instance->withBasicAuth($username, $password);

Retorno: `self` — valor do tipo declarado na assinatura.

Guia contextual de ApiRequest

withTimeout() public

Assinatura completa: public function withTimeout(int $seconds): self;

Descrição: Retorna outra requisição com timeout alterado.

// $instance é uma instância inicializada de \Framework\Http\Api\ApiRequest; argumentos seguem a assinatura acima.
$result = $instance->withTimeout($seconds);

Retorno: `self` — valor do tipo declarado na assinatura.

Guia contextual de ApiRequest

success() public

Assinatura completa: public static function success( mixed $data = null, string $message = 'Operação realizada com sucesso.', int $status = 200, array $meta = [] ): never;

Descrição: Emite envelope JSON de sucesso com status e meta opcional.

$result = \Framework\Http\Api\ApiResponse::success();

Retorno: `never` — não retorna ao chamador (encerra ou lança exceção).

Guia contextual de ApiResponse

paginated() public

Assinatura completa: public static function paginated( array $paginateResult, string $message = 'Dados encontrados.' ): never;

Descrição: Converte resultado de Model::paginate em envelope paginado.

$result = \Framework\Http\Api\ApiResponse::paginated($paginateResult);

Retorno: `never` — não retorna ao chamador (encerra ou lança exceção).

Guia contextual de ApiResponse

error() public

Assinatura completa: public static function error( string $message, array $errors = [], int $status = 400 ): never;

Descrição: Emite envelope JSON de erro e encerra.

$result = \Framework\Http\Api\ApiResponse::error($message);

Retorno: `never` — não retorna ao chamador (encerra ou lança exceção).

Guia contextual de ApiResponse

send() protected

Assinatura completa: protected static function send(array $payload, int $status): never;

Descrição: Emite resposta HTTP/API com status, headers e corpo.

Retorno: `never` — não retorna ao chamador (encerra ou lança exceção).

Guia contextual de ApiResponse

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

__construct() public

Assinatura completa: public function __construct();

Descrição: Cria o Request atual disponível ao Controller filho.

$instance = new \Framework\Http\Controller();

Retorno: Não declarado explicitamente na assinatura.

Guia contextual de Controller

view() protected

Assinatura completa: protected function view(string $view, array $data = [], string|false|null $layout = null): void;

Descrição: Renderiza uma View com dados e layout opcional; injeta CSRF em formulários mutáveis.

Retorno: `void` — não devolve valor.

Guia contextual de Controller

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

viewOnly() protected

Assinatura completa: protected function viewOnly(string $view, array $data = []): void;

Descrição: Renderiza uma View sem layout.

Retorno: `void` — não devolve valor.

Guia contextual de Controller

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

injectCsrfTokens() protected

Assinatura completa: protected function injectCsrfTokens(string|false $html): string;

Descrição: Insere campo CSRF nos formulários HTML mutáveis sem token.

Retorno: string — texto/identificador de insere campo CSRF nos formulários HTML mutáveis sem token.

Guia contextual de Controller

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

resolveViewPath() protected

Assinatura completa: protected function resolveViewPath(string $view): string;

Descrição: Resolve dot-notation de View sob VIEW_PATH.

Retorno: string — texto/identificador de resolve dot-notation de View sob VIEW_PATH.

Guia contextual de Controller

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

resolveLayoutPath() protected

Assinatura completa: protected function resolveLayoutPath(string $layout): string;

Descrição: Resolve o arquivo de layout sob VIEW_PATH/layouts.

Retorno: string — texto/identificador de resolve o arquivo de layout sob VIEW_PATH/layouts.

Guia contextual de Controller

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

resolveLayoutName() protected

Assinatura completa: protected function resolveLayoutName(string|false|null $layout): ?string;

Descrição: Escolhe layout explícito, padrão ou nenhum.

Retorno: `?string` — valor opcional; pode ser `null`.

Guia contextual de Controller

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

layoutExists() protected

Assinatura completa: protected function layoutExists(string $layout): bool;

Descrição: Verifica se o layout resolvido existe no disco.

Retorno: bool — true quando o layout resolvido existe no disco; false quando a condição não se confirma.

Guia contextual de Controller

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

redirect() protected

Assinatura completa: protected function redirect(string $url): never;

Descrição: Redireciona para alvo seguro e encerra a execução.

Retorno: `never` — não retorna ao chamador (encerra ou lança exceção).

Guia contextual de Controller

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

back() protected

Assinatura completa: protected function back(): never;

Descrição: Redireciona para Referer validado ou fallback seguro.

Retorno: `never` — não retorna ao chamador (encerra ou lança exceção).

Guia contextual de Controller

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

redirectWith() protected

Assinatura completa: protected function redirectWith(string $url, string $type, string $message): never;

Descrição: Grava flash e redireciona.

Retorno: `never` — não retorna ao chamador (encerra ou lança exceção).

Guia contextual de Controller

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

appUrl() protected

Assinatura completa: protected function appUrl(): string;

Descrição: Retorna APP_URL quando definida, senão string vazia.

Retorno: string — texto/identificador de retorna APP_URL quando definida, senão string vazia.

Guia contextual de Controller

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

json() protected

Assinatura completa: protected function json(mixed $data, int $status = 200): never;

Descrição: Emite JSON com status e encerra; serialização inválida produz HTTP 500.

Retorno: `never` — não retorna ao chamador (encerra ou lança exceção).

Guia contextual de Controller

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

jsonSuccess() protected

Assinatura completa: protected function jsonSuccess(string $message = 'OK', array $data = [], int $status = 200): never;

Descrição: Emite JSON de sucesso com message/data e encerra.

Retorno: `never` — não retorna ao chamador (encerra ou lança exceção).

Guia contextual de Controller

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

jsonError() protected

Assinatura completa: protected function jsonError(string $message, int $status = 400, array $data = []): never;

Descrição: Emite JSON de erro com message/status/data e encerra.

Retorno: `never` — não retorna ao chamador (encerra ou lança exceção).

Guia contextual de Controller

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

flash() protected

Assinatura completa: protected function flash(string $type, string $message): void;

Descrição: Armazena uma mensagem flash na sessão.

Retorno: `void` — não devolve valor.

Guia contextual de Controller

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

auth() protected

Assinatura completa: protected function auth(): bool;

Descrição: Verifica a autenticação Web atual.

Retorno: bool — true quando a autenticação Web atual; false quando a condição não se confirma.

Guia contextual de Controller

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

user() protected

Assinatura completa: protected function user(): ?object;

Descrição: Retorna o usuário guardado na sessão ou null.

Retorno: `?object` — valor opcional; pode ser `null`.

Guia contextual de Controller

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

userId() protected

Assinatura completa: protected function userId(): int;

Descrição: Retorna o ID da sessão ou 0.

Retorno: int — valor inteiro de retorna o ID da sessão ou 0.

Guia contextual de Controller

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

userRole() protected

Assinatura completa: protected function userRole(): string;

Descrição: Retorna o papel do usuário atual ou `guest`.

Retorno: string — texto/identificador de retorna o papel do usuário atual ou `guest`.

Guia contextual de Controller

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

checkMethod() protected

Assinatura completa: protected function checkMethod(string|array $tipos, string $mensagem = 'Requisição inválida.', int $status = 400): void;

Descrição: Exige um dos tipos de requisição reconhecidos ou encerra com erro.

Retorno: `void` — não devolve valor.

Guia contextual de Controller

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

validate() protected

Assinatura completa: protected function validate(array $data, array $rules, string $redirectBack = ''): array;

Descrição: Valida dados com regras e trata erros no fluxo Web.

Retorno: array — lista/estrutura retornada pelo método para valida dados com regras e trata erros no fluxo Web. As chaves e o formato são os definidos pela implementação indicada na descrição.

Guia contextual de Controller

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

validateRequest() protected

Assinatura completa: protected function validateRequest(object $request, string $redirectBack = '', ?array $flashOnly = null): array;

Descrição: Valida um FormRequest e devolve seus dados validados.

Retorno: array — lista/estrutura retornada pelo método para valida um FormRequest e devolve seus dados validados. As chaves e o formato são os definidos pela implementação indicada na descrição.

Guia contextual de Controller

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

abort() protected

Assinatura completa: protected function abort(int $code, string $message = ''): never;

Descrição: Interrompe a action lançando erro HTTP com status/mensagem.

Retorno: `never` — não retorna ao chamador (encerra ou lança exceção).

Guia contextual de Controller

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

abortIf() protected

Assinatura completa: protected function abortIf(mixed $condition, int $code, string $message = ''): void;

Descrição: Interrompe quando a condição é verdadeira.

Retorno: `void` — não devolve valor.

Guia contextual de Controller

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

abortUnless() protected

Assinatura completa: protected function abortUnless(mixed $condition, int $code, string $message = ''): void;

Descrição: Interrompe quando a condição é falsa.

Retorno: `void` — não devolve valor.

Guia contextual de Controller

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

method() public

Assinatura completa: public function method(): string;

Descrição: Retorna método HTTP efetivo, incluindo override POST.

// $instance é uma instância inicializada de \Framework\Http\Request; argumentos seguem a assinatura acima.
$result = $instance->method();

Retorno: string — texto/identificador de retorna método HTTP efetivo, incluindo override POST.

Guia contextual de Request

uri() public

Assinatura completa: public function uri(): string;

Descrição: Retorna caminho sem query string.

// $instance é uma instância inicializada de \Framework\Http\Request; argumentos seguem a assinatura acima.
$result = $instance->uri();

Retorno: string — texto/identificador de retorna caminho sem query string.

Guia contextual de Request

isGet() public

Assinatura completa: public function isGet(): bool;

Descrição: Verifica get.

// $instance é uma instância inicializada de \Framework\Http\Request; argumentos seguem a assinatura acima.
$result = $instance->isGet();

Retorno: bool — true quando get; false quando a condição não se confirma.

Guia contextual de Request

isPost() public

Assinatura completa: public function isPost(): bool;

Descrição: Verifica post.

// $instance é uma instância inicializada de \Framework\Http\Request; argumentos seguem a assinatura acima.
$result = $instance->isPost();

Retorno: bool — true quando post; false quando a condição não se confirma.

Guia contextual de Request

isPut() public

Assinatura completa: public function isPut(): bool;

Descrição: Verifica put.

// $instance é uma instância inicializada de \Framework\Http\Request; argumentos seguem a assinatura acima.
$result = $instance->isPut();

Retorno: bool — true quando put; false quando a condição não se confirma.

Guia contextual de Request

isPatch() public

Assinatura completa: public function isPatch(): bool;

Descrição: Verifica patch.

// $instance é uma instância inicializada de \Framework\Http\Request; argumentos seguem a assinatura acima.
$result = $instance->isPatch();

Retorno: bool — true quando patch; false quando a condição não se confirma.

Guia contextual de Request

isDelete() public

Assinatura completa: public function isDelete(): bool;

Descrição: Verifica delete.

// $instance é uma instância inicializada de \Framework\Http\Request; argumentos seguem a assinatura acima.
$result = $instance->isDelete();

Retorno: bool — true quando delete; false quando a condição não se confirma.

Guia contextual de Request

isAjax() public

Assinatura completa: public function isAjax(): bool;

Descrição: Detecta X-Requested-With de AJAX.

// $instance é uma instância inicializada de \Framework\Http\Request; argumentos seguem a assinatura acima.
$result = $instance->isAjax();

Retorno: bool — indica o resultado da operação descrita (detecta X-Requested-With de AJAX); true confirma o resultado e false indica que não foi confirmado, sem mensagem de erro.

Guia contextual de Request

isJson() public

Assinatura completa: public function isJson(): bool;

Descrição: Detecta indicação JSON.

// $instance é uma instância inicializada de \Framework\Http\Request; argumentos seguem a assinatura acima.
$result = $instance->isJson();

Retorno: bool — indica o resultado da operação descrita (detecta indicação JSON); true confirma o resultado e false indica que não foi confirmado, sem mensagem de erro.

Guia contextual de Request

get() public

Assinatura completa: public function get(string $key, mixed $default = null): mixed;

Descrição: Lê valor de query com fallback.

// $instance é uma instância inicializada de \Framework\Http\Request; argumentos seguem a assinatura acima.
$result = $instance->get($key);

Retorno: mixed — valor produzido/lido por lê valor de query com fallback. Como o tipo declarado é mixed, verifique o valor concreto antes de tratar como escalar, array ou objeto.

Guia contextual de Request

post() public

Assinatura completa: public function post(string $key, mixed $default = null): mixed;

Descrição: Lê valor de body/form com fallback.

// $instance é uma instância inicializada de \Framework\Http\Request; argumentos seguem a assinatura acima.
$result = $instance->post($key);

Retorno: mixed — valor produzido/lido por lê valor de body/form com fallback. Como o tipo declarado é mixed, verifique o valor concreto antes de tratar como escalar, array ou objeto.

Guia contextual de Request

all() public

Assinatura completa: public function all(): array;

Descrição: Retorna dados combinados da requisição.

// $instance é uma instância inicializada de \Framework\Http\Request; argumentos seguem a assinatura acima.
$result = $instance->all();

Retorno: array — lista/estrutura retornada pelo método para retorna dados combinados da requisição. As chaves e o formato são os definidos pela implementação indicada na descrição.

Guia contextual de Request

raw() public

Assinatura completa: public function raw(string $key, mixed $default = null): mixed;

Descrição: Retorna corpo HTTP bruto.

// $instance é uma instância inicializada de \Framework\Http\Request; argumentos seguem a assinatura acima.
$result = $instance->raw($key);

Retorno: mixed — valor produzido/lido por retorna corpo HTTP bruto. Como o tipo declarado é mixed, verifique o valor concreto antes de tratar como escalar, array ou objeto.

Guia contextual de Request

input() public

Assinatura completa: public function input(string $key, mixed $default = null): mixed;

Descrição: Lê campo de entrada conforme prioridade implementada.

// $instance é uma instância inicializada de \Framework\Http\Request; argumentos seguem a assinatura acima.
$result = $instance->input($key);

Retorno: mixed — valor produzido/lido por lê campo de entrada conforme prioridade implementada. Como o tipo declarado é mixed, verifique o valor concreto antes de tratar como escalar, array ou objeto.

Guia contextual de Request

has() public

Assinatura completa: public function has(string $key): bool;

Descrição: Verifica presença do campo.

// $instance é uma instância inicializada de \Framework\Http\Request; argumentos seguem a assinatura acima.
$result = $instance->has($key);

Retorno: bool — true quando presença do campo; false quando a condição não se confirma.

Guia contextual de Request

json() public

Assinatura completa: public function json(?string $key = null, mixed $default = null): mixed;

Descrição: Decodifica corpo JSON.

// $instance é uma instância inicializada de \Framework\Http\Request; argumentos seguem a assinatura acima.
$result = $instance->json();

Retorno: mixed — valor produzido/lido por decodifica corpo JSON. Como o tipo declarado é mixed, verifique o valor concreto antes de tratar como escalar, array ou objeto.

Guia contextual de Request

file() public

Assinatura completa: public function file(string $key): ?array;

Descrição: Retorna informação de arquivo do campo.

// $instance é uma instância inicializada de \Framework\Http\Request; argumentos seguem a assinatura acima.
$result = $instance->file($key);

Retorno: `?array` — valor opcional; pode ser `null`.

Guia contextual de Request

hasFile() public

Assinatura completa: public function hasFile(string $key): bool;

Descrição: Verifica file.

// $instance é uma instância inicializada de \Framework\Http\Request; argumentos seguem a assinatura acima.
$result = $instance->hasFile($key);

Retorno: bool — true quando file; false quando a condição não se confirma.

Guia contextual de Request

header() public

Assinatura completa: public function header(string $name, string $default = ''): string;

Descrição: Lê header HTTP pelo nome informado.

// $instance é uma instância inicializada de \Framework\Http\Request; argumentos seguem a assinatura acima.
$result = $instance->header($name);

Retorno: string — texto/identificador de lê header HTTP pelo nome informado.

Guia contextual de Request

ip() public

Assinatura completa: public function ip(): string;

Descrição: Retorna IP conforme configuração de proxy confiável.

// $instance é uma instância inicializada de \Framework\Http\Request; argumentos seguem a assinatura acima.
$result = $instance->ip();

Retorno: string — texto/identificador de retorna IP conforme configuração de proxy confiável.

Guia contextual de Request

userAgent() public

Assinatura completa: public function userAgent(): string;

Descrição: Retorna User-Agent.

// $instance é uma instância inicializada de \Framework\Http\Request; argumentos seguem a assinatura acima.
$result = $instance->userAgent();

Retorno: string — texto/identificador de retorna User-Agent.

Guia contextual de Request

sanitizeValue() public

Assinatura completa: public static function sanitizeValue(mixed $value): mixed;

Descrição: Sanitiza valor escalar/array.

$result = \Framework\Http\Request::sanitizeValue($value);

Retorno: mixed — valor produzido/lido por sanitiza valor escalar/array. Como o tipo declarado é mixed, verifique o valor concreto antes de tratar como escalar, array ou objeto.

Guia contextual de Request

getInstance() public

Assinatura completa: public static function getInstance(): ?static;

Descrição: Retorna instance.

$result = \Framework\Http\Router::getInstance();

Retorno: `?static` — valor opcional; pode ser `null`.

Guia contextual de Router

setInstance() public

Assinatura completa: public static function setInstance(self $router): void;

Descrição: Define ou configura instance.

\Framework\Http\Router::setInstance($router);

Retorno: `void` — não devolve valor.

Guia contextual de Router

__construct() public

Assinatura completa: public function __construct(Request $request);

Descrição: Inicializa uma instância de Router.

$instance = new \Framework\Http\Router($request);

Retorno: Não declarado explicitamente na assinatura.

Guia contextual de Router

get() public

Assinatura completa: public function get(string $path, array|string $action, array $middlewares = []): static;

Descrição: Registra rota GET.

// $instance é uma instância inicializada de \Framework\Http\Router; argumentos seguem a assinatura acima.
$result = $instance->get($path, $action);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Router

post() public

Assinatura completa: public function post(string $path, array|string $action, array $middlewares = []): static;

Descrição: Registra rota POST.

// $instance é uma instância inicializada de \Framework\Http\Router; argumentos seguem a assinatura acima.
$result = $instance->post($path, $action);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Router

put() public

Assinatura completa: public function put(string $path, array|string $action, array $middlewares = []): static;

Descrição: Registra rota PUT.

// $instance é uma instância inicializada de \Framework\Http\Router; argumentos seguem a assinatura acima.
$result = $instance->put($path, $action);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Router

patch() public

Assinatura completa: public function patch(string $path, array|string $action, array $middlewares = []): static;

Descrição: Registra rota PATCH.

// $instance é uma instância inicializada de \Framework\Http\Router; argumentos seguem a assinatura acima.
$result = $instance->patch($path, $action);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Router

delete() public

Assinatura completa: public function delete(string $path, array|string $action, array $middlewares = []): static;

Descrição: Registra rota DELETE.

// $instance é uma instância inicializada de \Framework\Http\Router; argumentos seguem a assinatura acima.
$result = $instance->delete($path, $action);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Router

options() public

Assinatura completa: public function options(string $path, array|string $action, array $middlewares = []): static;

Descrição: Registra rota OPTIONS.

// $instance é uma instância inicializada de \Framework\Http\Router; argumentos seguem a assinatura acima.
$result = $instance->options($path, $action);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Router

match() public

Assinatura completa: public function match(array $methods, string $path, array|string $action, array $middlewares = []): static;

Descrição: Registra rota para métodos informados.

// $instance é uma instância inicializada de \Framework\Http\Router; argumentos seguem a assinatura acima.
$result = $instance->match($methods, $path, $action);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Router

resource() public

Assinatura completa: public function resource(string $path, string $controller, array $only = []): void;

Descrição: Expande as rotas REST suportadas pelo método.

// $instance é uma instância inicializada de \Framework\Http\Router; argumentos seguem a assinatura acima.
$instance->resource($path, $controller);

Retorno: `void` — não devolve valor.

Guia contextual de Router

group() public

Assinatura completa: public function group(array $options, callable $callback): void;

Descrição: Executa callback dentro de grupo com prefixo/middleware.

// $instance é uma instância inicializada de \Framework\Http\Router; argumentos seguem a assinatura acima.
$instance->group($options, $callback);

Retorno: `void` — não devolve valor.

Guia contextual de Router

name() public

Assinatura completa: public function name(string $name): static;

Descrição: Atribui nome à rota atual.

// $instance é uma instância inicializada de \Framework\Http\Router; argumentos seguem a assinatura acima.
$result = $instance->name($name);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Router

route() public

Assinatura completa: public function route(string $name, array $params = []): string;

Descrição: Registra definição de rota no Router.

// $instance é uma instância inicializada de \Framework\Http\Router; argumentos seguem a assinatura acima.
$result = $instance->route($name);

Retorno: string — texto/identificador de registra definição de rota no Router.

Guia contextual de Router

dispatch() public

Assinatura completa: public function dispatch(): void;

Descrição: Encontra e despacha a rota correspondente.

// $instance é uma instância inicializada de \Framework\Http\Router; argumentos seguem a assinatura acima.
$instance->dispatch();

Retorno: `void` — não devolve valor.

Guia contextual de Router

addRoute() protected

Assinatura completa: protected function addRoute(string $method, string $path, array|string $action, array $middlewares = []): static;

Descrição: Adiciona ou registra route.

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Router

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

matchUri() protected

Assinatura completa: protected function matchUri(string $pattern, string $uri, array $paramNames): array|false;

Descrição: Compara método/caminho com rotas registradas.

Retorno: array|false — valor do tipo array|false referente a compara método/caminho com rotas registradas.

Guia contextual de Router

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

callAction() protected

Assinatura completa: protected function callAction(array $action, array $params): void;

Descrição: Resolve Controller/action e passa parâmetros capturados.

Retorno: `void` — não devolve valor.

Guia contextual de Router

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

castParam() protected

Assinatura completa: protected function castParam(string $value, \ReflectionParameter $param): mixed;

Descrição: Converte parâmetro de rota pelo tipo da action quando possível.

Retorno: mixed — valor produzido/lido por converte parâmetro de rota pelo tipo da action quando possível. Como o tipo declarado é mixed, verifique o valor concreto antes de tratar como escalar, array ou objeto.

Guia contextual de Router

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

runMiddleware() protected

Assinatura completa: protected function runMiddleware(string $middleware, Request $request): void;

Descrição: Executa cadeia de middleware antes da action.

Retorno: `void` — não devolve valor.

Guia contextual de Router

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

handleNotFound() protected

Assinatura completa: protected function handleNotFound(): void;

Descrição: Emite tratamento de rota inexistente.

Retorno: `void` — não devolve valor.

Guia contextual de Router

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

handleMethodNotAllowed() protected

Assinatura completa: protected function handleMethodNotAllowed(array $allowedMethods): void;

Descrição: Emite tratamento de método não permitido.

Retorno: `void` — não devolve valor.

Guia contextual de Router

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

handleServerError() protected

Assinatura completa: protected function handleServerError(\Throwable $e): void;

Descrição: Trata exceção durante dispatch.

Retorno: `void` — não devolve valor.

Guia contextual de Router

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

getRoutes() public

Assinatura completa: public function getRoutes(): array;

Descrição: Retorna routes.

// $instance é uma instância inicializada de \Framework\Http\Router; argumentos seguem a assinatura acima.
$result = $instance->getRoutes();

Retorno: array — lista/estrutura retornada pelo método para retorna routes. As chaves e o formato são os definidos pela implementação indicada na descrição.

Guia contextual de Router

setControllerNamespace() public

Assinatura completa: public function setControllerNamespace(string $ns): void;

Descrição: Define ou configura controller namespace.

// $instance é uma instância inicializada de \Framework\Http\Router; argumentos seguem a assinatura acima.
$instance->setControllerNamespace($ns);

Retorno: `void` — não devolve valor.

Guia contextual de Router

all() public

Assinatura completa: public function all(): array;

Descrição: Busca os registros do Repository.

// $instance é uma instância inicializada de \Framework\Interfaces\RepositoryInterface; argumentos seguem a assinatura acima.
$result = $instance->all();

Retorno: array — lista/estrutura retornada pelo método para busca os registros do Repository. As chaves e o formato são os definidos pela implementação indicada na descrição.

findById() public

Assinatura completa: public function findById(int $id): object|false;

Descrição: Busca pelo ID.

// $instance é uma instância inicializada de \Framework\Interfaces\RepositoryInterface; argumentos seguem a assinatura acima.
$result = $instance->findById($id);

Retorno: object|false — objeto correspondente à operação de consulta descrita (busca pelo ID) quando há resultado; false quando não há registro/objeto válido.

create() public

Assinatura completa: public function create(array $data): string|false;

Descrição: Cria registro.

// $instance é uma instância inicializada de \Framework\Interfaces\RepositoryInterface; argumentos seguem a assinatura acima.
$result = $instance->create($data);

Retorno: string|false — ID/identificador produzido como string quando a criação descrita (cria registro) resulta em registro; false quando a implementação não produz ID. Erros de banco podem ser exceções.

update() public

Assinatura completa: public function update(int $id, array $data): bool;

Descrição: Atualiza registro pelo ID.

// $instance é uma instância inicializada de \Framework\Interfaces\RepositoryInterface; argumentos seguem a assinatura acima.
$result = $instance->update($id, $data);

Retorno: bool — true quando a operação descrita (atualiza registro pelo ID) é concluída; false quando não é confirmada. O bool não carrega mensagem de erro nem contagem de linhas.

delete() public

Assinatura completa: public function delete(int $id): bool;

Descrição: Exclui registro pelo ID.

// $instance é uma instância inicializada de \Framework\Interfaces\RepositoryInterface; argumentos seguem a assinatura acima.
$result = $instance->delete($id);

Retorno: bool — indica o resultado da operação descrita (exclui registro pelo ID); true confirma o resultado e false indica que não foi confirmado, sem mensagem de erro.

debug() public

Assinatura completa: public static function debug(string $msg, array $ctx = []): void;

Descrição: Registra mensagem de nível DEBUG.

\Framework\Support\Logger::debug($msg);

Retorno: `void` — não devolve valor.

Guia contextual de Logger

info() public

Assinatura completa: public static function info(string $msg, array $ctx = []): void;

Descrição: Registra mensagem de nível INFO.

\Framework\Support\Logger::info($msg);

Retorno: `void` — não devolve valor.

Guia contextual de Logger

warning() public

Assinatura completa: public static function warning(string $msg, array $ctx = []): void;

Descrição: Registra mensagem de nível WARNING.

\Framework\Support\Logger::warning($msg);

Retorno: `void` — não devolve valor.

Guia contextual de Logger

error() public

Assinatura completa: public static function error(string $msg, array $ctx = []): void;

Descrição: Registra mensagem de nível ERROR.

\Framework\Support\Logger::error($msg);

Retorno: `void` — não devolve valor.

Guia contextual de Logger

critical() public

Assinatura completa: public static function critical(string $msg, array $ctx = []): void;

Descrição: Registra mensagem de nível CRITICAL.

\Framework\Support\Logger::critical($msg);

Retorno: `void` — não devolve valor.

Guia contextual de Logger

request() public

Assinatura completa: public static function request(string $level, string $message, array $context = []): void;

Descrição: Registra a requisição no arquivo de log.

\Framework\Support\Logger::request($level, $message);

Retorno: `void` — não devolve valor.

Guia contextual de Logger

log() public

Assinatura completa: public static function log(string $level, string $message, array $context = []): void;

Descrição: Registra mensagem no nível informado; em CLI também imprime no terminal.

\Framework\Support\Logger::log($level, $message);

Retorno: `void` — não devolve valor.

Guia contextual de Logger

normalizeContextValue() protected

Assinatura completa: protected static function normalizeContextValue(mixed $v): mixed;

Descrição: Valida ou normaliza context value.

Retorno: mixed — valor produzido/lido por valida ou normaliza context value. Como o tipo declarado é mixed, verifique o valor concreto antes de tratar como escalar, array ou objeto.

Guia contextual de Logger

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

writeToFile() protected

Assinatura completa: protected static function writeToFile( string $level, string $message, array $context, string $filePrefix = 'app' ): void;

Descrição: Atualiza ou grava to file.

Retorno: `void` — não devolve valor.

Guia contextual de Logger

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

writeToTerminal() protected

Assinatura completa: protected static function writeToTerminal(string $level, string $message, array $context): void;

Descrição: Atualiza ou grava to terminal.

Retorno: `void` — não devolve valor.

Guia contextual de Logger

Ponto de extensão protegido: chame ou sobrescreva somente dentro de uma subclasse autorizada; não faz parte da API pública de aplicação.

setMinLevel() public

Assinatura completa: public static function setMinLevel(string $level): void;

Descrição: Define ou configura min level.

\Framework\Support\Logger::setMinLevel($level);

Retorno: `void` — não devolve valor.

Guia contextual de Logger

start() public

Assinatura completa: public static function start(): void;

Descrição: Inicia sessão e define opções de cookie do framework.

\Framework\Support\Session::start();

Retorno: `void` — não devolve valor.

Guia contextual de Session

shouldUseSecureCookies() public

Assinatura completa: public static function shouldUseSecureCookies(string $env): bool;

Descrição: Determina flag Secure para cookie.

$result = \Framework\Support\Session::shouldUseSecureCookies($env);

Retorno: bool — indica o resultado da operação descrita (determina flag Secure para cookie); true confirma o resultado e false indica que não foi confirmado, sem mensagem de erro.

Guia contextual de Session

set() public

Assinatura completa: public static function set(string $key, mixed $value): void;

Descrição: Armazena valor na sessão.

\Framework\Support\Session::set($key, $value);

Retorno: `void` — não devolve valor.

Guia contextual de Session

get() public

Assinatura completa: public static function get(string $key, mixed $default = null): mixed;

Descrição: Lê valor com fallback.

$result = \Framework\Support\Session::get($key);

Retorno: mixed — valor produzido/lido por lê valor com fallback. Como o tipo declarado é mixed, verifique o valor concreto antes de tratar como escalar, array ou objeto.

Guia contextual de Session

has() public

Assinatura completa: public static function has(string $key): bool;

Descrição: Verifica presença de chave.

$result = \Framework\Support\Session::has($key);

Retorno: bool — true quando presença de chave; false quando a condição não se confirma.

Guia contextual de Session

forget() public

Assinatura completa: public static function forget(string $key): void;

Descrição: Remove chave.

\Framework\Support\Session::forget($key);

Retorno: `void` — não devolve valor.

Guia contextual de Session

all() public

Assinatura completa: public static function all(): array;

Descrição: Retorna dados da sessão.

$result = \Framework\Support\Session::all();

Retorno: array — lista/estrutura retornada pelo método para retorna dados da sessão. As chaves e o formato são os definidos pela implementação indicada na descrição.

Guia contextual de Session

destroy() public

Assinatura completa: public static function destroy(): void;

Descrição: Encerra e limpa sessão.

\Framework\Support\Session::destroy();

Retorno: `void` — não devolve valor.

Guia contextual de Session

flash() public

Assinatura completa: public static function flash(string $key, string $message): void;

Descrição: Armazena dado temporário para a próxima navegação.

\Framework\Support\Session::flash($key, $message);

Retorno: `void` — não devolve valor.

Guia contextual de Session

getFlash() public

Assinatura completa: public static function getFlash(string $key): ?string;

Descrição: Lê e consome flash.

$result = \Framework\Support\Session::getFlash($key);

Retorno: `?string` — valor opcional; pode ser `null`.

Guia contextual de Session

hasFlash() public

Assinatura completa: public static function hasFlash(string $key): bool;

Descrição: Verifica flash sem consumi-lo.

$result = \Framework\Support\Session::hasFlash($key);

Retorno: bool — true quando flash sem consumi-lo; false quando a condição não se confirma.

Guia contextual de Session

flashInput() public

Assinatura completa: public static function flashInput(array $data): void;

Descrição: Armazena dados anteriores do formulário.

\Framework\Support\Session::flashInput($data);

Retorno: `void` — não devolve valor.

Guia contextual de Session

flashErrors() public

Assinatura completa: public static function flashErrors(array $errors): void;

Descrição: Armazena erros em flash.

\Framework\Support\Session::flashErrors($errors);

Retorno: `void` — não devolve valor.

Guia contextual de Session

oldInput() public

Assinatura completa: public static function oldInput(string $key, mixed $default = ''): mixed;

Descrição: Retorna dado antigo.

$result = \Framework\Support\Session::oldInput($key);

Retorno: mixed — valor produzido/lido por retorna dado antigo. Como o tipo declarado é mixed, verifique o valor concreto antes de tratar como escalar, array ou objeto.

Guia contextual de Session

ageOldInput() public

Assinatura completa: public static function ageOldInput(): void;

Descrição: Atualiza ciclo de vida do old input.

\Framework\Support\Session::ageOldInput();

Retorno: `void` — não devolve valor.

Guia contextual de Session

forgetOldInput() public

Assinatura completa: public static function forgetOldInput(): void;

Descrição: Remove old input.

\Framework\Support\Session::forgetOldInput();

Retorno: `void` — não devolve valor.

Guia contextual de Session

csrfToken() public

Assinatura completa: public static function csrfToken(): string;

Descrição: Obtém token CSRF, criando-o se necessário.

$result = \Framework\Support\Session::csrfToken();

Retorno: string — texto/identificador de obtém token CSRF, criando-o se necessário.

Guia contextual de Session

validateCsrf() public

Assinatura completa: public static function validateCsrf(string $token): bool;

Descrição: Compara token enviado com token de sessão.

$result = \Framework\Support\Session::validateCsrf($token);

Retorno: bool — indica o resultado da operação descrita (compara token enviado com token de sessão); true confirma o resultado e false indica que não foi confirmado, sem mensagem de erro.

Guia contextual de Session

regenerateCsrf() public

Assinatura completa: public static function regenerateCsrf(): void;

Descrição: Gera/substitui token CSRF.

\Framework\Support\Session::regenerateCsrf();

Retorno: `void` — não devolve valor.

Guia contextual de Session

generateToken() public

Assinatura completa: public static function generateToken(int $bytes = 32): string;

Descrição: Gera token aleatório hexadecimal pelo número de bytes.

$result = \Framework\Support\Session::generateToken();

Retorno: string — texto/identificador de gera token aleatório hexadecimal pelo número de bytes.

Guia contextual de Session

__construct() public

Assinatura completa: public function __construct(array $file);

Descrição: Cria a instância a partir da estrutura de arquivo recebida.

$instance = new \Framework\Support\Upload($file);

Retorno: Não declarado explicitamente na assinatura.

Guia contextual de Upload

setAllowedTypes() public

Assinatura completa: public function setAllowedTypes(array $mimeTypes): static;

Descrição: Define ou configura allowed types.

// $instance é uma instância inicializada de \Framework\Support\Upload; argumentos seguem a assinatura acima.
$result = $instance->setAllowedTypes($mimeTypes);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Upload

setAllowedExtensions() public

Assinatura completa: public function setAllowedExtensions(array $exts): static;

Descrição: Define extensões permitidas.

// $instance é uma instância inicializada de \Framework\Support\Upload; argumentos seguem a assinatura acima.
$result = $instance->setAllowedExtensions($exts);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Upload

setMaxSize() public

Assinatura completa: public function setMaxSize(int $bytes): static;

Descrição: Define o limite máximo do arquivo.

// $instance é uma instância inicializada de \Framework\Support\Upload; argumentos seguem a assinatura acima.
$result = $instance->setMaxSize($bytes);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Upload

setUploadDir() public

Assinatura completa: public function setUploadDir(string $dir): static;

Descrição: Define ou configura upload dir.

// $instance é uma instância inicializada de \Framework\Support\Upload; argumentos seguem a assinatura acima.
$result = $instance->setUploadDir($dir);

Retorno: `static` — valor do tipo declarado na assinatura.

Guia contextual de Upload

setRandomName() public

Assinatura completa: public function setRandomName(bool $random): static;

Descrição: Ativa/desativa nome aleatório.