\KapostObject
Class KapostObject
Synopsis
class KapostObject
extends DataObject
{
- // members
- private static array $db = ;
- private static string $default_sort = 'Created';
- private static array $summary_fields = ;
- // methods
- public final bool canCreate()
- public final bool canEdit()
- public FieldList getCMSFields()
- public string getKapostChangeTypeNice()
- public string getToPublishNice()
- public string getClassNameNice()
- public string getDestinationClass()
- public final string sanitizeHTML()
- public FieldList scaffoldSearchFields()
- public array summaryFields()
- public KapostConversionHistory createConversionHistory()
- public string renderPreview()
- public string CMSEditLink()
- public ValidationResult validate_incoming()
- protected ValidationResult validate()
- protected void onBeforeWrite()
- protected void onAfterWrite()
- protected void cleanUpExpiredPreviews()
Hierarchy
Extends
- DataObject
Members
private
- $db
- $default_sort
- $summary_fields
Methods
protected
- cleanUpExpiredPreviews() — Cleans up expired Kapost previews after twice the token expiry
- onAfterWrite() — Calls the cleanup expired previews after writing
- onBeforeWrite() — Ensures a title is present for the Kapost Object before writing
- validate() — Validates the current object, invalid objects will not be written. By default all Kapost objects are valid if they have a value in the KapostRefID
public
- CMSEditLink() — Gets the edit link for the Kapost Object
- canCreate() — Prevent creation of the KapostObjects, they are delivered from Kapost
- canEdit() — Prevent editing of the KapostObjects, they are delivered from Kapost
- createConversionHistory() — Used for recording a conversion history record
- getCMSFields() — Gets fields used in the cms
- getClassNameNice() — Wrapper for the object's i18n_singular_name()
- getDestinationClass() — Gets the destination class when converting to the final object, by default this simply removes Kapost form the class name
- getKapostChangeTypeNice() — Gets the change type's friendly label
- getToPublishNice() — Gets the publish type's friendly label
- renderPreview() — Handles rendering of the preview for this object
- sanitizeHTML() — Strips out not allowed tags, mainly this is to remove the kapost beacon script so it doesn't conflict with the cms
- scaffoldSearchFields() — Ensures the content type appears in the searchable fields
- summaryFields() — Gets the summary fields for this object
- validate_incoming() — Validation to be performed when object is being ingested from Kapost