Code Monkey home page Code Monkey logo

shorturl's Introduction

🔗ShortURL

💬 Sobre o projeto

Encurtador de URL feito em PHP com armazenando em SQL e JSON com contabilização de acessos.

Author - Julimar Junior

🚀 Atualizações

Acompanhe as atualizações que ocorreram anteriormente no shortURL.

Data Versão Descrição
24/03/2021 2.0 Desenvolvimento do sistema com uso de classe e fácil configuração
22/02/2021 1.2 Dados de URL e Ambiente de Testes
22/02/2021 1.1 Ajustes de retornos
20/02/2021 1.0 Base do projeto

👨‍💻 Instalação

Veja a pasta example no repositório para obter uma aplicação feita utilizando o shortURL já configurada.

  1. Adicione o arquivo shortURL.php em seu projeto, junto ao arquivo .htaccess em uma pasta exclusiva para o encurtador de URL

É necessário o uso do .htaccess para um funcionamento correto no redirecionamento ao abrir uma URL encurtada.

  1. Inclua o arquivo em um index.php na pasta exclusiva e inicie a classe shortURL.

É recomendável utilizar o arquivo index.php para realizar o redirecionamento da URL encurtada. Para cria-la é necessário utilizar outro arquivo ou função separada.

require_once('shortURL.php');
$short = new shortURL;
  1. Configure os itens necessários utilizando as funções da classe para o funcionamento do sistema conforme descrito em 🧰 Configurações.

🧰 Configurações

Base

// Define o tipo de conexão | padrão: json;
$short->type('mysql');

Se o sistema for para alto uso, é recomendável que se utilize o type == 'mysql' para melhor performance.

// Define os bytes de criação da URL personalizada - Padrão: 3;
$short->bytes(5);
// Define os dados de conexão MYSQL | Obrigatório se type == 'mysql';
$db = array(
	'drive' 	=> 'mysql',
	'host' 		=> 'localhost',
	'name' 		=> 'db_shorturl',
	'user' 		=> 'root',
	'password' 	=> 'root',
);
$short->database($db);

O SQL de criação do banco de dados pode ser encontrado em db_shorturl.sql no repositório.

Criação

// Define URL a ser encurtada;
$short->url('https://julimarjunior.com.br');
// Define a URL encurtada personalizada | Opcional;
$short->custom('shortURL');
// Se não informado, será um valor aleatório baseado nos bytes;
// Cria a URL encurtada;
$short->execute();

Uso

// Limpa a URL completa;
$short->clear('https://julimarjunior.com.br/shorturl');
// Retorna apenas o valor 'shorturl' para uso em outras funções
// Exemplo com URL atual: $short->clear($_SERVER["REQUEST_URI"]);
// Obtém as informações da URL encurtada;
$short->infos('shorturl');
// Retorna a URL encurtada, URL origem, data de criação e quantidade de acessos;
// Exemplo de uso com clear(): $short->infos($short->clear($_SERVER["REQUEST_URI"]));
// Define se ocorrerá o redirect automático | Padrão: false;
$short->redirect(true);
// Se for False, irá retornar a URL origem quando open() for executado;
// Abre a URL origem a partir da URL encurtada;
$short->open('shorturl');
// Se for redirect == false, irá retornar a URL origem;
// Exemplo de uso com clear(): $short->open($short->clear($_SERVER["REQUEST_URI"]));

👋 Por fim (mas não menos importante)

O projeto shortURL é um repositório de código livre, qualquer um pode (caso deseje) fazer atualizações para seus respectivos sistemas e utiliza-lo.

shorturl's People

Contributors

jjr-dev avatar

Stargazers

Pedro Augusto Bellas Peres  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.