Classes

\SilverStripe\Assets

Name Description
AssetControlExtension This class provides the necessary business logic to ensure that any assets attached to a record are safely deleted, published, or protected during certain operations. EMPTY
AssetManipulationList Provides a mechanism for determining the effective visibility of a set of assets (identified by filename and hash), given their membership to objects of varying visibility. EMPTY
File This class handles the representation of a file on the filesystem within the framework. EMPTY
FileDefaultPermissions Permissions for root files with Can*Type = Inherit EMPTY
FileFinder A utility class that finds any files matching a set of rules that are present within a directory tree. EMPTY
FileNameFilter Filter certain characters from file name, for nicer (more SEO-friendly) URLs as well as better filesystem compatibility. EMPTY
Filesystem A collection of static methods for manipulating the filesystem. EMPTY
Folder Represents a logical folder, which may be used to organise assets stored in the configured backend. EMPTY
FolderNameFilter Filter certain characters from file name, for nicer (more SEO-friendly) URLs as well as better filesystem compatibility. EMPTY
Image Represents an Image EMPTY
ImageBackendFactory Creates backends for images as necessary, avoiding redundant asset writes and loads EMPTY
InterventionBackend No description available EMPTY
Upload Manages uploads via HTML forms processed by PHP, uploads to Silverstripe's default upload directory, and either creates a new or uses an existing File-object for syncing with the database. EMPTY
Upload_Validator No description available EMPTY

\SilverStripe\Assets\Dev

Name Description
TestAssetStore Allows you to mock a backend store in a custom directory beneath assets. EMPTY
VersionedFilesMigrator No description available EMPTY

\SilverStripe\Assets\Dev\Tasks

Name Description
FileMigrationHelper Service to help migrate File dataobjects to the new APL. EMPTY
FolderMigrationHelper Service to help migrate Folder dataobjects to the new database format. EMPTY
InterventionBackendCacheFlushTask A task to manually flush InterventionBackend cache EMPTY
LegacyThumbnailMigrationHelper Service to migrate legacy format thumbnails, to avoid regenerating them on demand. EMPTY
NormaliseAccessMigrationHelper Service to help identify and migrate Files that have been saved to the wrong asset store and restore them to the appropriate physical location. EMPTY
SecureAssetsMigrationHelper Removes stray .htaccess files created through the silverstripe/secureassets module on a 3.x-based site. The 4.x protections work differently: One central assets/.htaccess file routes non-existent paths through SilverStripe, which can choose to return a file from assets/.protected. EMPTY
TagsToShortcodeHelper SS4 and its File Migration Task changes the way in which files are stored in the assets folder, with files placed in subfolders named with partial hashmap values of the file version. This helper class goes through the HTML content fields looking for instances of image links, and corrects the link path to what it should be, with an image shortcode. EMPTY
TagsToShortcodeTask SS4 and its File Migration Task changes the way in which files are stored in the assets folder, with files placed in subfolders named with partial hashmap values of the file version. This build task goes through the HTML content fields looking for instances of image links, and corrects the link path to what it should be, with an image shortcode. EMPTY
VersionedFilesMigrationTask No description available EMPTY

\SilverStripe\Assets\FilenameParsing

Name Description
FileIDHelperResolutionStrategy File resolution strategy that relies on a list of FileIDHelpers to find files. EMPTY
HashFileIDHelper Parsed Hash path URLs. Hash paths group a file and its variant under a directory based on a hash generated from the content of the original file. EMPTY
LegacyFileIDHelper Parsed SS3 style legacy asset URLs. e.g.: `Uploads/_resampled/ResizedImageWzYwLDgwXQ/sam.jpg` EMPTY
NaturalFileIDHelper Parsed Natural path URLs. Natural path is the same hashless path that appears in the CMS. EMPTY
ParsedFileID Immutable representation of a parsed fileID broken down into its sub-components. EMPTY

\SilverStripe\Assets\Flysystem

Name Description
AssetAdapter Adapter for local filesystem based on assets directory EMPTY
FlysystemAssetStore Asset store based on flysystem Filesystem as a backend EMPTY
GeneratedAssets Simple Flysystem implementation of GeneratedAssetHandler for storing generated content EMPTY
ProtectedAssetAdapter No description available EMPTY
PublicAssetAdapter No description available EMPTY

\SilverStripe\Assets\Shortcodes

Name Description
FileLink Represents a link between a dataobject parent and a file shortcode in a HTML content area EMPTY
FileLinkTracking Adds tracking of links in any HTMLText fields which reference SiteTree or File items. EMPTY
FileLinkTrackingParser A helper object for extracting information about links. EMPTY
FileShortcodeProvider Provides shortcodes for File dataobject EMPTY
ImageShortcodeProvider Class ImageShortcodeProvider EMPTY

\SilverStripe\Assets\Storage

Name Description
DBFile Represents a file reference stored in a database EMPTY
DefaultAssetNameGenerator Basic filename renamer EMPTY
ProtectedFileController Provides routing for session-whitelisted protected files EMPTY
Sha1FileHashingService Utility for computing and comparing unique file hash. All `$fs` parameters can either be: * an `AssetStore` constant VISIBILITY constant or * an actual `Filesystem` object. EMPTY

\SilverStripe\Assets\Tests

Name Description
AssetControlExtensionTest Tests {@see AssetControlExtension} EMPTY
AssetManipulationListTest Tests set manipulations of groups of assets of differing visibilities EMPTY
FileFinderTest Tests for the {@link SS_FileFinder} class. EMPTY
FileNameFilterTest No description available EMPTY
FileTest Tests for the File class EMPTY
FilesystemTest No description available EMPTY
FolderNameFilterTest No description available EMPTY
FolderTest No description available EMPTY
GDImageTest No description available EMPTY
ImageManipulationTest ImageTest is abstract and should be overridden with manipulator-specific subtests EMPTY
ImageTest ImageTest is abstract and should be overridden with manipulator-specific subtests EMPTY
ImagickImageTest No description available EMPTY
ProtectedFileControllerTest No description available EMPTY
PublicAssetAdapterTest No description available EMPTY
RedirectFileControllerTest No description available EMPTY
RedirectKeepArchiveFileControllerTest We rerun all the same test in `RedirectFileControllerTest` but with keep_archived_assets on EMPTY
UploadTest No description available EMPTY
VersionedFilesMigratorTest No description available EMPTY

\SilverStripe\Assets\Tests\AssetControlExtensionTest

Name Description
ArchivedObject Versioned object that always archives its assets EMPTY
TestObject A basic unversioned object EMPTY
VersionedObject Versioned object with attached assets EMPTY

\SilverStripe\Assets\Tests\Dev\Tasks

Name Description
FileMigrationHelperTest Ensures that File dataobjects can be safely migrated from 3.x EMPTY
FixFolderPermissionsHelperTest Ensures that files with invalid permissions can be fixed. EMPTY
LegacyThumbnailMigrationHelperTest No description available EMPTY
NormaliseAccessMigrationHelperTest Ensures that File dataobjects can be safely migrated from 3.x EMPTY
NormaliseAccessMigrationHelperWithHashPathTest Ensures that File dataobjects can be safely migrated from 3.x EMPTY
NormaliseAccessMigrationHelperWithKeepArchivedTest Ensures that File dataobjects can be safely migrated from 3.x EMPTY
SS4CrazyFileMigrationHelperTest We're testing an impossible scenario where our user was using hash files for protected files and SS3 format for public ones. We're transitioning to a scenario where Hash paths are used for both protected and public files. EMPTY
SS4FileMigrationHelperTest Test a generic SS4.3 to SS4.4 file migration. Also serve as basis for more fancy file migration test EMPTY
SS4KeepArchivedFileMigrationHelperTest Test that our FileMigrationHelper works when keep archived is enabled EMPTY
SS4LegacyFileMigrationHelperTest We're testing a scenario where someone is migrating from an SS4.3 install with legacy filenames enabled. EMPTY
SecureAssetsMigrationHelperTest No description available EMPTY
TagsToShortcodeHelperTest No description available EMPTY

\SilverStripe\Assets\Tests\Dev\Tasks\FileMigrationHelperTest

Name Description
Extension No description available EMPTY

\SilverStripe\Assets\Tests\Dev\Tasks\Shortcode

Name Description
HtmlObject No description available EMPTY
NoStage No description available EMPTY
PseudoPage No description available EMPTY
SubHtmlObject No description available EMPTY

\SilverStripe\Assets\Tests\FileTest

Name Description
MyCustomFile No description available EMPTY

\SilverStripe\Assets\Tests\FilenameParsing

Name Description
BrokenFileIDHelper Mock FileIDHelper that always return the same values all the time as defined in the constructor EMPTY
FileIDHelperResolutionStrategyTest No description available EMPTY
FileIDHelperTester All the `FileIDHelper` have the exact same signature and very similar structure. Their basic tests will share the same structure. EMPTY
HashFileIDHelperTest No description available EMPTY
LegacyFileIDHelperTest No description available EMPTY
MigrationLegacyFileIDHelperTest No description available EMPTY
MockFileIDHelper Mock FileIDHelper that always return the same values all the time as defined in the constructor EMPTY
NaturalFileIDHelperTest No description available EMPTY
ParsedFileIDTest No description available EMPTY

\SilverStripe\Assets\Tests\Flysystem

Name Description
AssetAdapterTest No description available EMPTY
FlysystemAssetStoreExtension No description available EMPTY
FlysystemAssetStoreTest No description available EMPTY
FlysystemAssetStoreUpdateResponseTest No description available EMPTY

\SilverStripe\Assets\Tests\Shortcodes

Name Description
FileBrokenLinksTest Tests broken links in html areas EMPTY
FileLinkTrackingTest No description available EMPTY
FileShortcodeProviderTest No description available EMPTY
ImageShortcodeProviderTest No description available EMPTY

\SilverStripe\Assets\Tests\Shortcodes\FileBrokenLinksTest

Name Description
EditableObject No description available EMPTY

\SilverStripe\Assets\Tests\Storage

Name Description
AssetStoreTest No description available EMPTY
DBFileTest No description available EMPTY
DefaultAssetNameGeneratorTest covers {@see DefaultAssetNameGenerator} EMPTY
Sha1FileHashingServiceTest No description available EMPTY

\SilverStripe\Assets\Tests\Storage\AssetStoreTest

Name Description
TestAssetStore Allows you to mock a backend store in a custom directory beneath assets. EMPTY

\SilverStripe\Assets\Tests\Storage\DBFileTest

Name Description
ImageOnly No description available EMPTY
Subclass No description available EMPTY
TestObject No description available EMPTY

\SilverStripe\Dev\Tasks

Name Description
FixFolderPermissionsHelper Files imported from SS3 might end up with broken permissions if there is a case conflict. EMPTY