Laravel Traits

Next up in the series on useful Laravel model traits is the UserTimezoneAware Trait.

This trait is useful when you have dates on models that you need to display in the user’s timezone.

// app\Traits\UserTimezoneAware.php
namespace App\Traits;

trait UserTimezoneAware
{
    
    /**
     * The attribute name containing the timezone (defaults to "timezone").
     *
     * @var string
     */
    public $timezoneAttribute = 'timezone';
    
    /**
     * Return the passed date in the user's timezone (or default to the app timezone)
     *
     * @return string
     */
    public function getDateToUserTimezone($date, $timezone = null)
    {
        if ($timezone == null) {
            if (Auth::check()) {
                $timezone = Auth::user()->timezone;
            } else {
                $timezone = Config::get('app.timezone');
            }
        }
        $datetime = new DateTime($date);
        $datetime->setTimezone(new datetimezone($timezone));
        return $datetime->format('c');
    }

}

// app\Traits\UserTimezoneAware.php

namespace App\Traits;

trait UserTimezoneAware

{

/**

* The attribute name containing the timezone (defaults to "timezone").

* @var string

public $timezoneAttribute = 'timezone';

/**

* Return the passed date in the user's timezone (or default to the app timezone)

* @return string

public function getDateToUserTimezone($date, $timezone = null)

{

if ($timezone == null) {

if (Auth::check()) {

$timezone = Auth::user()->timezone;

} else {

$timezone = Config::get('app.timezone');

}

$datetime = new DateTime($date);

$datetime->setTimezone(new datetimezone($timezone));

return $datetime->format('c');

}

It’s a simple trait you can drop onto one of your eloquent models to add timezone support like so:

// app\Models\User.php
namespace App\Models;

use App\Traits\UserTimezoneAware

class User
{
    use UserTimezoneAware;

    public function getLastLoginAttribute()
    {
        return $this->getDateToUserTimezone($this->attributes['last_login']);
    }
}

// app\Models\User.php

namespace App\Models;

use App\Traits\UserTimezoneAware

class User

{

use UserTimezoneAware;

public function getLastLoginAttribute()

{

return $this->getDateToUserTimezone($this->attributes['last_login']);

}

Now when you access the $user->lastLogin attribute anywhere in your app, you’ll get the date in the user’s timezone.

The UserTimezoneAware trait expects the model to have a timezone attribute. If your column/attribute is named something other than timezone simply override the $timezoneAttribute property on the UserTimezoneAware trait.

namespace App\Models;

use App\Traits\UserTimezoneAware
 
class User
{
    use UserTimezoneAware;

    public $timezoneAttribute= 'time_zone';
}

namespace App\Models;

use App\Traits\UserTimezoneAware

class User

{

use UserTimezoneAware;

public $timezoneAttribute= 'time_zone';

}

Enjoy!

Starting a little series here on useful Laravel model traits.

This first one I use quite often.

// app\Traits\HasGravatar.php
namespace App\Traits;

trait HasGravatar
{
    
    /**
     * The attribute name containing the email address.
     *
     * @var string
     */
    public $gravatarEmail = 'email';
    
    /**
     * Get the model's gravatar
     *
     * @return string
     */
    public function getGravatarAttribute()
    {
        $hash = md5(strtolower(trim($this->attributes[$this->gravatarEmail])));
        return "https://www.gravatar.com/avatar/$hash";
    }

}

// app\Traits\HasGravatar.php

namespace App\Traits;

trait HasGravatar

{

/**

* The attribute name containing the email address.

* @var string

public $gravatarEmail = 'email';

/**

* Get the model's gravatar

* @return string

public function getGravatarAttribute()

{

$hash = md5(strtolower(trim($this->attributes[$this->gravatarEmail])));

return "https://www.gravatar.com/avatar/$hash";

}

It’s a simple trait you can drop onto one of your eloquent models to add gravatar support like so:

// app\Models\User.php
namespace App\Models;

use App\Traits\HasGravatar

class User
{
    use HasGravatar;
}

// app\Models\User.php

namespace App\Models;

use App\Traits\HasGravatar

class User

{

use HasGravatar;

}

Now you can do something like this in your blade views:

<img src="{{ Auth::user()->gravatar }}" />

1	<img src="{{ Auth::user()->gravatar }}" />

And you’ll get the gravatar.com URL you’re expecting. No need to create a gravatar column, variable, method, or anything else.

The HasGravatar Trait expects the model to have an email attribute. If your column/attribute is named something other than email simply override the $gravatarEmail property on the HasGravatar trait.

namespace App\Models;

use App\Traits\HasGravatar

class User
{
    use HasGravatar;

    public $gravatarEmail = 'email_address';
}

namespace App\Models;

use App\Traits\HasGravatar

class User

{

use HasGravatar;

public $gravatarEmail = 'email_address';

}

Enjoy!

Adam Anderly

Husband, Father, Developer

Laravel User Timezone Aware Trait

Useful Laravel Model Traits: Gravatar

Share this:

Share this: