PHP Интерфейс FOS\UserBundle\Model\UserManagerInterface

All changes to users should happen through this interface. The class also contains ACL annotations which will only work if you have the SecurityExtraBundle installed, otherwise they will simply be ignored.
Автор: Gordon Franke ([email protected])
Автор: Thibault Duplessis ([email protected])
Автор: Johannes M. Schmitt ([email protected])
Показать файл Открыть проект Примеры использования интерфейса

Открытые методы

Метод Описание
createUser ( ) : User Creates an empty user instance
deleteUser ( FOS\UserBundle\Model\UserInterface $user ) : void Deletes a user
findUserBy ( array $criteria ) : User Finds one user by the given criteria
findUserByConfirmationToken ( string $token ) : User Find a user by its confirmationToken
findUserByEmail ( string $email ) : User Find a user by its email
findUserByUsername ( string $username ) : User Find a user by its username
findUserByUsernameOrEmail ( string $usernameOrEmail ) : User Find a user by its username or email
findUsers ( ) : Traversable Returns a collection with all user instances
getClass ( ) : string Returns the user's fully qualified class name
updateCanonicalFields ( FOS\UserBundle\Model\UserInterface $user ) : void Updates the canonical username and email fields for a user
updatePassword ( FOS\UserBundle\Model\UserInterface $user ) : void Updates a user password if a plain password is set
updateUser ( FOS\UserBundle\Model\UserInterface $user ) : void Updates a user
validateUnique ( FOS\UserBundle\Model\UserInterface $value, Constraint $constraint ) : boolean Checks the uniqueness of the given fields, returns true if its unique

Описание методов

createUser() публичный Метод

Creates an empty user instance
public createUser ( ) : User
Результат User

deleteUser() публичный Метод

Deletes a user
public deleteUser ( FOS\UserBundle\Model\UserInterface $user ) : void
$user FOS\UserBundle\Model\UserInterface
Результат void

findUserBy() публичный Метод

Finds one user by the given criteria
public findUserBy ( array $criteria ) : User
$criteria array
Результат User

findUserByConfirmationToken() публичный Метод

Find a user by its confirmationToken
public findUserByConfirmationToken ( string $token ) : User
$token string
Результат User or null if user does not exist

findUserByEmail() публичный Метод

Find a user by its email
public findUserByEmail ( string $email ) : User
$email string
Результат User or null if user does not exist

findUserByUsername() публичный Метод

Find a user by its username
public findUserByUsername ( string $username ) : User
$username string
Результат User or null if user does not exist

findUserByUsernameOrEmail() публичный Метод

Find a user by its username or email
public findUserByUsernameOrEmail ( string $usernameOrEmail ) : User
$usernameOrEmail string
Результат User or null if user does not exist

findUsers() публичный Метод

Returns a collection with all user instances
public findUsers ( ) : Traversable
Результат Traversable

getClass() публичный Метод

Returns the user's fully qualified class name
public getClass ( ) : string
Результат string

updateCanonicalFields() публичный Метод

Updates the canonical username and email fields for a user
public updateCanonicalFields ( FOS\UserBundle\Model\UserInterface $user ) : void
$user FOS\UserBundle\Model\UserInterface
Результат void

updatePassword() публичный Метод

Updates a user password if a plain password is set
public updatePassword ( FOS\UserBundle\Model\UserInterface $user ) : void
$user FOS\UserBundle\Model\UserInterface
Результат void

updateUser() публичный Метод

Updates a user
public updateUser ( FOS\UserBundle\Model\UserInterface $user ) : void
$user FOS\UserBundle\Model\UserInterface
Результат void

validateUnique() публичный Метод

Checks the uniqueness of the given fields, returns true if its unique
public validateUnique ( FOS\UserBundle\Model\UserInterface $value, Constraint $constraint ) : boolean
$value FOS\UserBundle\Model\UserInterface
$constraint Symfony\Component\Validator\Constraint
Результат boolean