1. interface
  2. SilverStripe
  3. \
  4. ORM
  5. \
  6. CMSPreviewable

CMSPreviewable

interface CMSPreviewable (View source)

Interface to provide enough information about a record to make it previewable through the CMS. It uses the record database ID, its "frontend" and "backend" links to link up the edit form with its preview.

Also used by {@link SilverStripeNavigator} to generate links - both within the CMS preview, and as a frontend utility for logged-in CMS authors in custom themes (with the $SilverStripeNavigator template marker).

Methods

string
PreviewLink(string $action = null)

Determine the preview link, if available, for this object.

string
getMimeType()

To determine preview mechanism (e.g. embedded / iframe)

string
CMSEditLink()

No description

Details

Determine the preview link, if available, for this object.

If no preview is available for this record, it may return null.

Parameters

string $action

Return Value

string

Link to the end-user view for this record. Example: http://mysite.com/my-record

at line 32
string getMimeType()

To determine preview mechanism (e.g. embedded / iframe)

Return Value

string

Return Value

string

Link to the CMS-author view. Should point to a controller subclassing {@link LeftAndMain}. Example: http://mysite.com/admin/edit/6