NAME

Yukki::Model::User - lookup users

VERSION

version 0.991_003

SYNOPSIS

  my $users = $app->model('User');
  my $user  = $users->find('bob');

  my $login_name = $user->login_name;
  my $password   = $user->password;
  my $name       = $user->name;
  my $email      = $user->email;
  my @groups     = $user->groups->@*;

DESCRIPTION

Read access to the current list of authorized users.

METHODS

set_password

    $users->set_password($user, $cleartext);

Given a password in cleartext, this will hash the password using the application's hasher. The second argument containing the cleartext password is optional. When omitted, the value returned by the password accessor of the $user object will be used instead.

save

    $users->save($user, create_only => 1);

Writes a Yukki::User object to the users database. If the create_only flag is set, the method will fail with an exception when the user already exists.

delete

    $users->delete($user);

Given a Yukki::User, this method deletes the user file for that object.

find

  my $user = $users->find(login_name => $login_name);

Returns a hash containing the information related to a specific user named by login name.

list

    my @names = $users->list;

Returns a list of login names for all users configured.

AUTHOR

Andrew Sterling Hanenkamp <hanenkamp@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2017 by Qubling Software LLC.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.