trait InteractsWithPublishedFiles

internal  
 

Provides assertion helpers and cleanup utilities for testing file publishing.

Properties

protected bool $interactsWithPublishedFilesTeardownRegistered

Determine if trait teardown has been registered.

protected null|array<int, string> $cachedExistingMigrationsFiles

List of existing migration files.

Methods

void
setUpInteractsWithPublishedFiles()

Setup Interacts with Published Files environment.

void
tearDownInteractsWithPublishedFiles()

Teardown Interacts with Published Files environment.

void
cacheExistingMigrationsFiles()

Cache existing migration files.

void
assertFileContains(array $contains, string $file, string $message = '')

Assert file contains the given strings.

void
assertFileDoesNotContains(array $contains, string $file, string $message = '')

Assert file does not contain the given strings.

void
assertFileNotContains(array $contains, string $file, string $message = '')

Assert file does not contain the given strings.

void
assertMigrationFileContains(array $contains, string $file, string $message = '', string|null $directory = null)

Assert migration file contains the given strings.

void
assertMigrationFileDoesNotContains(array $contains, string $file, string $message = '', string|null $directory = null)

Assert migration file does not contain the given strings.

void
assertMigrationFileNotContains(array $contains, string $file, string $message = '', string|null $directory = null)

Assert migration file does not contain the given strings.

void
assertFilenameExists(string $file)

Assert filename exists.

void
assertFilenameDoesNotExists(string $file)

Assert filename does not exist.

void
assertFilenameNotExists(string $file)

Assert filename does not exist.

void
assertMigrationFileExists(string $file, string|null $directory = null)

Assert migration filename exists.

void
assertMigrationFileDoesNotExists(string $file, string|null $directory = null)

Assert migration filename does not exist.

void
assertMigrationFileNotExists(string $file, string|null $directory = null)

Assert migration filename does not exist.

void
cleanUpPublishedFiles()

Removes generated files.

string|null
findFirstPublishedMigrationFile(string $filename, string|null $directory = null)

Find the first published migration file matching the filename.

void
cleanUpPublishedMigrationFiles()

Removes generated migration files.

string
publishedFilePath(string|SplFileInfo $file)

Normalize a published file entry into a filesystem path.

Details

at line 36
protected void setUpInteractsWithPublishedFiles()

internal  
 

Setup Interacts with Published Files environment.

Return Value

void

at line 49
protected void tearDownInteractsWithPublishedFiles()

internal  
 

Teardown Interacts with Published Files environment.

Return Value

void

at line 64
protected void cacheExistingMigrationsFiles()

internal  
 

Cache existing migration files.

Return Value

void

at line 78
protected void assertFileContains(array $contains, string $file, string $message = '')

Assert file contains the given strings.

Parameters

array $contains
string $file
string $message

Return Value

void

at line 96
protected void assertFileDoesNotContains(array $contains, string $file, string $message = '')

Assert file does not contain the given strings.

Parameters

array $contains
string $file
string $message

Return Value

void

at line 114
protected void assertFileNotContains(array $contains, string $file, string $message = '')

Assert file does not contain the given strings.

Parameters

array $contains
string $file
string $message

Return Value

void

at line 124
protected void assertMigrationFileContains(array $contains, string $file, string $message = '', string|null $directory = null)

Assert migration file contains the given strings.

Parameters

array $contains
string $file
string $message
string|null $directory

Return Value

void

at line 142
protected void assertMigrationFileDoesNotContains(array $contains, string $file, string $message = '', string|null $directory = null)

Assert migration file does not contain the given strings.

Parameters

array $contains
string $file
string $message
string|null $directory

Return Value

void

at line 160
protected void assertMigrationFileNotContains(array $contains, string $file, string $message = '', string|null $directory = null)

Assert migration file does not contain the given strings.

Parameters

array $contains
string $file
string $message
string|null $directory

Return Value

void

at line 168
protected void assertFilenameExists(string $file)

Assert filename exists.

Parameters

string $file

Return Value

void

at line 178
protected void assertFilenameDoesNotExists(string $file)

Assert filename does not exist.

Parameters

string $file

Return Value

void

at line 188
protected void assertFilenameNotExists(string $file)

Assert filename does not exist.

Parameters

string $file

Return Value

void

at line 196
protected void assertMigrationFileExists(string $file, string|null $directory = null)

Assert migration filename exists.

Parameters

string $file
string|null $directory

Return Value

void

at line 206
protected void assertMigrationFileDoesNotExists(string $file, string|null $directory = null)

Assert migration filename does not exist.

Parameters

string $file
string|null $directory

Return Value

void

at line 216
protected void assertMigrationFileNotExists(string $file, string|null $directory = null)

Assert migration filename does not exist.

Parameters

string $file
string|null $directory

Return Value

void

at line 226
protected void cleanUpPublishedFiles()

internal  
 

Removes generated files.

Return Value

void

at line 242
protected string|null findFirstPublishedMigrationFile(string $filename, string|null $directory = null)

Find the first published migration file matching the filename.

Parameters

string $filename
string|null $directory

Return Value

string|null

at line 256
protected void cleanUpPublishedMigrationFiles()

internal  
 

Removes generated migration files.

Return Value

void

at line 270
protected string publishedFilePath(string|SplFileInfo $file)

Normalize a published file entry into a filesystem path.

Parameters

string|SplFileInfo $file

Return Value

string