silverstripe-framework/docs/en/reference/index.md

2.8 KiB

Reference

Reference articles complement our auto-generated API docs in providing deeper introduction into a specific API.

  • BBCode: Extensible shortcode syntax
  • Built-in page controls: Explains the template syntax and available variables/placeholders
  • ComplexTableField: Manage records and their relations inside the CMS
  • Database Structure: Conventions and best practices for database tables and fields
  • DataObject: Base class for database records
  • DataObjectDecorator: A "mixin" system allowing to extend core classes
  • DataObjectSet: The base collection of database records in the ORM
  • Director: Routes URLs and handles HTTP requests
  • Execution Pipeline: Detailed look on the way an HTTP request takes through the system
  • Form Field Types: Highlevel overview of field classes
  • Image: Represents an image object in templates and PHP code
  • LeftAndMain: Base class for the CMS interface
  • Member: The "user" object forms the base for our security/permission moel
  • ModelAdmin: Manage arbitrary data in a simple CRUD (create/read/update/delete) interface
  • Partial Caching: Cache complex parts of templates for better performance
  • Permission: Database-backed permission model
  • Requirements: Include CSS and JavaScript files in templates and controllers
  • RestfulService: Consume Restful APIs with this client
  • RSSFeed: Expose any database records as an RSS feed
  • SearchContext: Wraps search queries and forms into an object
  • Site Reports: Tabular reports in a specialized CMS interface
  • SiteConfig: Global configuration stored in the database
  • SiteTree: Base class for a "page" in the CMS
  • SQLQuery: Wrapper around a SQL query allowing modification before execution
  • StaticPublisher: Export a page tree as static HTML for better performance and portability
  • TableField: Add and edit records with inline edits in this form field
  • TableListField: View and delete records in the CMS
  • Templates: Process our data for output in HTML and other formats
  • Typography: CSS file to enable WYSIWYG previews in the CMS
  • urlvariabletools: Debug and maintenance switches
  • Versioned: Extension for SiteTree and other classes to store old versions and provide "staging"

Feedback

If you have a topic you would like covered in these section please ask for it on our Bug Tracker