dyvelop/current-user-bundle

Symfony bundle for fetching the user which is currently logged in

v1.0.0-alpha 2016-09-05 20:13 UTC

Requires

• php: >=5.5
• doctrine/annotations: ~1.2
• doctrine/orm: ~2.5
• symfony/config: ~2.7|~3.0
• symfony/dependency-injection: ~2.7|~3.0
• symfony/security: ~2.7|~3.0

Requires (Dev)

• symfony/phpunit-bridge: ~2.7|~3.0

MIT

• Franziska Dyckhoff

README

Dyvelop Current User Bundle

Symfony bundle to fetch the user which is currently logged in.

Installation

Step 1: Download

Download via Composer

composer require dyvelop/current-user-bundle

Step 2: Enable Bundle

Enable the Bundle in the app/AppKernel.php file in your Symfony project:

// File: app/AppKernel.php
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            new Dyvelop\CurrentUserBundle\DyvelopCurrentUserBundle(),
        );
        
        return $bundles;
    }
}

Usage

Current User Provider

Mainly this bundle implements a service named dyvelop.current_user.provider which provides the current user:

// fetch current user (the result is NULL when no one is logged in)
$user = $this->container->get('dyvelop.current_user.provider')->getUser();

You may use the CurrentUserAware interface and CurrentUserTrait helper to inject it into any other service.

Doctrine Annotation

Secondly, this bundle provides a Doctrine Annotation and Driver to inject the Current User into an entity via lifecycle callbacks:

<?php

namespace AppBundle\Entity;

use Doctrine\ORM\Mapping as ORM;
use Dyvelop\CurrentUserBundle\Annotation as Dyvelop;

class Article
{
    /**
     * @ORM\ManyToOne(targetEntity="User")
     * @ORM\JoinColumn(name="author_id", referencedColumnName="id", nullable=true)
     * @Dyvelop\CurrentUser(prePersist=true)
     */
    protected $author;
}

In this example the current user will be set automatically as author of an article before persisting it to the database.

Currently, only the prePersist and preUpdate lifecycle callbacks are implemented. Feel free to contribute some more ;)