Public Member Functions | |
| __construct ($model, $attribute, $form=null, array $params=array()) | |
| render () | |
| getEditableNameIds () | |
| getAttribute () | |
| renderAsControlNonEditable () | |
Static Public Member Functions | |
| static | getDisplayName () |
| static | isReadOnly () |
| static | resolveInputNameForEditableInput ($attributeName) |
| static | resolveInputNamePrefixIntoString ($inputNamePrefix) |
| static | resolveInputIdPrefixIntoString ($inputIdPrefix) |
Data Fields | |
| $params | |
| $editableTemplate = '<th>{label}</th><td colspan="{colspan}">{content}{error}</td>' | |
| $nonEditableTemplate = '<th>{label}</th><td colspan="{colspan}">{content}</td>' | |
Protected Member Functions | |
| renderLabel () | |
| resolveIdForLabel () | |
| getFormattedAttributeLabel () | |
| resolveNonActiveFormFormattedLabel ($label) | |
| renderError () | |
| renderScopedErrorId ($inputNameIdPrefix, $attribute) | |
| renderEditable () | |
| renderNonEditable () | |
| renderControlEditable () | |
| renderControlNonEditable () | |
| getColumnSpan () | |
| getDisabledValue () | |
| getHtmlOptions () | |
| resolveContentTemplate ($template, $data) | |
| getEditableInputId ($attributeName=null, $relationAttributeName=null) | |
| getEditableInputName ($attributeName=null, $relationAttributeName=null) | |
| resolveInputPrefix () | |
| resolveInputIdPrefix () | |
| resolveInputNamePrefix () | |
| getListViewGridId () | |
Protected Attributes | |
| $model | |
| $attribute | |
| $form | |
Abstraction of the various view elements. Examples include Text fields, checkboxes, and date fields.
Element can render an editable or non-editable version and will populate information based on the provided attribute and model.
Definition at line 44 of file Element.php.
| __construct | ( | $ | model, | |
| $ | attribute, | |||
| $ | form = null, |
|||
| array $ | params = array() | |||
| ) |
Constructs the element specifying the model and attribute. In the case of needing to show editable information, a form is also provided.
| $form | Optional. If supplied an editable element will be rendered. | |
| $params | Can have additional parameters for use. 'wide' true or false is an example parameter |
Reimplemented in CommentsElement, ContactStateDropDownElement, ImportMappingRuleContactStatesDropDownElement, AttributeLabelElement, PluralModuleLabelElement, SingularModuleLabelElement, EmailMessageAllRecipientTypesElement, EmailTemplateElement, ImportMappingRuleDefaultModelNameIdElement, ImportMappingModelIdValueTypeDropDownElement, ImportMappingRelatedModelValueTypeDropDownElement, ImportMappingRuleDateFormatDropDownElement, ImportMappingRuleDateTimeFormatDropDownElement, ImportMappingRuleDefaultDropDownFormElement, ImportMappingRuleDefaultMultiSelectDropDownFormElement, ImportMappingUserValueTypeDropDownElement, MemcacheTextElement, ImportMappingRulePriceFrequencyDropDownElement, ImportMappingRuleProductTemplateStatusDropDownElement, ImportMappingRuleProductTemplateTypeDropDownElement, ImportMappingRuleSellPriceFormulaTypeDropDownElement, ImportMappingRuleProjectStatusDropDownElement, ChartTypeRadioStaticDropDownForReportElement, MixedDateTypesForReportElement, StaticDropDownForReportElement, ImportMappingRuleTaskStatusDropDownElement, ImportMappingRuleCurrencyStaticDropDownElement, ImportMappingRuleLanguageStaticDropDownElement, ImportMappingRuleLocaleStaticDropDownElement, ImportMappingRuleTimeZoneStaticDropDownElement, ImportMappingRuleUserStatusDropDownElement, MixedDateTypesForWorkflowElement, MultiSelectStaticDropDownForWorkflowElement, StaticDropDownForWorkflowElement, ImageElement, and ThemeColorConfigurationElement.
Definition at line 66 of file Element.php.
| render | ( | ) |
Generates the element content.
Reimplemented in NoCellNullElement.
Definition at line 80 of file Element.php.
| renderLabel | ( | ) | [protected] |
Generate the element label content
Reimplemented in AnyMixedAttributesSearchElement, DateTimeCreatedUserElement, DateTimeModifiedUserElement, DropDownDependencyElement, DurationElement, FullNameElement, MultiSelectRelatedModelsAutoCompleteElement, NameIdElement, StateToggleElement, TagCloudElement, TitleFullNameElement, UniqueIdentifierElement, FilterByRadioElement, KanbanBoardOptionsElement, ListAttributesSelectionElement, MenuItemsSelectionElement, MixedDateTypesElement, MixedNumberTypesElement, ModelElement, NullElement, RadioDropDownElement, ReadOnlyElement, RelatedAttributeArrayDropDownElement, RelatedItemsElement, UpdateAccountLatestActivityDateTimeElement, ActivitySummaryElement, LatestActivitiesMashableFilterRadioElement, LatestActivitiesOwnedByFilterRadioElement, LatestActivitiesRollUpFilterRadioElement, EnableTrackingCheckBoxElement, CampaignItemStageFilterRadioElement, SupportsRichTextCheckBoxElement, CommentsElement, AnyContactNameIdElement, UpdateContactLatestActivityDateTimeElement, DerivedExplicitReadWritePermissionsContactWebFormElement, SortableContactWebFormAttributesElement, ConversationLatestElement, AttributeTypeElement, AttributeLabelElement, LabelElement, ModuleGlobalSearchAttributesElement, EmailMessageAllRecipientTypesElement, EmailMessageBccRecipientsElement, EmailMessageCcRecipientsElement, EmailMessageToRecipientsElement, OutgoingEmailMessageRecipientBaseElement, EmailAddressInformationElement, EmailMessageContentElement, EmailMessageSenderElement, EmailTemplateHtmlAndTextContentElement, EmailTemplateElement, EmailTemplateModelClassNameElement, ImportFileUploadElement, ImportResultsFilterRadioElement, ImportRulesTypeRadioDropDownElement, AllStatesContactElement, LeadElement, LeadsConvertToAccountRadioElement, LeadsConvertToOpportunityRadioElement, MarketingMetricsGroupByRadioElement, TogglePrimaryOrSecondaryInputRadioElement, MarketingListsSubscriptionTypeFilterRadioElement, MashableInboxSummaryElement, MashableInboxSearchElement, MeetingDaySummaryElement, MissionStatusElement, MissionLatestElement, MissionsListTypeFilterRadioElement, OpportunityTimeInStageElement, ProductStageFilterRadioElement, ParentProductCategoryElement, SellPriceFormulaTypeDropDownElement, SocialItemAndCommentsElement, CloseTaskCheckBoxElement, TaskCheckListItemsListElement, BaseNotificationElement, DerivedExplicitReadWritePermissionsUserConfigElement, DerivedUserStatusElement, PolicyEffectivePasswordExpiryElement, PolicyPasswordExpiryElement, DesktopNotificationElement, HideFromSelectingElement, NotificationConfigurationTableHeadElement, OutboundSettingsCheckBoxElement, OutboundSettingsDropdownElement, CurrencyValueAndCurrencyIdForWorkflowActionAttributeElement, ByTimeWorkflowInQueueSummaryElement, WorkflowMessageInQueueSummaryElement, MixedAttributeTypesForWorkflowActionAttributeElement, AddressElement, AuditEventElement, BaseDomainElement, CurrencyValueElement, CustomThemeColorArrayElement, CalculatedNumberElement, DerivedExplicitReadWriteModelPermissionsElement, FilesElement, ModuleForWizardModelRadioDropDownElement, ExplicitReadWriteModelPermissionsElement, PolicyIntegerAndStaticDropDownElement, and SettingsLogoFileUploadElement.
Definition at line 94 of file Element.php.
| renderError | ( | ) | [protected] |
Generate the error content. Used by editable content
Reimplemented in DropDownDependencyElement, DurationElement, MultiSelectRelatedModelsAutoCompleteElement, NameIdElement, TagCloudElement, TitleFullNameElement, DropDownElement, MixedDateTypesElement, MixedNumberTypesElement, MultiSelectDropDownElement, RelatedAttributeArrayDropDownElement, RelatedItemsElement, StaticDropDownElement, UpdateAccountLatestActivityDateTimeElement, ContactStateDropDownElement, UpdateContactLatestActivityDateTimeElement, SortableContactWebFormAttributesElement, LabelElement, EmailMessageAllRecipientTypesElement, EmailMessageBccRecipientsElement, EmailMessageCcRecipientsElement, EmailMessageToRecipientsElement, OutgoingEmailMessageRecipientBaseElement, EmailAddressInformationElement, EmailMessageSenderElement, SendATestEmailToElement, TestImapConnectionElement, EmailTemplateHtmlAndTextContentElement, EmailTemplateElement, ImportFileUploadElement, SellPriceFormulaInformationElement, MixedChartRangeAndSeriesElement, TaskModalUserElement, TaskStatusDropDownElement, DerivedUserStatusElement, PolicyPasswordExpiryElement, SuperAdministratorToUseElement, CurrencyValueAndCurrencyIdForWorkflowActionAttributeElement, MixedAttributeTypesForWorkflowActionAttributeElement, AddressElement, CurrencyDropDownElement, CurrencyDropDownFormElement, CurrencyIdForAModelsRelatedCurrencyValueDropDownElement, CurrencyValueElement, CalculatedNumberElement, FilesElement, ExplicitReadWriteModelPermissionsElement, SettingsLogoFileUploadElement, and TestLdapConnectionElement.
Definition at line 139 of file Element.php.
| renderScopedErrorId | ( | $ | inputNameIdPrefix, | |
| $ | attribute | |||
| ) | [protected] |
For related models such as Email, Address, and CurrencyValue, a scoped error id is required. This is because we treat those related attributes effectively on the base model for showing validation errors.
| string | $inputNameIdPrefix | |
| string | $attribute |
Definition at line 152 of file Element.php.
| renderEditable | ( | ) | [protected] |
Generate editable version of the element includes the lable, control, and error content
Reimplemented in DropDownDependencyElement, FullNameElement, StateToggleElement, UniqueIdentifierElement, EditableDropDownCollectionElement, MixedDateTypesElement, NullElement, ReadOnlyElement, TextAreaElement, ActivitySummaryElement, ConversationLatestElement, CalculatedNumberFormulaElement, ArchivedEmailMatchingElement, MashableInboxSummaryElement, MeetingDaySummaryElement, MissionStatusElement, MissionLatestElement, OpportunityTimeInStageElement, SocialItemAndCommentsElement, CloseTaskCheckBoxElement, PolicyEffectivePasswordExpiryElement, MixedLoggedInUserTypesAndUsersElement, ByTimeWorkflowInQueueSummaryElement, WorkflowMessageInQueueSummaryElement, AuditEventElement, and MixedDateTypesForWizardElement.
Definition at line 164 of file Element.php.
| renderNonEditable | ( | ) | [protected] |
Generate non-editable version of the element includes label and control elements
Reimplemented in DropDownDependencyElement, ProjectForTaskElement, and CalculatedNumberElement.
Definition at line 179 of file Element.php.
| getColumnSpan | ( | ) | [protected] |
Determines correct column span based on params 'wide' value
Definition at line 195 of file Element.php.
| getEditableNameIds | ( | ) |
Get the collection of id/names of inputs and other parts of the element.
Reimplemented in DropDownElement, and ModelElement.
Definition at line 229 of file Element.php.
| resolveContentTemplate | ( | $ | template, | |
| $ | data | |||
| ) | [protected] |
Resolves the editable or non-editable template with data.
Definition at line 253 of file Element.php.
| getEditableInputId | ( | $ | attributeName = null, |
|
| $ | relationAttributeName = null | |||
| ) | [protected] |
An input Id is typically formed like: modelClassName_attributeName or modelClassName_attributeName_relationAttributeName. This method resolves the input Id string.
| string | $attributeName | |
| string | $relationAttributeName |
Reimplemented in MultiSelectRelatedModelsAutoCompleteElement, TagCloudElement, MultipleGroupsAndUsersElement, and MentionableTextAreaElement.
Definition at line 277 of file Element.php.
| getEditableInputName | ( | $ | attributeName = null, |
|
| $ | relationAttributeName = null | |||
| ) | [protected] |
An input name is typically formed like: modelClassName[attributeName] or modelClassName[attributeName][relationAttributeName]. This method resolves the input name string. Also handles scenarios where attributeName has something like abc[def]. This method will properly account for that.
| string | $attributeName | |
| string | $relationAttributeName |
Reimplemented in MultiSelectRelatedModelsAutoCompleteElement, TagCloudElement, and MultipleGroupsAndUsersElement.
Definition at line 303 of file Element.php.
| static resolveInputNameForEditableInput | ( | $ | attributeName | ) | [static] |
| string | $attributeName |
Definition at line 325 of file Element.php.
| resolveInputPrefix | ( | ) | [protected] |
An input Id or name is typically constructed like: modelClassName[attributeName]. The 'modelClassName' is considered the prefix of the input. Any inputPrefix specified in the parameters coming into the element will be used, otherwise the model class name will be utilized.
Definition at line 340 of file Element.php.
