SilverWare\MailChimp\Components\MailChimpSignup
An extension of the base component class for a MailChimp signup component.
- Author: Colin Tucker <colin@praxis.net.au>
- Copyright: 2017 Praxis Interactive
- License: https://opensource.org/licenses/BSD-3-Clause BSD-3-Clause
Synopsis
class MailChimpSignup
extends BaseComponent
{
- // members
- private static string $singular_name = 'MailChimp Signup';
- private static string $plural_name = 'MailChimp Signups';
- private static string $description = 'A component to show a MailChimp signup form';
- private static string $icon = 'silverware/mailchimp: admin/client/dist/images/icons/MailChimpSignup.png';
- private static string $table_name = 'SilverWare_MailChimpSignup';
- private static string $hide_ancestor = BaseComponent::class;
- private static array $db = ;
- private static array $defaults = ;
- private static array|string $allowed_children = 'none';
- // methods
- public FieldList getCMSFields()
- public array fieldLabels()
- public void populateDefaults()
- public boolean isDisabled()
Hierarchy
Extends
- SilverWare\Components\BaseComponent
Members
private
- $allowed_children
—
SilverWare\MailChimp\Components\array|string
Defines the allowed children for this object. - $db
—
array
Maps field names to field types for this object. - $defaults
—
array
Defines the default values for the fields of this object. - $description
—
string
Description of this object. - $hide_ancestor
—
string
Defines an ancestor class to hide from the admin interface. - $icon
—
string
Icon file for this object. - $plural_name
—
string
Human-readable plural name. - $singular_name
—
string
Human-readable singular name. - $table_name
—
string
Defines the table name to use for this object.
Methods
public
- fieldLabels() — Answers the labels for the fields of the receiver.
- getCMSFields() — Answers a list of field objects for the CMS interface.
- isDisabled() — Answers true if the object is disabled within the template.
- populateDefaults() — Populates the default values for the fields of the receiver.