SilverWare\Social\Model\SharingButton
An extension of the component class for a sharing button.
- Author: Colin Tucker <colin@praxis.net.au>
- Copyright: 2017 Praxis Interactive
- License: https://opensource.org/licenses/BSD-3-Clause BSD-3-Clause
Synopsis
class SharingButton
extends Component
{
- // members
- private static string $singular_name = 'Sharing Button';
- private static string $plural_name = 'Sharing Buttons';
- private static string $description = 'A component which represents a sharing button';
- private static string $icon = 'silverware/social: admin/client/dist/images/icons/SharingButton.png';
- private static string $table_name = 'SilverWare_SharingButton';
- private static string $hide_ancestor = Component::class;
- private static array|string $allowed_children = 'none';
- // methods
- public RequiredFields getCMSValidator()
- public string getButtonLink()
- public string getCurrentPageLink()
- public string getCurrentPageTitle()
- public DBHTMLText|string renderSelf()
Hierarchy
Extends
- SilverWare\Model\Component
Members
private
- $allowed_children
—
SilverWare\Social\Model\array|string
Defines the allowed children for 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
- getButtonLink() — Answers the link for the sharing button.
- getCMSValidator() — Answers a validator for the CMS interface.
- getCurrentPageLink() — Answers the link for the current page.
- getCurrentPageTitle() — Answers the title for the current page.
- renderSelf() — Renders the object for the HTML template.