Authenticatable.php

TLDR

This file is an interface named Authenticatable in the Illuminate\Contracts\Auth namespace. It defines methods related to user authentication.

Methods

getAuthIdentifierName

This method returns the name of the unique identifier for the user.

getAuthIdentifier

This method returns the unique identifier for the user.

getAuthPasswordName

This method returns the name of the password attribute for the user.

getAuthPassword

This method returns the password for the user.

getRememberToken

This method returns the token value for the "remember me" session.

setRememberToken

This method sets the token value for the "remember me" session.

getRememberTokenName

This method returns the column name for the "remember me" token.

<?php

namespace Illuminate\Contracts\Auth;

interface Authenticatable
{
    /**
     * Get the name of the unique identifier for the user.
     *
     * @return string
     */
    public function getAuthIdentifierName();

    /**
     * Get the unique identifier for the user.
     *
     * @return mixed
     */
    public function getAuthIdentifier();

    /**
     * Get the name of the password attribute for the user.
     *
     * @return string
     */
    public function getAuthPasswordName();

    /**
     * Get the password for the user.
     *
     * @return string
     */
    public function getAuthPassword();

    /**
     * Get the token value for the "remember me" session.
     *
     * @return string
     */
    public function getRememberToken();

    /**
     * Set the token value for the "remember me" session.
     *
     * @param  string  $value
     * @return void
     */
    public function setRememberToken($value);

    /**
     * Get the column name for the "remember me" token.
     *
     * @return string
     */
    public function getRememberTokenName();
}