Download the PHP package dbrabon/file_adoption without Composer
On this page you can find all versions of the php package dbrabon/file_adoption. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download dbrabon/file_adoption
More information about dbrabon/file_adoption
Files in dbrabon/file_adoption
Package file_adoption
Short Description Scans the public file directory for orphaned files and adopts them as managed file entities.
License GPL-2.0-or-later
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package file_adoption
File Adoption
File Adoption is a utility module for Drupal that scans the public files directory
for files that are not tracked by Drupal's file_managed table. Identified
"orphaned" files can be registered as managed file entities.
Installation
-
Place the module in your Drupal installation, typically using Composer:
or by copying the module into
modules/custom. -
Enable the module from the Extend page or with Drush:
- Navigate to Administration → Reports → File Adoption (
/admin/reports/file-adoption) to configure settings or review the most recent scan results. The page no longer runs a scan automatically.
Configuration
The configuration form offers the following options:
- Ignore Patterns – Comma or newline separated patterns (relative to
public://) that should be skipped when scanning. The default configuration skips directories such ascss/*,js/*,private/*,webforms/*,config_*,media-icons/*,php/*,styles/*,asset_injector/*,embed_buttons/*, andoembed_thumbnails/*. Pattern matching is case-insensitive. - Enable Adoption – When checked, cron will automatically adopt orphaned files using the configured settings.
- Items per cron run – Maximum number of files adopted or displayed per scan or cron run. All discovered orphans are saved regardless of this limit. Defaults to 20.
- Ignore Symlinks – When enabled, symbolic links are skipped during scanning, preventing loops or slowdowns caused by symlinks. Symlinks discovered during scanning are still listed under the "Symlinks"
- Directory Depth – Maximum directory depth displayed under "Directories". Directories deeper than this setting are omitted from the summary but files within them can still be adopted. Valid range is 1–9 and the default is 9.
- Cron Frequency – How often cron should run file adoption tasks. Options include every cron run, hourly, daily, weekly, monthly, or yearly.
- Verbose Logging – When enabled, additional debug information is written to the log during scans and adoption. This is off by default. Adoption success messages are only recorded when verbose logging is enabled. When enabled, each directory encountered during cron scans is also logged.
The configuration page also shows details gathered from the most recent scan:
- Directories – Lists every directory discovered. Directories marked as
ignored are annotated with “(ignored)” and any ignored file names appear in
parentheses. This information is read from the
file_adoption_indextable. - Add to Managed Files – Displays the files scheduled for adoption. Entries
come from the
file_adoption_orphanstable after filtering out ignored directories and patterns.
Changes are stored in file_adoption.settings.
Cron Integration
Scanning occurs exclusively during cron runs. The Cron Frequency setting
controls how often hook_cron() invokes the FileScanner service. Each run
records its totals to state so the configuration page can report the last
execution. When Enable Adoption is disabled the run also populates the
file_adoption_orphans table with any discovered orphans. All orphans remain
recorded in this table regardless of the item limit. When adoption is enabled,
files are registered immediately and the table remains empty.
Every cron run also rebuilds the file_adoption_index table, which lists all
files the application can access for fast lookups.
Running Tests
These tests rely on Drupal's core testing environment. Make sure your Drupal
installation includes the drupal/core-dev package. Tests should be executed
from the Drupal project root so that Drupal's PHPUnit configuration is used.
From the module directory you can run:
The tests are located under the tests/ directory and include kernel tests for
the FileScanner service and the configuration form.
Uninstall
Uninstalling the module removes all configuration and drops the
file_adoption_orphans and file_adoption_index tables so no leftover data
remains.
