Init

Author: Otis Wright

.editorconfig

@@ -0,0 +1,17 @@
+# For more information about the properties used in this file,
+# please see the EditorConfig documentation:
+# http://editorconfig.org
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[{*.yml,package.json}]
+indent_size = 2
+
+# The indent size used in the package.json file cannot be changed:
+# https://github.com/npm/npm/pull/3180#issuecomment-16336516

.gitattributes

@@ -0,0 +1 @@
+/.gitignore export-ignore

.scrutinizer.yml

@@ -0,0 +1,69 @@
+inherit: true
+
+checks:
+  php:
+    verify_property_names: true
+    verify_argument_usable_as_reference: true
+    verify_access_scope_valid: true
+    useless_calls: true
+    use_statement_alias_conflict: true
+    variable_existence: true
+    unused_variables: true
+    unused_properties: true
+    unused_parameters: true
+    unused_methods: true
+    unreachable_code: true
+    too_many_arguments: true
+    sql_injection_vulnerabilities: true
+    simplify_boolean_return: true
+    side_effects_or_types: true
+    security_vulnerabilities: true
+    return_doc_comments: true
+    return_doc_comment_if_not_inferrable: true
+    require_scope_for_properties: true
+    require_scope_for_methods: true
+    require_php_tag_first: true
+    psr2_switch_declaration: true
+    psr2_class_declaration: true
+    property_assignments: true
+    prefer_while_loop_over_for_loop: true
+    precedence_mistakes: true
+    precedence_in_conditions: true
+    phpunit_assertions: true
+    php5_style_constructor: true
+    parse_doc_comments: true
+    parameter_non_unique: true
+    parameter_doc_comments: true
+    param_doc_comment_if_not_inferrable: true
+    optional_parameters_at_the_end: true
+    one_class_per_file: true
+    no_unnecessary_if: true
+    no_trailing_whitespace: true
+    no_property_on_interface: true
+    no_non_implemented_abstract_methods: true
+    no_error_suppression: true
+    no_duplicate_arguments: true
+    no_commented_out_code: true
+    newline_at_end_of_file: true
+    missing_arguments: true
+    method_calls_on_non_object: true
+    instanceof_class_exists: true
+    foreach_traversable: true
+    fix_line_ending: true
+    fix_doc_comments: true
+    duplication: true
+    deprecated_code_usage: true
+    deadlock_detection_in_loops: true
+    code_rating: true
+    closure_use_not_conflicting: true
+    catch_class_exists: true
+    blank_line_after_namespace_declaration: false
+    avoid_multiple_statements_on_same_line: true
+    avoid_duplicate_types: true
+    avoid_conflicting_incrementers: true
+    avoid_closing_tag: true
+    assignment_of_null_return: true
+    argument_type_checks: true
+
+filter:
+  paths: [code/*, tests/*]

README.md

@@ -0,0 +1,57 @@
+# Installation Instructions #
+## Composer ##
+Run the following to add this module as a requirement and install it via composer.
+
+```
+#!bash
+
+composer require "webfox/silverstripe-helpers"
+```
+then browse to /dev/build?flush=all
+
+Several of these helpers are disabled by default but can be enabled in the config.
+
+
+#Requirements#
+* Silverstripe 3.1+
+* php5.4+
+* php5-intl Package 
+
+#Extension Overview#
+
+##DataListExtension##
+ - Adds a new *ListColumn* function to a DataList to allow implode() style functionality of the list items  
+   e.g. `$list->ListColumn('ID', ' |')` would result in something like "1 |18 |19 |24".
+ - Automatically applied
+
+##ExtraPageFieldsExtension##
+ - Moves the metadata fields to a new tab
+ - Adds a new "Meta Title" field
+ - Automatically applied
+ 
+##FooterMenuExtension##
+ - Adds a new *ShowInFooter* option to the page settings
+ - Adds a new `FooterPages()` function to the SiteTree to return only pages that have this checked
+
+##ImageExtension##
+ - Adds a new *Image Alt Text* option to the image settings
+ - Makes the image settings fields full width
+ - Automatically applied
+ 
+##LinkExtension##
+ - Adds a new *SEO Text* option to the link settings
+ - Adds a *force download* checkbox to the link if it's set to a file.
+ - Automatically applied
+
+#Template Providers Overview#
+
+##HelpersTemplateProvider
+ - Adds a new `Repeat($times)` function to the templates to return a loopable list (kind of like a for loop)
+ - Adds a new `Dump($obj)` function to the templates to allow easy dumping of any template variable
+ 
+#Extendable Classes Overview#
+ 
+##OwnerPermissionedDataObject##
+ - Allows data objects to inherit the access permissions from their attached relation parent
+ - Relation parent defaults to `Page()`
+ - If `static::$relationOwner` is set to `null` will fall back to asking the standard `Page` for permission

_config/.gitkeep

@@ -0,0 +1,22 @@
+---
+Name: silverstripe-helpers
+---
+DataList:
+  extensions:
+    - DataListExtension
+
+SiteTree:
+  extensions:
+    - ExtraPageFieldsExtension
+
+Image:
+  extensions:
+    - ImageExtension
+
+Link:
+  extensions:
+    - LinkExtension
+
+#SiteTree:
+#  extensions:
+#    - FooterMenuExtension

_config/config.yml

@@ -0,0 +1,42 @@
+<?php
+
+/**
+ * Class DataListExtension
+ *
+ * @property DataList owner
+ */
+class DataListExtension extends Extension
+{
+
+    public function ListColumn($column, $glue = ', ')
+    {
+        return implode($glue, $this->owner->column($column));
+    }
+
+    public function Displayed($visible = true)
+    {
+        $list = clone $this->owner;
+
+        return $list->filter('Displayed', $visible);
+    }
+
+    public function OnlyVisible()
+    {
+        return $this->Displayed(true);
+    }
+
+    public function OnlyHidden()
+    {
+        return $this->Displayed(false);
+    }
+
+    public function WithVisible($relation)
+    {
+        $list = clone $this->owner;
+
+        return $list->filterByCallback(function ($obj) use ($relation) {
+            return $obj->{$relation}()->OnlyVisible()->exists();
+        });
+    }
+
+}

code/DataListExtension.php

@@ -0,0 +1,84 @@
+<?php
+
+/**
+ * Class ExtraPageFieldsExtension
+ *
+ */
+class ExtraPageFieldsExtension extends SiteTreeExtension
+{
+
+    private $MetaDescriptionLength = 156;
+
+    private static $db = array(
+        'SubTitle'   => 'Text',
+        'MetaTitle'  => 'Text',
+        'MenuTarget' => 'Varchar(255)'
+    );
+
+    public function updateCMSFields(FieldList $fields)
+    {
+
+        //change Page Name label to Primary Heading - H1 - Only if the title hasn't already been changed
+        /** @var TextField $titleField */
+        $titleField = $fields->dataFieldByName('Title');
+        if ($titleField->Title() == 'Page name') {
+            $fields->renameField('Title', 'Primary Heading');
+        }
+
+        //Add secondary heading - H2
+        $fields->insertAfter(TextField::create('SubTitle', 'Secondary Heading'), 'Title');
+
+        //Move meta fields to their own tab
+
+        /** @var ToggleCompositeField $metaDataChildren */
+        $metaDataChildren = $fields->fieldByName('Root.Main.Metadata');
+//		ddd($metaDataChildren->fieldByName('MetaDescription'));
+        $children = array_merge([$metaTitle = TextField::create('MetaTitle')], $metaDataChildren->getChildren()->toArray());
+        $fields->removeFieldFromTab('Root.Main', 'Metadata');
+        $fields->addFieldToTab('Root', Tab::create('Metadata'), 'Content');
+
+        //Add META Title tag to METADATA
+        $length = $this->owner->config()->MetaDescriptionLength ?: $this->MetaDescriptionLength;
+        $metaDataChildren->fieldByName('MetaDescription')->setAttribute('maxlength', $length);
+        $fields->addFieldsToTab('Root.Metadata', $children);
+
+        $metaTitle->setDescription('Displayed as the tab/window name; Also displayed in search engine result listings as the page title.<br />
+									Falls back to the Primary Heading field if not provided.');
+
+    }
+
+    public function updateSettingsFields(FieldList $fields)
+    {
+        //quick links option
+        $fields->addFieldToTab("Root.Settings", new DropdownField('MenuTarget', 'Open page in', [
+            ''       => 'Current Tab (Browser default)',
+            '_blank' => 'New Tab'
+        ]));
+    }
+
+    Public function MenuTarget()
+    {
+        return empty($this->owner->MenuTarget) ? '' : "target=\"{$this->owner->MenuTarget}\"";
+    }
+
+    Public function MetaTags(& $tags) {
+        if(is_a(Director::get_current_page(), 'Security')){
+            $tags = $tags . '<meta name="robots" content="noindex">';
+        } 
+    }
+
+    public function onBeforeWrite()
+    {
+        parent::onBeforeWrite();
+
+        $length = $this->owner->config()->MetaDescriptionLength ?: $this->MetaDescriptionLength;
+        if (strlen($this->owner->MetaDescription) > $length) {
+            /** @var Text $value */
+            $value                        = $this->owner->dbObject('MetaDescription');
+            $value                        = $value->LimitCharacters($length);
+            $this->owner->MetaDescription = $value;
+        };
+    }
+}
+
+

code/ExtraPageFieldsExtension.php

@@ -0,0 +1,22 @@
+<?php
+
+/**
+ * Class FooterMenuExtension
+ *
+ */
+class FooterMenuExtension extends SiteTreeExtension {
+
+	private static $db = array(
+			'ShowInFooter' => 'Boolean'
+	);
+	
+	public function updateSettingsFields(FieldList $fields) {
+		//quick links option
+		$fields->addFieldToTab("Root.Settings", new CheckBoxField('ShowInFooter', 'Show in footer menu?'), 'ShowInSearch');
+	}
+	
+	Public function FooterPages(){
+		return SiteTree::get()->filter('ShowInFooter', true);
+	}
+
+}

code/FooterMenuExtension.php

@@ -0,0 +1,27 @@
+<?php
+
+class HelpersTemplateProvider implements TemplateGlobalProvider {
+	/**
+	 * @return array
+	 */
+	public static function get_template_global_variables() {
+		return array(
+			'Repeat',
+			'Dump'
+		);
+	}
+
+	public static function Repeat($times){
+		$list = new ArrayList();
+		$formatter = new NumberFormatter('en-NZ', NumberFormatter::SPELLOUT);
+		for($i = 1; $i <= $times; $i++){
+			$list->push(array('Num' => $i, 'Word' => ucwords(strtolower($formatter->format($i)))));
+		}
+
+		return $list;
+	}
+
+	public static function Dump($object){
+		dd($object);
+	}
+}