Basically everything

Author: Tam

.editorconfig

@@ -0,0 +1,16 @@
+root = true
+
+[*]
+indent_style = tab
+indent_size = 4
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{yml, json}]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false

.gitattributes

@@ -0,0 +1,7 @@
+README.md       export-ignore
+CHANGELOG.md    export-ignore
+.gitignore      export-ignore
+.gitattributes  export-ignore
+/.idea          export-ignore
+.editorconfig   export-ignore
+/docs           export-ignore

.gitignore

@@ -0,0 +1,31 @@
+### OSX
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+vendor
+node_modules
+hot
+mix-manifest.json
+/.idea

.idea/Notes for Craft CMS.iml

@@ -0,0 +1,2 @@
+## 1.0.0
+- Initial Release

CHANGELOG.md

@@ -0,0 +1,31 @@
+{
+  "name": "ether/notes",
+  "description": "A note taking field type for Craft CMS 3",
+  "version": "1.0.0",
+  "type": "craft-plugin",
+  "license": "MIT",
+  "minimum-stability": "dev",
+  "require": {
+    "craftcms/cms": "^3.5"
+  },
+  "autoload": {
+    "psr-4": {
+      "ether\\notes\\": "src/"
+    }
+  },
+  "support": {
+    "email": "[email protected]",
+    "docs": "https://docs.ethercreative.co.uk/notes",
+    "source": "https://github.com/ethercreative/notes",
+    "issues": "https://github.com/ethercreative/notes/issues"
+  },
+  "extra": {
+    "handle": "notes",
+    "name": "Notes",
+    "developer": "Ether Creative",
+    "developerUrl": "https://ethercreative.co.uk",
+
+    "class": "ether\\notes\\Notes",
+    "schemaVersion": "1.0.0"
+  }
+}

composer.json

@@ -0,0 +1,121 @@
+<?php
+/**
+ * Notes for Craft CMS
+ *
+ * @link      https://ethercreative.co.uk
+ * @copyright Copyright (c) 2020 Ether Creative
+ */
+
+namespace ether\notes;
+
+use Craft;
+use craft\base\ElementInterface;
+use craft\db\Query;
+use craft\elements\User;
+use craft\helpers\ArrayHelper;
+use craft\helpers\DateTimeHelper;
+use ether\notes\web\NotesAsset;
+use yii\db\Expression;
+
+/**
+ * Class Field
+ *
+ * @author  Ether Creative
+ * @package ether\notes
+ */
+class Field extends \craft\base\Field
+{
+
+	public static $table = '{{%notes}}';
+	public static $dateFormat = 'M j, Y g:ia';
+
+	/** @var bool Will allow the deleting of notes if true */
+	public $allowDeleting = false;
+
+	public static function displayName (): string
+	{
+		return Craft::t('notes', 'Notes');
+	}
+
+	public static function hasContentColumn (): bool
+	{
+		return false;
+	}
+
+	public static function supportedTranslationMethods (): array
+	{
+		return [
+			self::TRANSLATION_METHOD_NONE,
+			self::TRANSLATION_METHOD_SITE,
+		];
+	}
+
+	public function normalizeValue ($value, ElementInterface $element = null)
+	{
+		if (!$element)
+			return [];
+
+		$where = [
+			'elementId' => $element->id,
+		];
+
+		if ($this->getIsTranslatable($element))
+			$where['siteId'] = $element->siteId;
+
+		$rawNotes = (new Query())
+			->select('id, note, userId, dateCreated')
+			->from(self::$table)
+			->where($where)
+			->orderBy('dateCreated desc')
+			->all();
+
+		$select = <<<SQL
+[[elements]].[[id]],
+CASE WHEN NULLIF([[users.firstName]], '') is null THEN [[users.username]] ELSE CONCAT([[users.firstName]], " ", [[users.lastName]]) END
+SQL;
+
+		$users = User::find()
+			->select(new Expression($select))
+			->id(ArrayHelper::getColumn($rawNotes, 'userId'))
+			->pairs();
+
+		$notes = [];
+
+		foreach ($rawNotes as $note)
+		{
+			$notes[] = new Note([
+				'id' => $note['id'],
+				'note' => $note['note'],
+				'author' => $users[$note['userId']],
+				'userId' => $note['userId'],
+				'date' => DateTimeHelper::toDateTime($note['dateCreated'])->format(self::$dateFormat),
+			]);
+		}
+
+		return $notes;
+	}
+
+	public function getSettingsHtml ()
+	{
+		return Craft::$app->getView()->renderTemplate('notes/settings', [
+			'allowDeleting' => $this->allowDeleting,
+		]);
+	}
+
+	protected function inputHtml ($value, ElementInterface $element = null): string
+	{
+		if (!$element || !$element->id)
+			return Craft::t('notes', 'You must save the element before you can add notes!');
+
+		$view =  Craft::$app->getView();
+		$view->registerAssetBundle(NotesAsset::class);
+
+		return $view->renderTemplate('notes/field', [
+			'ns' => $this->handle,
+			'element' => $element,
+			'notes' => $value,
+			'allowDeleting' => $this->allowDeleting,
+		]);
+	}
+
+}

icon.svg

@@ -0,0 +1,34 @@
+<?php
+/**
+ * Notes for Craft CMS
+ *
+ * @link      https://ethercreative.co.uk
+ * @copyright Copyright (c) 2020 Ether Creative
+ */
+
+namespace ether\notes;
+
+use craft\base\Model;
+use craft\elements\User;
+
+/**
+ * Class Note
+ *
+ * @author  Ether Creative
+ * @package ether\notes
+ */
+class Note extends Model
+{
+
+	public $id;
+	public $note;
+	public $author;
+	public $userId;
+	public $date;
+
+	public function getUser ()
+	{
+		return User::findOne(['id' => $this->userId]);
+	}
+
+}

src/Field.php

@@ -0,0 +1,41 @@
+<?php
+/**
+ * Notes for Craft CMS
+ *
+ * @link      https://ethercreative.co.uk
+ * @copyright Copyright (c) 2020 Ether Creative
+ */
+
+namespace ether\notes;
+
+use craft\base\Plugin;
+use craft\events\RegisterComponentTypesEvent;
+use craft\services\Fields;
+use yii\base\Event;
+
+/**
+ * Class Notes
+ *
+ * @author  Ether Creative
+ * @package ether\notes
+ */
+class Notes extends Plugin
+{
+
+	public function init ()
+	{
+		parent::init();
+
+		Event::on(
+			Fields::class,
+			Fields::EVENT_REGISTER_FIELD_TYPES,
+			[$this, 'onRegisterFieldTypes']
+		);
+	}
+
+	public function onRegisterFieldTypes (RegisterComponentTypesEvent $event)
+	{
+		$event->types[] = Field::class;
+	}
+
+}

src/Note.php

@@ -0,0 +1,48 @@
+<?php
+/**
+ * Notes for Craft CMS
+ *
+ * @link      https://ethercreative.co.uk
+ * @copyright Copyright (c) 2020 Ether Creative
+ */
+
+namespace ether\notes\controllers;
+
+use Craft;
+use craft\elements\User;
+use craft\web\Controller;
+use DateTime;
+use ether\notes\Field;
+
+/**
+ * Class FieldController
+ *
+ * @author  Ether Creative
+ * @package ether\notes\controllers
+ */
+class FieldController extends Controller
+{
+
+	public function actionAdd ()
+	{
+		$request = Craft::$app->getRequest();
+
+		$siteId = $request->getRequiredBodyParam('siteId');
+		$elementId = $request->getRequiredBodyParam('elementId');
+		$userId = $request->getRequiredBodyParam('userId');
+		$note = $request->getRequiredBodyParam('note');
+
+		Craft::$app->getDb()->createCommand()
+			->insert(
+				Field::$table,
+				compact('siteId', 'elementId', 'userId', 'note')
+			)
+			->execute();
+
+		$user = User::findOne(['id' => $userId]);
+		$meta = $user->fullName ?: $user->username . ' &bull; ' . (new DateTime())->format(Field::$dateFormat);
+
+		return $this->asJson(compact('meta'));
+	}
+
+}