multidimensional/cakephpbb

Add on CakePHP authentication to connect with an external phpBB forum.

0.0.1 2019-01-24 05:27 UTC

Requires

• php: >=5.5.9
• cakephp/cakephp: ^3.3

Requires (Dev)

• cakephp/cakephp-codesniffer: *
• phpunit/phpunit: ^4.8|^5.6|^6.0

MIT

• multidimension.al

• Authentication
• cakephp
• cakephp3

README

A CakePHP plugin that uses phpBB to authenticate.

Requirements

• CakePHP 3.3+
• PHP 5.5.9+

Installation

You can install this plugin into your CakePHP application using composer.

The recommended way to install composer packages is:

composer require --prefer-dist multidimensional/cakephpbb

Setup

Load the plugin by running following command in terminal:

bin/cake plugin load Multidimensional/Cakephpbb -b

Or by manually adding following line to your app's config/bootstrap.php:

Plugin::load('Multidimensional/Cakephpbb', ['bootstrap' => true]);

Configuration

Run the installation script command in termainal:

bin/cake CakephpbbInstall

If the above command doesn't work, you can also try:

bin/cake multidimensional/cakephpbb.cakephpbb_install

If you do not have access to terminal, you can manually copy and edit the phpbb.php config file and move it into your default config folder.

Usage

Add this in your App

// In a controller
public function initialize()
{
    parent::initialize();
    $this->loadComponent('Auth', [
        'authenticate' => ['Multidimensional/Cakephpbb.Phpbb']]);
}

License

The MIT License (MIT)

Copyright (c) 2019 multidimension.al

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.