Disk Service
cbfs includes a Disk Service object you can use to register and interact with your disks.
The cbfs module registers a WireBox injection DSL that you can use to inject objects from the module.
DSL | Description |
---|---|
cbfs | Inject the Disk Service |
cbfs:disks | Inject the entire disk records |
cbfs:disks:{name} | Inject a specific disk instance by {name} |
// Injects the DiskService
diskService = getInstance( "cbfs" );
property name="diskService" inject="cbfs";
diskService = getInstance( "[email protected]" );
property name="diskService" inject="[email protected]";
// Injects the entire disks record structure
disks = getInstance( "cbfs:disks" );
property name="disks" inject="cbfs:disks";
// Injects a specific disk by name
tempDisk = getInstance( "cbfs:disks:{name}" );
tempDisk = getInstance( "cbfs:disks:temp" );
property name="tempDisk" inject="cbfs:disks:temp";
The cbfs module registers a helper method called
cbfs( diskName )
that you can use in your handlers, layouts, and views to get an instance of a specific disk:// SomeHandler.cfc
component {
function index( event, rc, prc ) {
var storage = cbfs( "RamDisk" );
var files = storage.allFiles();
}
}
Returns the count of registered disks.
Returns requested disk instance. Throws
InvalidDiskException
if the disk is not registered.Returns struct of details for a disk.
Returns true if the disk has been registered with the provided name.
Returns an array of registered disk names.
Registers a new disk. If a disk has already been configured with the same name, then it will not be updated unless you specify
override=true
.Unregisters and shuts down all disks managed by the DiskService.
Returns the temporary disk.
Unregisters a disk. Throws
InvalidDiskException
if the disk is not registered.Last modified 4mo ago