clyons-eis/silverstripe-metadataobject

Provide basic MetaData for custom DataObjects; declare default functions & override as needed

dev-master 2015-04-07 20:00 UTC

This package is not auto-updated.

Last update: 2024-06-08 16:10:07 UTC


README

##Requirements

  • Silverstripe 3.1+

##Installation

  • Install to silverstripe root
  • dev/build?flush=1

##Introduction MetaDataObject allows you to apply basic MetaData to any DataObject including MetaTitle, MetaDescription, og:title, og:description, and og:image. Default functions can be optionally declared to supply dynamic fallback data. CMS interfaces for each of the fields are also provided in a 'Meta' tab, allowing overrides. The field data is always preferred if set.

##Usage Apply the extension to your custom DataObject class.

CustomDataObject:
  extensions:
    - 'MetaDataObject'

Optional - provide fallback methods for each of the available meta properties on each decorated custom DataObject:

	public function getDefaultMetaTitle()
	{
		return ...;
	}
	public function getDefaultOGTitle()
	{
		return ...;
	}
	public function getDefaultMetaDescription()
	{
		return ...;
	}
	public function getDefaultOGDescription()
	{
		return ...;
	}
	public function getDefaultOGImage()
	{
		return ...;
	}

In your controller action, retrieve the meta data by calling DataObjectMeta on the desired object of the custom class:

	public function view() {
		$item = $this->getItem();
        ...
		$meta = $item->DataObjectMeta();
		return array_merge(
			$meta,
			array(
               'OtherData' => $OtherData
			)
		);
	}

Your template should be set up to display the fields individually, rather than the SS/Simple merged MetaTags per this example. Fallbacks for the title & og:title tags are recommended.

    <title><% if $MetaTitle %>$MetaTitle<% else %>$Title<% end_if %> - $SiteConfig.Title</title>
    <meta name="description" content="$MetaDescription.ATT" />
    <meta property="og:site_name" content="$SiteConfig.Title.ATT" />
    <meta property="og:type" content="website" />
    <% if $OGTitle %><meta property="og:title" content="$OGTitle.ATT" /><% else %><meta property="og:title" content="$Title.ATT" /><% end_if %>
    <meta property="og:description" content="$OGDescription.ATT" />
    <meta property="og:url" content="$AbsoluteLink.ATT" />
	<% if $OGImage %><meta property="og:image" content="<% with $OGImage.SetSize(500,500) %>$AbsoluteURL.ATT<% end_with %>" /><% end_if %>

##About The goal of this module is to be light weight and flexible for use in a variety of controller routing situations. Controller action integration is intentionally not included. For a more fully-featured module to handle viewing DataObjects as pages, see https://github.com/arambalakjian/DataObject-as-Page

##Contributing Pull requests & issues are welcome to make this module more flexible & powerful.