ice framework documentation ice doc v1.6.2
    
namespace Ice\Auth\Driver\Model\Users;

use Ice\Text;
use Ice\Mvc\Model;
use Ice\Validation;

/**
 * Model user's Tokens.
 *
 * @package     Ice/Auth
 * @category    Model
 * @author      Ice Team
 * @copyright   (c) 2014-2020 Ice Team
 * @license     http://iceframework.org/license
 */
class Tokens extends Model
{
    protected from = "user_tokens";

    /**
     * User class name.
     */
    protected userClass = "Ice\\Auth\\Driver\\Model\\Users";

    /**
     * Initialize token's relations, remove expired tokens.
     *
     * @return void
     */
    public function initialize()
    {
        var auth, expire;

        let auth = this->di->get("auth");

        this->belongsTo("user_id", auth->getOption("users", this->userClass), this->getIdKey(), [
            "alias": "User",
            "foreignKey": true
        ]);

        // Do garbage collection
        if mt_rand(1, 100) === 1 {
            this->deleteExpired();
        }

        let expire = this->get("expires");

        // This object has expired
        if expire > 0 && expire < time() {
            this->delete();
        }
    }

    /**
     * Generate a new unique token and create the token.
     *
     * @param array fields Fields to save or valid fields
     * @param object extra Extra validation
     * @return mixed
     */
    public function create(var fields = [],  extra = null)
    {
        let this->{"token"} = this->generate();

        return parent::create(fields);
    }

    /**
     * Deletes all expired tokens.
     *
     * @return bool status
     */
    public function deleteExpired()
    {
        return this->delete([
            "expires": ["<": time()]
        ]);
    }

    /**
     * Generate a new unique token and update the token.
     *
     * @param array fields Fields to save or valid fields
     * @param object extra Extra validation
     * @return mixed
     */
    public function update(var fields = [],  extra = null)
    {
        let this->{"token"} = this->generate();

        return parent::update(fields);
    }

    /**
     * Generate a new unique token.
     *
     * @return string
     * @uses Text::random()
     */
    protected function generate() -> string
    {
        var token;

        do {
            let token = bin2hex(openssl_random_pseudo_bytes(16));
        } while static::findOne(["token": token]);

        return token;
    }
}