Download the PHP package elementareteilchen/housekeeper without Composer
On this page you can find all versions of the php package elementareteilchen/housekeeper. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download elementareteilchen/housekeeper
More information about elementareteilchen/housekeeper
Files in elementareteilchen/housekeeper
Package housekeeper
Short Description CLI commands to keep your TYPO3 instance lean and clean
License GPL-2.0-or-later
Informations about the package housekeeper
TYPO3 Housekeeper Commands
This extension provides various maintenance and housekeeping commands for TYPO3 installations.
All commands support the Symfony Console command line interface and can be executed via the TYPO3 CLI.
Useful Symfony Options
Option | Description | Required |
---|---|---|
--no-interaction / -n |
disables interaction | No |
--quiet |
suppresses output | No |
--silent |
no interaction or output | No |
-v / -vv / -vvv |
Verbosity level | No |
FAL Management Commands
Move Command
Move or rename a file or folder. Works similar to the bash mv command. This could also be done in the Backend, but there is the risk of timeouts on big move operations, which would result in potential chaos.
Parameters
Parameter | Description | Required |
---|---|---|
<source> |
(Combined) identifier of the source folder/file | Yes |
<target> |
(Combined) identifier of the target folder/file | Yes |
The combined identifier begins with the storage ID, see examples. . The default is .
Examples
Known limitations
- Folders can not be moved between storages. Single files do work.
Cleanup Commands
These commands find either missing files or files whose identifier contain a specific string and delete them. Files which are still in use are omitted and shown in the output. This will also cleanup leftover references (like in sys_file_metadata).
Files Cleanup Command
Cleanup files via a given identifier. All files matching the given string are deleted via the system's API delete command. Files which are still in use are omitted and shown in the output.
Parameters
Parameter | Description | Required |
---|---|---|
<identifier> |
Files matching this string will be deleted | Yes |
Options
Option | Short | Description | Default |
---|---|---|---|
--storageId |
-s |
Storage id | 1 (fileadmin) |
--dry-run |
- | Only pretend deletion | false |
--update-refindex |
- | Automatically updates the reference index | false |
Files that failed to be deleted will be written to a log file:
var/log/housekeeper:cleanup-files_failed_DATE.log
.
Examples
Missing Files Cleanup Command
Cleanup missing files. Files marked as missing are touched and marked as not missing before deletion.
Options
Option | Short | Description | Default |
---|---|---|---|
--storageId |
-s |
Storage id | 1 (fileadmin) |
--dry-run |
- | Only pretend deletion | false |
--update-refindex |
- | Automatically updates the reference index | false |
Files that failed to be deleted will be written to a log file:
var/log/housekeeper:cleanup-missing_failed_DATE.log
.
Consolidate External URLs Command
This command searches for external URLs in the database and converts them to internal TYPO3 links when possible. It can find links (href) and images (src) with a specific path or URL pattern and convert them to internal links (t3: //file?uid= or t3://page?uid=) if the corresponding files or pages can be found.
Parameters
Parameter | Description | Required |
---|---|---|
<site> |
The identifier of the site | Yes |
Options
Option | Short | Description | Default |
---|---|---|---|
--table |
-t |
The database table to search in | - |
--field |
-f |
The database field to search in | - |
--domain |
-d |
The domain to match (e.g., www.your-website.com) | - |
--path |
-p |
The path to match | fileadmin |
--all |
-a |
Run on all fields defined in $GLOBALS['TCA'] | false |
--log |
-l |
Write output to log file | false |
--dry-run |
- | Only simulate changes without saving them | false |
The
--all
option will use tables and fields found by searching the$GLOBALS['TCA']
array for all fields with atype
oflink
or asoftref
containingtypolink
.The log file option
--log
, causes the output to be written tovar/log/housekeeper:consolidate-external-urls_DATE.log
.