README

PAGSEGURO PLUGIN

v 2.1.2

Facilita a integração de pagamentos via PagSeguro em aplicações desenvolvidas com base no CakePHP 2.x. O plugin realiza apenas interfaceamento para a API de pagamentos do PagSeguro, com isso nem o plugin nem o PagSeguro podem ser responsabilizados por uso em desconformidade à documentação fornecida pelo PagSeguro https://pagseguro.uol.com.br/v2/guia-de-integracao/visao-geral.html assim como valores fornecidos. A responsabilidade das corretas informações ao PagSeguro são estritamente do programador que criará a requisição no fechamento do carrinho de compras.

INSTALAÇÃO

Composer

{
    "require": {
        "andrebian/pag_seguro": "dev-master"
    }
}

Ou se preferir uma versão em específico:

{
    "require": {
        "andrebian/pag_seguro": "2.0.0"
    }
}

Ainda

{
    "require": {
        "andrebian/pag_seguro": "*"
    }
}

##Erro comum

Por depender da versão de desenvolvimento do PagSeguro pode ser necessário marcar a estabilidade mínima dos pacotes a serem instalados.

{
    "require": {
        "andrebian/pag_seguro": "*"
    },
    "minimum-stability": "dev"
}

##Importantíssimo

Por padrão o CakePHP 2.x utiliza plugins dentro de app/Plugin/ mas ao instalar diretamente pelo composer o mesmo será instalado na raíz de sua aplicação (Plugin/) e não em app/Plugin/. Para contornar isto existem duas saídas, a primeira é definir diretamente através do seu arquivo composer.json e a segunda é informar o novo ponto de acesso à plugins. Ambos serão descritos a seguir.

###Opção 1 - Definindo pelo composer.json

Em seu arquivocomposer.json informe o seguinte:

"extra": {
    "installer-paths": {
        "app/Plugin/PagSeguro": ["andrebian/pag_seguro"]
    }
}

###Opção 2 - Informando no bootstrap.php

É possível informar no bootstrap.php um novo ponto de acesso à plugins, desta forma o Cake 2.x procurará os plugins nos seguintes endereços: Plugin/ a app/Plugin/.

App::build(array('Plugin' => array(ROOT . '/Plugin/', ROOT . '/app/Plugin/')));

Ao seguir esta opção a primeira pode ser ignorada.

Para mais informações sobre estas opções leia este post em meu blog e veja ao final que menciono uma issue do Debug Kit onde o @markstory, @ADmad e @ceeram explicam os motivos e estrutura do Cake e sugerem a opção do bootstrap.php: http://www.andrebian.com/cakephp-e-composer/

##Atenção

Não é mais fornecido suporte para download direto ou utilização como submodulo. Por depender da API oficial do PagSeguro a instalação faz-se de forma correta através do composer. Se quiser fazer desta forma (clone, zip ou submodulo) faça, mas não prestarei suporte pois o único meio que satisfaz todas as dependências é o indicado acima.

CONFIGURAÇÕES

Carregando o plugin

No arquivo bootstrap.php adicione o suporte ao plugin: CakePlugin::load('PagSeguro'); ou CakePlugin::loadAll();

Credenciais

Você deve possuir uma conta no PagSeguro pois precisará setar as credenciais, estas credenciais são compostas pelo seu email e o token que deve ser configurado na seção de integração junto ao PagSeguro.

Tal configuração pode ser feita de duas formas, via bootstrap ou no controller desejado.

Arquivo bootstrap

Configure::write('PagSeguro', array(
    'email' => 'seu-email-cadastrado@pagseguro',
    'token' => 'seu-token',
    'isSandbox' => true, // true|false
));

Controller qualquer onde será montada a finalização da compra

$this->Checkout->defineCredenciais('email cadastrado', 'token gerado');

Carregando o componente

Agora que você já configurou suas credenciais deve definir no AppController ou no controller que o componente será utilizado

public $components = array('PagSeguro.PagSeguro', 'PagSeguro.Checkout', 'PagSeguro.RetornoPagSeguro');

Caso já possua mais componentes faça-o da seguinte forma

public $components = array('Outros componentes', 'PagSeguro.PagSeguro', 'PagSeguro.Checkout', 'PagSeguro.RetornoPagSeguro');

A utilização do 'PagSeguro.PagSeguro' NÃO deve ser ignorada.

UTILIZAÇÃO

• Requisição de pagamento: Leia o arquivo REQUISICAO_PAGAMENTO
• Retorno de requisição de pagamento: Leia o arquivo CONSULTA
• Consulta por código: Leia o arquivo CONSULTA
• Consulta por perído: Leia o arquivo CONSULTA
• Consulta por transações abandonadas: Leia o arquivo CONSULTA
• Notificações: Leia o arquivo NOTIFICACAO

##TODO

• Testes

##PROBLEMAS

Reporte-os por aqui https://github.com/andrebian/cake-plugin-pagseguro/issues?state=open

##CONTRIBUIDORES

• Marcelo Siqueira - https://github.com/marcelosiqueira

##ATENÇÃO Muitos desenvolvedores utilizaram meu email pessoal que estava nos exemplos para realizar compras, peço humildemente que por favor, use SEU email para realizar os testes de compra, já ajudei com o plugin não posso ajudar verificando emails e dando reports.

Muito agradecido.