interfaces
Interfaces, Classes and Traits
- BlockCacheStrategyInterface
- A cache strategy will cache a block differently according to various options
- BlockInterface
- Defines a block. Blocks are defined by providers, they can have various options and can be assigned to theme's regions.
- BlockProviderInterface
- A block provider, can define several blocks. Their blocks can be modified through events.
- CraftFieldInterface
- Class that handles most Craft fields (all of them apart from Matrix and Table)
- DisplayerInterface
- Base interface for displayers
- DisplayInterface
- A display is assigned to a view mode, it has an `item` which can be a field or a group
- DisplayItemInterface
- Generic interface for display items.
- FieldDisplayerInterface
- A displayer renders one and one only type of field, it can have options.
- FieldInterface
- A field is a type of item, it can handle a Craft field or a theme field (title, author etc)
- FileDisplayerInterface
- A file displayer renders an asset. It can handle several file kinds
- FileFieldDisplayerInterface
- Interface for field displayers that render files (Assets, user photo etc)
- GroupInterface
- A group is a type of item, it can contains several displays
- HasDisplaysInterface
- Interface for classes that have displays (view mode or groups for example)
- LayoutInterface
- A layout is associated to a theme and unless it's a custom layout, to a Craft element.
- RegionInterface
- Regions are defined by themes, and are assigned to layouts. They can have blocks.
- ThemeInterface
- A theme is a regular plugin, it defines regions and can extend another theme.
- ThemePreferencesInterface
- Each theme define some preferences which control the classes and attributes of the page elements when they are rendered.
- ViewModeInterface
- A view mode has displays associated to it, it's associated to a layout.
- RegionLayoutInterface
- Regions layouts are defined by themes, and are assigned to layouts. They define regions