SilverWare\Social\Icons\EmailSharingIcon
An extension of the sharing icon class for an email sharing icon.
- Author: Colin Tucker <colin@praxis.net.au>
- Copyright: 2018 Praxis Interactive
- License: https://opensource.org/licenses/BSD-3-Clause BSD-3-Clause
Synopsis
class EmailSharingIcon
extends SharingIcon
{
- // Inherited constants from SharingIcon
- const PLACEMENT_AUTO = 'auto';
- const PLACEMENT_TOP = 'top';
- const PLACEMENT_LEFT = 'left';
- const PLACEMENT_RIGHT = 'right';
- const PLACEMENT_BOTTOM = 'bottom';
- // members
- private static string $singular_name = 'Email Sharing Icon';
- private static string $plural_name = 'Email Sharing Icons';
- private static string $description = 'A sharing icon to share the current page via email';
- private static string $table_name = 'SilverWare_EmailSharingIcon';
- private static string $hide_ancestor = SharingIcon::class;
- private static array $defaults = ;
- private static string $button_class = EmailSharingButton::class;
- // Inherited methods from SharingIcon
- public RequiredFields getCMSValidator()
- public array getAttributes()
- public array getDataAttributes()
- public array getClassNames()
- public string getIconSizeClass()
- public string getPlacement()
- public DBHTMLText|string renderSelf()
- public DBHTMLText|string renderContent()
- public array getIconSizeOptions()
- public array getPlacementOptions()
- public SharingButton getButton()
Hierarchy
Constants
Name | Value |
---|---|
PLACEMENT_AUTO | 'auto' |
PLACEMENT_TOP | 'top' |
PLACEMENT_LEFT | 'left' |
PLACEMENT_RIGHT | 'right' |
PLACEMENT_BOTTOM | 'bottom' |
Members
private
- $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. - $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
Inherited from SilverWare\Social\Model\SharingIcon
public
- getAttributes() — Answers an array of HTML tag attributes for the object.
- getButton() — Answers the sharing button instance for the receiver.
- getCMSValidator() — Answers a validator for the CMS interface.
- getClassNames() — Answers an array of class names for the HTML template.
- getDataAttributes() — Answers an array of data attributes for the receiver.
- getIconSizeClass() — Answers the icon size class for the receiver.
- getIconSizeOptions() — Answers an array of options for an icon size field.
- getPlacement() — Answers the popover placement for the receiver.
- getPlacementOptions() — Answers an array of options for a placement field.
- renderContent() — Renders the content for the HTML template.
- renderSelf() — Renders the component for the HTML template.