UserFrosting API

AccountControllerTest extends TestCase Uses TestDatabase, RefreshDatabase, withTestUser, withController

Tests AccountController

$initialized		bool
$migrated		bool
setUp()	Setup test database for controller tests	void
tearDown()		void
testControllerConstructor()		AccountController
testRegisterWithNoMasterUser()	N.B.: Must be first test, before any master user is created	mixed
testRegister()	N.B.: Run this register second, as it's easier if no test user is present.	mixed
testRegisterWithNoEmailVerification()		mixed
performActualRegisterTest()		mixed
testcheckUsername()		mixed
testcheckUsernameWithNoData()		mixed
testcheckUsernameWithUsernameNotAvailable()		mixed
testcheckUsernameWithThrottler()		mixed
testdenyResetPassword()		mixed
testdenyResetPasswordWithFailedPasswordReset()		mixed
testdenyResetPasswordWithFailedValidation()		mixed
testforgotPassword()	N.B.: This test is incomplete as it doesn't actually check if repoPasswordReset returns the correct info and the message contains the right content	mixed
testforgotPasswordWithFailedValidation()		mixed
testforgotPasswordWithThrottler()		mixed
testgetModalAccountTos()		mixed
testimageCaptcha()		mixed
testlogin()		mixed
testloginWithEmail()		mixed
testloginWithLoggedInUser()		mixed
testloginWithFailledValidation()		mixed
testloginWithThrottler()		mixed
testloginThrottlerCountsFailedLogins()		mixed
testloginThrottlerDoesntCountSuccessfulLogins()		mixed
testloginWithDisableEmail()		mixed
testlogoutWithLoggedInUser()		mixed
testlogoutWithNoUser()		mixed
testpageForgotPassword()		mixed
testpageRegister()		mixed
testpageRegisterWithDisabledRegistration()		mixed
testpageRegisterWithNoLocales()		mixed
testpageRegisterWithLoggedInUser()		mixed
testpageResendVerification()		mixed
testpageResetPassword()		mixed
testpageSetPassword()		mixed
testpageSettings()		mixed
testpageSettingsWithPartialPermissions()		mixed
actualpageSettings()		mixed
testpageSettingsWithNoPermissions()		mixed
testpageSignIn()		mixed
testpageSignInWithLoggedInUser()		mixed
testProfile()		mixed
testProfileWithPartialPermissions()		mixed
performActualProfileTests()		mixed
testProfileWithNoPermissions()		mixed
testProfileWithFailedValidation()		mixed
testProfileWithInvalidLocale()		mixed
testRegisterWithHoneypot()		mixed
testRegisterWithRegistrationDisabled()		mixed
testRegisterWithLoggedInUser()		mixed
testRegisterWithFailedThrottle()		mixed
testRegisterWithFailedCaptcha()		mixed
testRegisterWithFailedValidation()		mixed
testresendVerification()		mixed
testresendVerificationWithVerifiedUser()		mixed
testresendVerificationWithFailedThrottle()		mixed
testresendVerificationWithFailedValidation()		mixed
testSetPassword()		mixed
testSetPasswordWithNoToken()		mixed
testsetPasswordWithFailedValidation()		mixed
testSettings()		mixed
testSettingsOnlyEmailNoLocale()		mixed
testSettingsWithNoPermissions()		mixed
testSettingsWithFailedValidation()		mixed
testSettingsWithFailedPasswordCheck()		mixed
testSettingsWithEmailInUse()		mixed
testSuggestUsername()		mixed
testVerify()		mixed
testVerifyWithFailedVerification()		mixed
testVerifyWithFailedValidation()		mixed
getController()		AccountController
setupTestDatabase()	Define the test_integration database connection the default one	mixed
refreshDatabase()	Define hooks to migrate the database before and after each test.	mixed
usingInMemoryDatabase()	Determine if an in-memory database is being used.	bool
refreshInMemoryDatabase()	Refresh the in-memory database.	mixed
refreshTestDatabase()	Refresh a conventional test database.	mixed
beginDatabaseTransaction()	Handle database transactions on the specified connections.	mixed
connectionsToTransact()	The database connections that should have transactions.	array
loginUser()		mixed
logoutCurrentUser()	Logout	mixed
createTestUser()	Create a test user with no settings/permissions for a controller test	User
getRandomUserId()	Returns a random user id, exclusing th master id	int
giveUserTestPermission()	Gives a user a new test permission	Permission
giveUserPermission()	Add the test permission to a Role, then the role to the user	Role
getRequest()		Request
getResponse()		Response

$initialized


        protected
        static        bool
        $initialized
         = false

$migrated


        public
        static        bool
        $migrated
         = false

setUp()

Setup test database for controller tests


        public
                                setUp(
                )
        : void

tearDown()


        public
                                tearDown(
                )
        : void

testControllerConstructor()


        public
                                testControllerConstructor(
                )
        : AccountController

Return values

AccountController

testRegisterWithNoMasterUser()

N.B.: Must be first test, before any master user is created


        public
                                testRegisterWithNoMasterUser(
                    
                            $controller :
                AccountController
                            
                )
        : mixed

Parameters

$controller : AccountController

Return values

mixed

testRegister()

N.B.: Run this register second, as it's easier if no test user is present.


        public
                                testRegister(
                )
        : mixed

Return values

mixed

testRegisterWithNoEmailVerification()


        public
                                testRegisterWithNoEmailVerification(
                )
        : mixed

Return values

mixed

performActualRegisterTest()


        protected
                                performActualRegisterTest(
                    
                            $controller :
                AccountController
                            
                )
        : mixed

Parameters

$controller : AccountController

Return values

mixed

testcheckUsername()


        public
                                testcheckUsername(
                    
                            $controller :
                AccountController
                            
                )
        : mixed

Parameters

$controller : AccountController

Return values

mixed

testcheckUsernameWithNoData()


        public
                                testcheckUsernameWithNoData(
                    
                            $controller :
                AccountController
                            
                )
        : mixed

Parameters

$controller : AccountController

Return values

mixed

testcheckUsernameWithUsernameNotAvailable()


        public
                                testcheckUsernameWithUsernameNotAvailable(
                    
                            $controller :
                AccountController
                            
                )
        : mixed

Parameters

$controller : AccountController

Return values

mixed

testcheckUsernameWithThrottler()


        public
                                testcheckUsernameWithThrottler(
                )
        : mixed

Return values

mixed

testdenyResetPassword()


        public
                                testdenyResetPassword(
                )
        : mixed

Return values

mixed

testdenyResetPasswordWithFailedPasswordReset()


        public
                                testdenyResetPasswordWithFailedPasswordReset(
                )
        : mixed

Return values

mixed

testdenyResetPasswordWithFailedValidation()


        public
                                testdenyResetPasswordWithFailedValidation(
                    
                            $controller :
                AccountController
                            
                )
        : mixed

Parameters

$controller : AccountController

Return values

mixed

testforgotPassword()

N.B.: This test is incomplete as it doesn't actually check if repoPasswordReset returns the correct info and the message contains the right content


        public
                                testforgotPassword(
                )
        : mixed

Return values

mixed

testforgotPasswordWithFailedValidation()


        public
                                testforgotPasswordWithFailedValidation(
                    
                            $controller :
                AccountController
                            
                )
        : mixed

Parameters

$controller : AccountController

Return values

mixed

testforgotPasswordWithThrottler()


        public
                                testforgotPasswordWithThrottler(
                )
        : mixed

Return values

mixed

testgetModalAccountTos()


        public
                                testgetModalAccountTos(
                    
                            $controller :
                AccountController
                            
                )
        : mixed

Parameters

$controller : AccountController

Return values

mixed

testimageCaptcha()


        public
                                testimageCaptcha(
                    
                            $controller :
                AccountController
                            
                )
        : mixed

Parameters

$controller : AccountController

Return values

mixed

testlogin()


        public
                                testlogin(
                    
                            $controller :
                AccountController
                            
                )
        : mixed

Parameters

$controller : AccountController

Return values

mixed

testloginWithEmail()


        public
                                testloginWithEmail(
                    
                            $controller :
                AccountController
                            
                )
        : mixed

Parameters

$controller : AccountController

Return values

mixed

testloginWithLoggedInUser()


        public
                                testloginWithLoggedInUser(
                    
                            $controller :
                AccountController
                            
                )
        : mixed

Parameters

$controller : AccountController

Return values

mixed

testloginWithFailledValidation()


        public
                                testloginWithFailledValidation(
                    
                            $controller :
                AccountController
                            
                )
        : mixed

Parameters

$controller : AccountController

Return values

mixed

testloginWithThrottler()


        public
                                testloginWithThrottler(
                )
        : mixed

Return values

mixed

testloginThrottlerCountsFailedLogins()


        public
                                testloginThrottlerCountsFailedLogins(
                )
        : mixed

Return values

mixed

testloginThrottlerDoesntCountSuccessfulLogins()


        public
                                testloginThrottlerDoesntCountSuccessfulLogins(
                )
        : mixed

Return values

mixed

testloginWithDisableEmail()


        public
                                testloginWithDisableEmail(
                )
        : mixed

Return values

mixed

testlogoutWithLoggedInUser()


        public
                                testlogoutWithLoggedInUser(
                )
        : mixed

Return values

mixed

testlogoutWithNoUser()


        public
                                testlogoutWithNoUser(
                    
                            $controller :
                AccountController
                            
                )
        : mixed

Parameters

$controller : AccountController

Return values

mixed

testpageForgotPassword()


        public
                                testpageForgotPassword(
                    
                            $controller :
                AccountController
                            
                )
        : mixed

Parameters

$controller : AccountController

Return values

mixed

testpageRegister()


        public
                                testpageRegister(
                    
                            $controller :
                AccountController
                            
                )
        : mixed

Parameters

$controller : AccountController

Return values

mixed

testpageRegisterWithDisabledRegistration()


        public
                                testpageRegisterWithDisabledRegistration(
                )
        : mixed

Return values

mixed

testpageRegisterWithNoLocales()


        public
                                testpageRegisterWithNoLocales(
                )
        : mixed

Return values

mixed

testpageRegisterWithLoggedInUser()


        public
                                testpageRegisterWithLoggedInUser(
                )
        : mixed

Return values

mixed

testpageResendVerification()


        public
                                testpageResendVerification(
                    
                            $controller :
                AccountController
                            
                )
        : mixed

Parameters

$controller : AccountController

Return values

mixed

testpageResetPassword()


        public
                                testpageResetPassword(
                    
                            $controller :
                AccountController
                            
                )
        : mixed

Parameters

$controller : AccountController

Return values

mixed

testpageSetPassword()


        public
                                testpageSetPassword(
                    
                            $controller :
                AccountController
                            
                )
        : mixed

Parameters

$controller : AccountController

Return values

mixed

testpageSettings()


        public
                                testpageSettings(
                )
        : mixed

Return values

mixed

testpageSettingsWithPartialPermissions()


        public
                                testpageSettingsWithPartialPermissions(
                )
        : mixed

Return values

mixed

actualpageSettings()


        protected
                                actualpageSettings(
                    
                            $controller :
                AccountController
                            
                )
        : mixed

Parameters

$controller : AccountController

Return values

mixed

testpageSettingsWithNoPermissions()


        public
                                testpageSettingsWithNoPermissions(
                    
                            $controller :
                AccountController
                            
                )
        : mixed

Parameters

$controller : AccountController

Return values

mixed

testpageSignIn()


        public
                                testpageSignIn(
                    
                            $controller :
                AccountController
                            
                )
        : mixed

Parameters

$controller : AccountController

Return values

mixed

testpageSignInWithLoggedInUser()


        public
                                testpageSignInWithLoggedInUser(
                )
        : mixed

Return values

mixed

testProfile()


        public
                                testProfile(
                )
        : mixed

Return values

mixed

testProfileWithPartialPermissions()


        public
                                testProfileWithPartialPermissions(
                )
        : mixed

Return values

mixed

performActualProfileTests()


        protected
                                performActualProfileTests(
                    
                            $controller :
                AccountController
                            
                    
            ,                 $user :
                UserInterface
                            
                )
        : mixed

Parameters

$controller : AccountController
$user : UserInterface

Return values

mixed

testProfileWithNoPermissions()


        public
                                testProfileWithNoPermissions(
                    
                            $controller :
                AccountController
                            
                )
        : mixed

Parameters

$controller : AccountController

Return values

mixed

testProfileWithFailedValidation()


        public
                                testProfileWithFailedValidation(
                )
        : mixed

Return values

mixed

testProfileWithInvalidLocale()


        public
                                testProfileWithInvalidLocale(
                )
        : mixed

Return values

mixed

testRegisterWithHoneypot()


        public
                                testRegisterWithHoneypot(
                    
                            $controller :
                AccountController
                            
                )
        : mixed

Parameters

$controller : AccountController

Return values

mixed

testRegisterWithRegistrationDisabled()


        public
                                testRegisterWithRegistrationDisabled(
                    
                            $controller :
                AccountController
                            
                )
        : mixed

Parameters

$controller : AccountController

Return values

mixed

testRegisterWithLoggedInUser()


        public
                                testRegisterWithLoggedInUser(
                )
        : mixed

Return values

mixed

testRegisterWithFailedThrottle()


        public
                                testRegisterWithFailedThrottle(
                )
        : mixed

Return values

mixed

testRegisterWithFailedCaptcha()


        public
                                testRegisterWithFailedCaptcha(
                    
                            $controller :
                AccountController
                            
                )
        : mixed

Parameters

$controller : AccountController

Return values

mixed

testRegisterWithFailedValidation()


        public
                                testRegisterWithFailedValidation(
                    
                            $controller :
                AccountController
                            
                )
        : mixed

Parameters

$controller : AccountController

Return values

mixed

testresendVerification()


        public
                                testresendVerification(
                )
        : mixed

Return values

mixed

testresendVerificationWithVerifiedUser()


        public
                                testresendVerificationWithVerifiedUser(
                )
        : mixed

Return values

mixed

testresendVerificationWithFailedThrottle()


        public
                                testresendVerificationWithFailedThrottle(
                )
        : mixed

Return values

mixed

testresendVerificationWithFailedValidation()


        public
                                testresendVerificationWithFailedValidation(
                    
                            $controller :
                AccountController
                            
                )
        : mixed

Parameters

$controller : AccountController

Return values

mixed

testSetPassword()


        public
                                testSetPassword(
                )
        : mixed

Return values

mixed

testSetPasswordWithNoToken()


        public
                                testSetPasswordWithNoToken(
                    
                            $controller :
                AccountController
                            
                )
        : mixed

Parameters

$controller : AccountController

Return values

mixed

testsetPasswordWithFailedValidation()


        public
                                testsetPasswordWithFailedValidation(
                    
                            $controller :
                AccountController
                            
                )
        : mixed

Parameters

$controller : AccountController

Return values

mixed

testSettings()


        public
                                testSettings(
                )
        : mixed

Return values

mixed

testSettingsOnlyEmailNoLocale()


        public
                                testSettingsOnlyEmailNoLocale(
                )
        : mixed

Return values

mixed

testSettingsWithNoPermissions()


        public
                                testSettingsWithNoPermissions(
                )
        : mixed

Return values

mixed

testSettingsWithFailedValidation()


        public
                                testSettingsWithFailedValidation(
                )
        : mixed

Return values

mixed

testSettingsWithFailedPasswordCheck()


        public
                                testSettingsWithFailedPasswordCheck(
                )
        : mixed

Return values

mixed

testSettingsWithEmailInUse()


        public
                                testSettingsWithEmailInUse(
                )
        : mixed

Return values

mixed

testSuggestUsername()


        public
                                testSuggestUsername(
                    
                            $controller :
                AccountController
                            
                )
        : mixed

Parameters

$controller : AccountController

Return values

mixed

testVerify()


        public
                                testVerify(
                )
        : mixed

Return values

mixed

testVerifyWithFailedVerification()


        public
                                testVerifyWithFailedVerification(
                )
        : mixed

Return values

mixed

testVerifyWithFailedValidation()


        public
                                testVerifyWithFailedValidation(
                )
        : mixed

Return values

mixed

getController()


        private
                                getController(
                )
        : AccountController

Return values

AccountController

setupTestDatabase()

Define the test_integration database connection the default one


        public
                                setupTestDatabase(
                )
        : mixed

Return values

mixed

refreshDatabase()

Define hooks to migrate the database before and after each test.


        public
                                refreshDatabase(
                )
        : mixed

Return values

mixed

usingInMemoryDatabase()

Determine if an in-memory database is being used.


        public
                                usingInMemoryDatabase(
                )
        : bool

Return values

bool

refreshInMemoryDatabase()

Refresh the in-memory database.


        protected
                                refreshInMemoryDatabase(
                )
        : mixed

Return values

mixed

refreshTestDatabase()

Refresh a conventional test database.


        protected
                                refreshTestDatabase(
                )
        : mixed

Return values

mixed

beginDatabaseTransaction()

Handle database transactions on the specified connections.


        protected
                                beginDatabaseTransaction(
                )
        : mixed

Return values

mixed

connectionsToTransact()

The database connections that should have transactions.


        protected
                                connectionsToTransact(
                )
        : array

Return values

array

loginUser()


        protected
                                loginUser(
                    
                            $user :
                UserInterface
                            
                )
        : mixed

Parameters

$user : UserInterface

Return values

mixed

logoutCurrentUser()

Logout


        protected
                                logoutCurrentUser(
                )
        : mixed

Return values

mixed

createTestUser()

Create a test user with no settings/permissions for a controller test


        protected
                                createTestUser(
                    
            [                $isMaster :
                bool
                 = false ]            
                    
            [,                 $login :
                bool
                 = false ]            
                    
            [,                 $params :
                array
                 = [] ]            
                )
        : User

Parameters

$isMaster : bool = false: Does this user have root access? Will bypass all permissions
$login : bool = false: Login this user, setting him as the currentUser
$params : array = []: User account params

Return values

User

getRandomUserId()

Returns a random user id, exclusing th master id


        protected
                                getRandomUserId(
                    
                            $masterId :
                int
                            
                )
        : int

Parameters

$masterId : int

Return values

int

giveUserTestPermission()

Gives a user a new test permission


        protected
                                giveUserTestPermission(
                    
                            $user :
                UserInterface
                            
                    
            ,                 $slug :
                string
                            
                    
            [,                 $conditions :
                string
                 = 'always()' ]            
                )
        : Permission

Parameters

$user : UserInterface
$slug : string
$conditions : string = 'always()'

Return values

Permission

giveUserPermission()

Add the test permission to a Role, then the role to the user


        protected
                                giveUserPermission(
                    
                            $user :
                UserInterface
                            
                    
            ,                 $permission :
                Permission
                            
                )
        : Role

Parameters

$user : UserInterface
$permission : Permission

Return values

Role —

The intermidiate role

getRequest()


        protected
                                getRequest(
                    
            [                $args :
                array
                 = [] ]            
                )
        : Request

Parameters

$args : array = []: Request arguments

Return values

Request

getResponse()


        protected
                                getResponse(
                )
        : Response

Return values

Response

AccountControllerTest extends TestCase Uses TestDatabase, RefreshDatabase, withTestUser, withController

Table of Contents

Properties

$initialized

$migrated

Methods

setUp()

tearDown()

testControllerConstructor()

Return values

testRegisterWithNoMasterUser()

Parameters

Tags

Return values

testRegister()

Tags

Return values

testRegisterWithNoEmailVerification()

Tags

Return values

performActualRegisterTest()

Parameters

Return values

testcheckUsername()

Parameters

Tags

Return values

testcheckUsernameWithNoData()

Parameters

Tags

Return values

testcheckUsernameWithUsernameNotAvailable()

Parameters

Tags

Return values

testcheckUsernameWithThrottler()

Tags

Return values

testdenyResetPassword()

Tags

Return values

testdenyResetPasswordWithFailedPasswordReset()

Tags

Return values

testdenyResetPasswordWithFailedValidation()

Parameters

Tags

Return values

testforgotPassword()

Tags

Return values

testforgotPasswordWithFailedValidation()

Parameters

Tags

Return values

testforgotPasswordWithThrottler()

Tags

Return values

testgetModalAccountTos()

Parameters

Tags

Return values

testimageCaptcha()

Parameters

Tags

Return values

testlogin()

Parameters

Tags

Return values

testloginWithEmail()

Parameters

Tags

Return values

testloginWithLoggedInUser()

Parameters

Tags

Return values

testloginWithFailledValidation()

Parameters