README and docblock updates

dynamic · Oct 18, 2023 · 7093783 · 7093783
1 parent 63b2847
commit 7093783
Show file tree

Hide file tree

Showing 12 changed files with 27 additions and 29 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,3 @@
 npm-debug.log
 node_modules/
+.DS_Store
diff --git a/README.md b/README.md
@@ -24,6 +24,28 @@ A block that displays featured content - large image, title, description and lin
 
 See [License](LICENSE.md)
 
+## Usage
+
+A block to display rows of featured content - large image, title, description, and link. Includes an option to alternate the layout of the features from image left to image right.
+
+### Template Notes
+
+The default templates are based off [Bootstrap 5](https://getbootstrap.com/) classes/styling.
+
+## Screen Shots
+
+#### Default Template of a Features Element
+![Default Template of a Features Element](./docs/en/_images/features-block-sample.png)
+
+#### Default Template of a Features Element with Alternate Layout
+![Default Template of a Features Element Alternate](./docs/en/_images/features-block-sample-alt.png)
+
+#### CMS - Features Element Main Tab
+![CMS - Features Block Main Tab](./docs/en/_images/features-block-cms.png)
+
+#### CMS - Features Element - Feature Add/Edit
+![CMS - Features Block Main Tab](./docs/en/_images/features-block-cms-feature.png)
+
 ## Upgrading from version 2
 
 Elemental Features drops `sheadawson/silverstripe-linkable` usage in favor of `gorriecoe/silverstripe-linkfield`. To avoid data loss, install the `dynamic/silverstripe-link-migrator` module as follows:
@@ -39,34 +61,6 @@ vendor/bin/sake dev/tasks/LinkableMigrationTask
 
 This will populate all of the new Link fields with data from the old class.
 
-
-## Usage
-
-A block to display rows of featured content - image, title, description, link.
-
-### Template Notes
-
-The default templates are based off [Bootstrap 4](https://getbootstrap.com/) classes/styling.
-
-Also included in the CMS is a checkbox for an alternate layout option. Both layout options are setup in includes that will work right away.
-
-## Screen Shots
-
-#### Front End sample of a Features Element
-![Front End sample of a Features Element](./docs/en/_images/features-block-sample.jpg)
-
-#### Front End sample of a Features Element Alternate Layout
-![Front End sample of a Features Element](./docs/en/_images/features-block-sample-alt.jpg)
-
-#### CMS - Features Element Main Tab
-![CMS - Features Block Main Tab](./docs/en/_images/features-block-cms.jpg)
-
-#### CMS - Features Element - Features List
-![CMS - Features Block Main Tab](./docs/en/_images/features-block-cms-features-list.jpg)
-
-#### CMS - Features Element - Feature Add/Edit
-![CMS - Features Block Main Tab](./docs/en/_images/features-block-cms-feature.jpg)
-
 ## Getting more elements
 
 See [Elemental modules by Dynamic](https://github.com/orgs/dynamic/repositories?q=elemental&type=all&language=&sort=)

diff --git a/docs/en/_images/features-block-cms-feature.png b/docs/en/_images/features-block-cms-feature.png
diff --git a/docs/en/_images/features-block-cms-features-list.jpg b/docs/en/_images/features-block-cms-features-list.jpg
diff --git a/docs/en/_images/features-block-cms.jpg b/docs/en/_images/features-block-cms.jpg
diff --git a/docs/en/_images/features-block-cms.png b/docs/en/_images/features-block-cms.png
diff --git a/docs/en/_images/features-block-sample-alt.jpg b/docs/en/_images/features-block-sample-alt.jpg
diff --git a/docs/en/_images/features-block-sample-alt.png b/docs/en/_images/features-block-sample-alt.png
diff --git a/docs/en/_images/features-block-sample.jpg b/docs/en/_images/features-block-sample.jpg
diff --git a/docs/en/_images/features-block-sample.png b/docs/en/_images/features-block-sample.png
diff --git a/src/Elements/ElementFeatures.php b/src/Elements/ElementFeatures.php
@@ -16,7 +16,9 @@
 /**
  * Class PageSectionBlock.
  *
- * @method HasManyList $Features
+ * @property string $Content
+ * @property bool $Alternate
+ * @method DataList|FeatureObject[] Features()
  */
 class ElementFeatures extends BaseElement
 {

diff --git a/src/Model/FeatureObject.php b/src/Model/FeatureObject.php
@@ -11,6 +11,7 @@
  *
  * @property int $Sort
  * @property int $ElementFeaturesID
+ * @method ElementFeatures ElementFeatures()
  */
 class FeatureObject extends BaseElementObject
 {