frozennode/social

This package is not installable via Composer 1.x, please make sure you upgrade to Composer 2+. Read more about our Composer 1.x deprecation policy.

Social is a HybridAuth implementation for Laravel

dev-master 2014-01-29 22:25 UTC

This package is not auto-updated.

Last update: 2021-10-25 02:03:44 UTC


README

Requirements

  • Laravel 4
  • Database setup for migrations
  • A "User" model (you can set a different name in configuration)
  • You have read the notes on configuration before you dive in :)

Installation

  1. Add the dependency to your composer.json file: "frozennode/social": "*"

  2. Run php composer.phar install

  3. Add 'Frozennode\Social\SocialServiceProvider', to your config/app.php file

  4. Publish the package config php artisan config:publish frozennode/social

  5. Add your service credentials to app/config/packages/frozennode/social/hybridauth.php

  6. Check the app/config/packages/frozennode/social/db.php file to see if you need to customise anything (see Configuration below for help)

  7. Run the migration php artisan migrate --package='frozennode/social'

  8. Create the Profile model (using a different name if you changed the config)

  9. Set the User to have many Profiles:

        public function profiles() {
            return $this->hasMany('Profile');
        }
    
  10. Set the Profile to belong to a User:

        public function user() {
            return $this->belongsTo('User');
        }
    

Configuration

This package comes with several configuration files, and you must edit at least one of them.

Before you can run this package, you need to publish the config files to your own app - which you can easily do using artisan:

artisan config:publish frozennode/social

You will then find the configuration files in your app/config/packages directory.

hybridauth.php

Be sure to put in all your service credentials (app id and app secret that you got from Facebook, LinkedIn, etc).

This is almost the exact set of configuration used by the HybridAuth library itself, so see their documentation for more information.

db.php

This file specifies everything related to your database and models. This package expects you to have a users table, and it will create a profiles table for you with the migration.

Note that you should edit this file BEFORE YOU RUN THE MIGRATION, since the migration itself reads this config.

Hopefully most of the values in this file are self explanatory, the exceptions being the "profiletousermap", "userrules" and "uservalues" keys.

profilestousersmap

This is used when a new user is created from a social login. It is a reasonably common case that you will have some properties on User that are mapped to Profiles, but you may want to keep them directly in the User model to make your life easier when > dealing with users who were not registered using this method.

Specifying this will map fields from the Profile to the newly > created User.

Keys are attribute names from the Profile (which mirrors the original HybridAuth Adapter) and values are attribute names on the User model.

userrules

If you are using Ardent to automatically validate models (and stop them from being saved if validation fails) you may want to specify a set of override rules here when creating new Users.

uservalues

This is similar to the profiletousermap, but much more flexible. You can specify specific values for certain attributes on new Users (i.e. a "role_id" for all "customers"), or even provide a callback to run - the callback will be passed in the new (unsaved) user and the original HybridAuth Adapter profile of values.

Routes

See the routes.php config file to alter the default routes