ctl/socialmapfavorites

Basic Packaging for Favoriting and Unfavoriting users

Social Map Favorites

, _(*1)

A PHP Package for Favoriting and Unfavoriting Authenticated Users, _(*2)

Currently only supported for Laravel 5.2, _(*3)

Install

Via Composer, _(*4)

``` bash $ composer require ctl/socialmapfavorites, <sub>(*5)</sub>

## Installation


``` bash
$ php artisan vendor:publish

Add the service provider to the 'providers' array in config/app.php, <sub>(*6)</sub>

``` php CTL\SocialMapFavorites\SocialMapFavoritesServiceProvider::class,, <sub>(*7)</sub>

Navigate to `App/Jobs/FavAUser`. Replace `use CTL\SocialMapFavorites\Jobs\Job;` with `use App\Jobs\Job;`

Repeat above with `unFavAUser`

Navigage to `App\Users`. Add `ActionableTrait` like so....

``` php
<?php

namespace App;

use Core\Users\ActionableTrait;
use Illuminate\Auth\Authenticatable;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Auth\Passwords\CanResetPassword;
use Illuminate\Foundation\Auth\Access\Authorizable;
use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
use Illuminate\Contracts\Auth\Access\Authorizable as AuthorizableContract;
use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;

class User extends Model implements AuthenticatableContract,
                                    AuthorizableContract,
                                    CanResetPasswordContract
{
    use Authenticatable, Authorizable, CanResetPassword, ActionableTrait;

    /**
     * The database table used by the model.

Add "Core\\": "Core/" to your project composer.json. It should look like this..., <sub>(*8)</sub>

``` json "psr-4": { "App\": "app/", "Core\": "Core/" }, <sub>(*9)</sub>

run `composer dump-autoload` if changes does not take effect.

*Change the `namespace` of `Core\Users\ActionableTrait` and `Core\Users\UsersOrigin`*

Finally, run....
``` bash
$ php artisan make:migration CreateFavoritesTable

To create a favs table, <sub>(*10)</sub>

Your Migration should look like, <sub>(*11)</sub>

``` php <?php, <sub>(*12)</sub>

use Illuminate\Database\Schema\Blueprint; use Illuminate\Database\Migrations\Migration;, <sub>(*13)</sub>

class CreateFavoritesTable extends Migration { /** * Run the migrations. * * @return void */ public function up() { Schema::create('favs', function(Blueprint $table){ $table->increments('id'); $table->integer('favoritee_id')->index(); $table->integer('favorited_id')->index(); $table->timestamps(); }); }, <sub>(*14)</sub>

/**
 * Reverse the migrations.
 *
 * @return void
 */
public function down()
{
    Schema::table('favs', function(Blueprint $table){
        Schema::drop('favs');
    });
}

}, <sub>(*15)</sub>

### Extended Installation

Within blade files..

``` php
    @if (!$VariableName->checkFavorited() )



          {!! Form::open(['action'=>'ControllerName@store']) !!}
          {!! Form::hidden('userIDToFav', $VariableName->id) !!}

            Add Fav
          {!! Form::close() !!}
        


    @else
        {!! Form::open(['method' => 'DELETE', 'action' => ['ControllerName@destroy', $VariableName->id] ]) !!}
        {!! Form::hidden('userIDToUnFav', $VariableName->id) !!}
      <div class="btn-group">
        <button type="submit" class="btn btn-primary"><span>Favorited</span></button>
        {!! Form::close() !!}
      </div>
    @endif

Within your controller, <sub>(*16)</sub>

``` php, <sub>(*17)</sub>

/**
 * Favorite A User
 *
 */
public function store(Request $request){
  $base = $request->input('userIDToFav');
  $this->dispatch(new FavAUser(\Auth::id(), $base));

  return back();
}

/**
 * UnFavorite a user
 *
 */
public function destroy(Request $request){
  $base = $request->input('userIDToUnFav');
  $this->dispatch(new UnFavAUser(\Auth::id(), $base));

  return back();
}

## For Email Usage


Within the controller

``` php

    /**
     * Fav A User
     *
     * @return Response
     */
    public function store(User $user, Request $request)
    {
        $base = array_add($request, 'userID', Auth::id() );
        $clear = $this->dispatchFrom(FavAUserCommand::class, $base);

        // For emailing User Fav
        $findingUserObject = $user->find($request->input('userIDToFav'));
        $this->mail->sendFavAUserNotificationEmail($findingUser, $request->input('userFaved'), Auth::user()->username);


        session()->flash('success_message','You are now following');
        return back();
    }

For $this->mail->sendFavAUserNotificationEmail();, <sub>(*18)</sub>

You would need to, <sub>(*19)</sub>

``` php, <sub>(*20)</sub>

protected $mail;
protected $usersOrigin;


/**
* Class Constructor
*/
public function __construct(UsersOrigin $usersOrigin, FavAUserMail $mail){

  $this->mail = $mail;
  $this->usersOrigin = $usersOrigin;
}

Dont forget to add `use Core\Users\Mail\FavAUserMail;
` and `use Core\Users\UsersOrigin;
` at the top of your controller class.


## Testing

``` bash
$ phpunit

Contributing

Please see CONTRIBUTING for details., <sub>(*21)</sub>

License

Eclipse Public License (EPL v1.0). Please see License for more information., <sub>(*22)</sub>