Bug #10/ #14, Initial composer.json & PSR2-based code standard

* PHP_CodeSniffer XML [iet:3633574]
* composer.json [iet:3634843]

.gitignore

@@ -1,6 +1,10 @@
 
 version.json
 
+/composer.lock
+/vendor/*
+/application/engines/mediaelement-x
+
 /git*.php
 /git-pull*
 
@@ -31,6 +35,7 @@ application/language/*.pot
 * copy*
 *OLD*
 *ORIG*
+*BAK
 *.log
 *.mo
 

composer.json

@@ -0,0 +1,112 @@
+{
+  "name": "iet-ou/open-media-player",
+  "description": "A unified, accessible online audio and video player service. Built on MediaElement.js, CodeIgniter & oEmbed. ©2015 The Open University, UK.",
+  "keywords": [ "ouplayer", "MediaPlayer", "audio", "video", "mediaelementjs", "oEmbed", "accessibility", "OpenUniversity", "IET-OU" ],
+  "homepage": "https://mediaplayer.open.ac.uk",
+  "type": "project",
+  "time": "2011-03-10",
+  "license": "proprietary",
+  "minimum-stability": "dev",
+  "authors": [
+    { "name": "Nick Freear (@nfreear)", "role": "developer" },
+    { "name": "Peter Devine (@peterdevinegmd", "role": "designer", "homepage": "http://devine.co.uk/peter/" }
+  ],
+  "support": {
+    "email": "[email protected]",
+    "forum": "https://groups.google.com/forum/#!forum/ou-media-player",
+    "issues": "https://github.com/IET-OU/ouplayer/issues",
+    "source": "https://github.com/IET-OU/ouplayer"
+  },
+  "repositories": [
+    {
+      "type": "package",
+      "package": {
+        "name": "johndyer/mediaelement",
+        "version": "2.17.0",
+        "license": "MIT",
+        "dist": {
+          "url": "https://github.com/johndyer/mediaelement/archive/2.17.0.zip",
+          "type": "zip"
+        },
+        "// - source": {
+          "url": "https://github.com/johndyer/mediaelement.git",
+          "type": "git",
+          "reference": "2.17.0"
+        }
+      }
+    }
+  ],
+  "require": {
+    "php": ">=5.3.3",
+    "mnsami/composer-custom-directory-installer": "1.0.*",
+    "johndyer/mediaelement": "2.17.0"
+  },
+  "require-dev": {
+    "squizlabs/php_codesniffer": "~2.1.0",
+    "jakub-onderka/php-parallel-lint": "~0.8"
+  },
+  "suggest": {
+    "iet-ou/ou-media-player-base": "*; Base classes for themes, providers & extensions",
+    "iet-ou/ou-media-player-ou": "*; OU-only - theme, SAMS auth ...",
+    "iet-ou/ou-embed-providers": "*; oEmbed providers - Google Docs, Prezi ...",
+
+    "nfreear/ou-media-player-test": "*; Remote integration tests.",
+    "IET-OU/mediaelement-demo": "*; Demos for IET-OU enhancements & fixes to MediaElement.js",
+
+    "fancyguy/webroot-installer": "1.1.0",
+    "wikimedia/composer-merge-plugin": "v1.0.0",
+    "nfreear/composer-suggest": "^1.1"
+  },
+  "scripts": {
+    "test-psr2": [
+      "#echo $1",
+      "#export F=application/$1 ;",
+      "#composer validate #--no-interaction",
+      "#parallel-lint application/*",
+      "phpcs --standard=PSR2 -n --encoding=utf-8 --extensions=php application/core/MY_Co*"
+    ],
+    "test-oump": [
+      "phpcs --standard=./phpcs.xml -n --encoding=utf-8 --extensions=php application/core/MY_Co*"
+    ],
+
+    "test-v": [
+      "phpcs --standard=./phpcs.xml -n --encoding=utf-8 --extensions=php application/views/vle_d*"
+    ],
+
+    "fix-psr2": [
+      "phpcbf --standard=PSR2 -n -l  --encoding=utf-8 --extensions=php application/core/MY_Contr*"
+    ],
+    "fix-oump": [
+      "phpcbf --standard=./phpcs.xml -n -l --encoding=utf-8 --extensions=php application/core/MY_Co*"
+    ]
+  },
+  "config": {
+    "preferred-install": "source"
+  },
+  "extra": {
+
+    "webroot-dir": "application/engines/mediaelement-x",
+    "webroot-package": "johndyer/mediaelement",
+
+    "installer-paths": {
+      "./application/engines/mediaelement-x": [ "johndyer/mediaelement" ]
+    },
+
+    "merge-plugin": {
+      "include": [
+        "./shared/composer.json"
+      ]
+    },
+
+    "//": [
+      "http://mediaplayer.open.ac.uk/demo/info#php - 5.4.36",
+      "http://embed.open.ac.uk/demo/info#php - 5.3.3",
+      "https://github.com/IET-OU/ouplayer ../system/core/CodeIgniter.php#L36 - CI 2.1.3",
+      "http://iet-embed-acct.open.ac.uk/docs/CREDITS.txt",
+
+      "TODO:  rm cache/ hooks/ logs/ migrations/ third_party/",
+
+      "https://gist.github.com/nfreear/57262e040d49b2f212ec"
+    ]
+  }
+}

phpcs.xml

@@ -0,0 +1,69 @@
+<?xml version="1.0"?>
+<ruleset name="mediaplayer-open-ac-uk">
+  <description>OU Media Player coding standard - PSR2, almost!</description>
+  <!--
+    Stay as close to PSR-2 as possible, but account for CodeIgniter conventions.
+
+    https://github.com/squizlabs/PHP_CodeSniffer ./Standards/PSR2/ruleset.xml
+    https://github.com/cakephp/cakephp-codesniffer ./CakePHP/ruleset.xml
+    http://edorian.github.io/php-coding-standard-generator/#phpcs
+  -->
+
+  <exclude-pattern>\.git</exclude-pattern>
+  <exclude-pattern>/system/</exclude-pattern>
+  <exclude-pattern>/vendor/</exclude-pattern>
+  <exclude-pattern>*/*.html</exclude-pattern>
+
+  <rule ref="PSR2">
+    <exclude name="PSR2.Methods.MethodDeclaration"/>
+    <!--<exclude name="PSR2.Classes.PropertyDeclaration"/>-->
+  </rule>
+
+  <rule ref="PSR1">
+  <exclude name="PSR1.Methods.CamelCapsMethodName"/>
+  <!--<exclude name="PSR1.Classes.ClassDeclaration"/><!-|- namespace -->
+  <exclude name="PSR1.Files.SideEffects"/>
+  </rule>
+
+  <rule ref="Squiz.Classes">
+    <exclude name="Squiz.Classes.ValidClassName"/>
+  </rule>
+
+  <!--
+    Accept class names like "MY_Controller".
+  -->
+  <rule ref="PEAR.NamingConventions.ValidClassName"/>
+
+
+  <!--<rule ref="Squiz.Arrays.ArrayBracketSpacing"/>-->
+
+  <!--<rule ref="Squiz.Classes.LowercaseClassKeywords"/>-->
+
+  <rule ref="Generic.CodeAnalysis.ForLoopShouldBeWhileLoop"/>
+  <rule ref="Generic.CodeAnalysis.ForLoopWithTestFunctionCall"/>
+  <rule ref="Generic.CodeAnalysis.JumbledIncrementer"/>
+  <rule ref="Generic.CodeAnalysis.UnconditionalIfStatement"/>
+  <rule ref="Generic.CodeAnalysis.UnnecessaryFinalModifier"/>
+
+  <rule ref="Generic.Commenting.Todo"/>
+
+  <rule ref="Generic.Files.LineEndings"/>
+
+  <rule ref="Generic.PHP.DeprecatedFunctions"/>
+  <rule ref="Squiz.PHP.DisallowSizeFunctionsInLoops"/>
+  <rule ref="Squiz.PHP.Eval"/>
+  <rule ref="Generic.PHP.ForbiddenFunctions"/>
+  <rule ref="Squiz.PHP.NonExecutableCode"/>
+  <!--<rule ref="Generic.PHP.NoSilencedErrors"/>-->
+
+  <rule ref="Squiz.Scope.MemberVarScope"/>
+  <rule ref="Squiz.Scope.StaticThisUsage"/>
+
+  <rule ref="Squiz.WhiteSpace.CastSpacing"/>
+  <rule ref="Squiz.WhiteSpace.LanguageConstructSpacing"/>
+  <rule ref="Squiz.WhiteSpace.LogicalOperatorSpacing"/>
+  <rule ref="Squiz.WhiteSpace.SemicolonSpacing"/>
+  <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace"/>
+
+  <!-- All rules in ./Sniffs are included automatically -->
+</ruleset>