From 96c0444783ff54735f5d98c559507781dd078d8b Mon Sep 17 00:00:00 2001
From: James Brooks <jbrooksuk@me.com>
Date: Sat, 8 Oct 2016 10:37:21 +0100
Subject: [PATCH] Added middleware class headers

---
 app/Http/Middleware/Acceptable.php              | 6 ++++++
 app/Http/Middleware/Admin.php                   | 7 +++++++
 app/Http/Middleware/ApiAuthentication.php       | 7 +++++++
 app/Http/Middleware/Authenticate.php            | 7 +++++++
 app/Http/Middleware/Localize.php                | 7 +++++++
 app/Http/Middleware/ReadyForUse.php             | 7 +++++++
 app/Http/Middleware/RedirectIfAuthenticated.php | 7 +++++++
 app/Http/Middleware/SubscribersConfigured.php   | 6 ++++++
 app/Http/Middleware/Timezone.php                | 6 ++++++
 9 files changed, 60 insertions(+)

diff --git a/app/Http/Middleware/Acceptable.php b/app/Http/Middleware/Acceptable.php
index 2c22a6a21..7db135063 100644
--- a/app/Http/Middleware/Acceptable.php
+++ b/app/Http/Middleware/Acceptable.php
@@ -15,6 +15,12 @@ use Closure;
 use Illuminate\Http\Request;
 use Symfony\Component\HttpKernel\Exception\NotAcceptableHttpException;
 
+/**
+ * This is the acceptable middleware class.
+ *
+ * @author Graham Campbell <james@alt-three.com>
+ * @author James Brooks <james@alt-three.com>
+ */
 class Acceptable
 {
     /**
diff --git a/app/Http/Middleware/Admin.php b/app/Http/Middleware/Admin.php
index 5088b091a..5c83c8214 100644
--- a/app/Http/Middleware/Admin.php
+++ b/app/Http/Middleware/Admin.php
@@ -16,6 +16,13 @@ use Illuminate\Contracts\Auth\Guard;
 use Illuminate\Http\Request;
 use Symfony\Component\HttpKernel\Exception\HttpException;
 
+/**
+ * This is the admin middleware class.
+ *
+ * @author Joseph Cohen <joe@alt-three.com>
+ * @author Graham Campbell <james@alt-three.com>
+ * @author James Brooks <james@alt-three.com>
+ */
 class Admin
 {
     /**
diff --git a/app/Http/Middleware/ApiAuthentication.php b/app/Http/Middleware/ApiAuthentication.php
index f4c10611d..0ae7a0683 100644
--- a/app/Http/Middleware/ApiAuthentication.php
+++ b/app/Http/Middleware/ApiAuthentication.php
@@ -18,6 +18,13 @@ use Illuminate\Database\Eloquent\ModelNotFoundException;
 use Illuminate\Http\Request;
 use Symfony\Component\HttpKernel\Exception\HttpException;
 
+/**
+ * This is the api authentication middleware class.
+ *
+ * @author Joseph Cohen <joe@alt-three.com>
+ * @author Graham Campbell <james@alt-three.com>
+ * @author James Brooks <james@alt-three.com>
+ */
 class ApiAuthentication
 {
     /**
diff --git a/app/Http/Middleware/Authenticate.php b/app/Http/Middleware/Authenticate.php
index 040041319..6139df30c 100644
--- a/app/Http/Middleware/Authenticate.php
+++ b/app/Http/Middleware/Authenticate.php
@@ -16,6 +16,13 @@ use Illuminate\Contracts\Auth\Guard;
 use Illuminate\Http\Request;
 use Symfony\Component\HttpKernel\Exception\HttpException;
 
+/**
+ * This is the authenticate middleware class.
+ *
+ * @author Joseph Cohen <joe@alt-three.com>
+ * @author Graham Campbell <james@alt-three.com>
+ * @author James Brooks <james@alt-three.com>
+ */
 class Authenticate
 {
     /**
diff --git a/app/Http/Middleware/Localize.php b/app/Http/Middleware/Localize.php
index 718e2ddb7..62948a855 100644
--- a/app/Http/Middleware/Localize.php
+++ b/app/Http/Middleware/Localize.php
@@ -16,6 +16,13 @@ use Illuminate\Config\Repository;
 use Illuminate\Http\Request;
 use Jenssegers\Date\Date;
 
+/**
+ * This is the localize middleware class.
+ *
+ * @author James Brooks <james@alt-three.com>
+ * @author Joseph Cohen <joe@alt-three.com>
+ * @author Graham Campbell <james@alt-three.com>
+ */
 class Localize
 {
     /**
diff --git a/app/Http/Middleware/ReadyForUse.php b/app/Http/Middleware/ReadyForUse.php
index 364c7f42a..b6c332816 100644
--- a/app/Http/Middleware/ReadyForUse.php
+++ b/app/Http/Middleware/ReadyForUse.php
@@ -17,6 +17,13 @@ use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Config;
 use Illuminate\Support\Facades\Redirect;
 
+/**
+ * This is the ready for use middleware class.
+ *
+ * @author Graham Campbell <james@alt-three.com>
+ * @author James Brooks <james@alt-three.com>
+ * @author Joseph Cohen <joe@alt-three.com>
+ */
 class ReadyForUse
 {
     /**
diff --git a/app/Http/Middleware/RedirectIfAuthenticated.php b/app/Http/Middleware/RedirectIfAuthenticated.php
index 7b79128b3..57f5958e6 100644
--- a/app/Http/Middleware/RedirectIfAuthenticated.php
+++ b/app/Http/Middleware/RedirectIfAuthenticated.php
@@ -16,6 +16,13 @@ use Illuminate\Contracts\Auth\Guard;
 use Illuminate\Http\RedirectResponse;
 use Illuminate\Http\Request;
 
+/**
+ * This is the redirect if authenticated middleware class.
+ *
+ * @author Graham Campbell <james@alt-three.com>
+ * @author Joseph Cohen <joe@alt-three.com>
+ * @author James Brooks <james@alt-three.com>
+ */
 class RedirectIfAuthenticated
 {
     /**
diff --git a/app/Http/Middleware/SubscribersConfigured.php b/app/Http/Middleware/SubscribersConfigured.php
index 50cdeedb6..d549555f6 100644
--- a/app/Http/Middleware/SubscribersConfigured.php
+++ b/app/Http/Middleware/SubscribersConfigured.php
@@ -15,6 +15,12 @@ use Closure;
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Redirect;
 
+/**
+ * This is the subscribers configured middleware class.
+ *
+ * @author James Brooks <james@alt-three.com>
+ * @author Graham Campbell <james@alt-three.com>
+ */
 class SubscribersConfigured
 {
     /**
diff --git a/app/Http/Middleware/Timezone.php b/app/Http/Middleware/Timezone.php
index 8b56ddbbd..40afe9e06 100644
--- a/app/Http/Middleware/Timezone.php
+++ b/app/Http/Middleware/Timezone.php
@@ -15,6 +15,12 @@ use Closure;
 use Illuminate\Contracts\Config\Repository;
 use Illuminate\Http\Request;
 
+/**
+ * This is the timezone middleware class.
+ *
+ * @author James Brooks <james@alt-three.com>
+ * @author Graham Campbell <james@alt-three.com>
+ */
 class Timezone
 {
     /**