g
Frontend | Backend | Api

Common\Models\Backend\Widget

Widget

Method Description Returns
getSettingValue(string $settingName) Get the value for a setting for this widget string
getSettingValues(string $settingName) Get the values for a setting for this widget Collection
getHtml(array $parameters, bool $removeExisting) Get the rendered html content for this widget string
getResponse(array $parameters, bool $removeExisting) Get the Response produced from controller calls for this widget. Does not render the template yet. Response
isBlank() Return the information that this is not a blank widget bool
getId() int
getModule() string
getText() string
getConfigName() string
getName() string
getIdentifier() string
getController() string
getMethod() string
getCreated() DateTime
getModified() DateTime
getSite() Site
getLayout() Layout
getSettings() Collection (WidgetSetting)
isNewRecord() Check if the record is a new record bool
isHierarchicalModel() Check whether a model is a hierarchical model, i.e. can have children bool
getAvailableSettings() array
getAvailableLayouts() Get the available layouts Collection
getSettingWithKey(string $key) Get a setting with the specified key for this widget WidgetSetting
getHateoasLinks() Get the HATEOAS links for the record array
getEditUrl() Get the url for editing the record. string
getDeleteUrl() Get the url for deleting the record. string
getManageUrl() Get the url for managing records. string