Documentation

filesIndexCheck
in package

files.txt inde check object

Tags
author

Stefan Seehafer sea75300@yahoo.de

copyright

(c) 2025, Stefan Seehafer

license

http://www.gnu.org/licenses/gpl.txt GPLv3

since
5.2.5-a1

Table of Contents

DATA_FOLDER_STR  = '/data'
DIRS_DATA_WHITELIST  = ['dbstruct', 'share']
/data folder whitelist for checks
FPCM_FOLDER_STR  = 'fanpress/'
$base  : string
Base path
$completeIndex  : array<string|int, mixed>
Complete file index
$dirs  : array<string|int, mixed>
Directory index
$excludes  : array<string|int, mixed>
Excluded files
$files  : array<string|int, mixed>
Files index
$index  : int
Progress index
$indexed  : bool
Flag if index was build
$logFunction  : string
Log function placeholder
$path  : string
files.txt file path
$progress  : progress|null
CLI progressbar object
$showProgress  : bool
Show progress bar
__construct()  : mixed
Konstruktor
checkFiles()  : bool
Rund file check
cleanup()  : bool
Cleanup files
exists()  : bool
Check if files.txt file exists
getBasePath()  : string
Base path
getDirs()  : array<string|int, mixed>
Get outdated directory list
getFiles()  : array<string|int, mixed>
Get outdated files list
prepareIndex()  : bool
Prepares check index
resetIndex()  : void
setExcludes()  : $this
Set excluded files
logProgress()  : void
Progress output
logQuiet()  : void
Quiet output

Constants

DATA_FOLDER_STR

private data DATA_FOLDER_STR = '/data'

folder string

DIRS_DATA_WHITELIST

/data folder whitelist for checks

private mixed DIRS_DATA_WHITELIST = ['dbstruct', 'share']

FPCM_FOLDER_STR

private fanpress FPCM_FOLDER_STR = 'fanpress/'

folder string

Properties

$completeIndex

Complete file index

private array<string|int, mixed> $completeIndex = []

$excludes

Excluded files

private array<string|int, mixed> $excludes = []

$logFunction

Log function placeholder

private string $logFunction = 'logQuiet'

Methods

__construct()

Konstruktor

public __construct([bool $progress = false ]) : mixed
Parameters
$progress : bool = false
Return values
mixed

checkFiles()

Rund file check

public checkFiles() : bool
Tags
throws
Exception
Return values
bool

cleanup()

Cleanup files

public cleanup() : bool
Tags
throws
Exception
Return values
bool

exists()

Check if files.txt file exists

public final exists() : bool
Return values
bool

getBasePath()

Base path

public getBasePath() : string
Return values
string

getDirs()

Get outdated directory list

public getDirs() : array<string|int, mixed>
Return values
array<string|int, mixed>

getFiles()

Get outdated files list

public getFiles() : array<string|int, mixed>
Return values
array<string|int, mixed>

prepareIndex()

Prepares check index

public prepareIndex() : bool
Tags
throws
Exception
Return values
bool

setExcludes()

Set excluded files

public setExcludes(array<string|int, mixed> $excludes) : $this
Parameters
$excludes : array<string|int, mixed>
Return values
$this

logProgress()

Progress output

private logProgress(string $text) : void
Parameters
$text : string
Return values
void

logQuiet()

Quiet output

private logQuiet(string $text) : void
Parameters
$text : string
Return values
void

Search results