Coding standards improvements.

Author: paul-m

README.md

@@ -77,4 +77,3 @@ please search for an issue about it at http://drupal.org/project/issues/examples
 If there isn't already an issue for it, please create a new one.
 
 Thanks.
-

config_entity_example/src/Controller/RobotListBuilder.php

@@ -46,7 +46,7 @@ public function buildHeader() {
   /**
    * Builds a row for an entity in the entity listing.
    *
-   * @param EntityInterface $entity
+   * @param \Drupal\Core\Entity\EntityInterface $entity
    *   The entity for which to build the row.
    *
    * @return array

config_entity_example/src/Form/RobotFormBase.php

@@ -120,7 +120,7 @@ public function buildForm(array $form, FormStateInterface $form_state) {
    *   The entity ID.
    * @param array $element
    *   The form element.
-   * @param FormStateInterface $form_state
+   * @param \Drupal\Core\Form\FormStateInterface $form_state
    *   The form state.
    *
    * @return bool

email_example/email_example.info.yml

@@ -2,7 +2,6 @@ name: Email Example
 type: module
 description: Demonstrates how to send and alter Drupal-generated email messages.
 package: Example modules
-version: 8.x-1.x
 core: 8.x
 dependencies:
   - examples:examples

events_example/events_example.links.menu.yml

@@ -1,4 +1,4 @@
 events_example.description:
   title: 'Events Example'
   description: 'Example of dispatching and subscribing to events.'
-  route_name: events_example.description
+  route_name: events_example.description

events_example/events_example.routing.yml

@@ -5,4 +5,4 @@ events_example.description:
     _form: '\Drupal\events_example\Form\EventsExampleForm'
     _title: 'Events Example'
   requirements:
-    _permission: 'access content'
+    _permission: 'access content'

events_example/events_example.services.yml

@@ -13,4 +13,4 @@ services:
     # \Symfony\Component\EventDispatcher\EventSubscriberInterface
     class: Drupal\events_example\EventSubscriber\EventsExampleSubscriber
     tags:
-      - {name: event_subscriber}
+      - {name: event_subscriber}

fapi_example/src/Form/DemoBase.php

@@ -21,7 +21,7 @@ abstract class DemoBase extends FormBase {
    *
    * @param array $form
    *   The render array of the currently built form.
-   * @param FormStateInterface $form_state
+   * @param \Drupal\Core\Form\FormStateInterface $form_state
    *   Object describing the current state of the form.
    */
   public function submitForm(array &$form, FormStateInterface $form_state) {

fapi_example/src/Form/SimpleForm.php

@@ -24,7 +24,7 @@ class SimpleForm extends FormBase {
    *
    * @param array $form
    *   Default form array structure.
-   * @param FormStateInterface $form_state
+   * @param \Drupal\Core\Form\FormStateInterface $form_state
    *   Object containing current form state.
    *
    * @return array
@@ -77,7 +77,7 @@ public function getFormId() {
    *
    * @param array $form
    *   The render array of the currently built form.
-   * @param FormStateInterface $form_state
+   * @param \Drupal\Core\Form\FormStateInterface $form_state
    *   Object describing the current state of the form.
    */
   public function validateForm(array &$form, FormStateInterface $form_state) {
@@ -95,7 +95,7 @@ public function validateForm(array &$form, FormStateInterface $form_state) {
    *
    * @param array $form
    *   The render array of the currently built form.
-   * @param FormStateInterface $form_state
+   * @param \Drupal\Core\Form\FormStateInterface $form_state
    *   Object describing the current state of the form.
    */
   public function submitForm(array &$form, FormStateInterface $form_state) {

field_permission_example/field_permission_example.info.yml

@@ -2,7 +2,6 @@ name: Field Permission Example
 type: module
 description: Demonstrates how to create a field and implement access control over it.
 package: Example modules
-version: 8.x-1.x
 core: 8.x
 dependencies:
   - drupal:node

file_example/src/Form/FileExampleReadWriteForm.php

@@ -26,28 +26,28 @@ class FileExampleReadWriteForm extends FormBase {
   /**
    * Interface of the "state" service for site-specific data.
    *
-   * @var StateInterface
+   * @var \Drupal\Core\State\StateInterface
    */
   protected $state;
 
   /**
    * Object used to get request data, such as the session.
    *
-   * @var RequestStack
+   * @var \Symfony\Component\HttpFoundation\RequestStack
    */
   protected $requestStack;
 
   /**
    * Service for manipulating a file system.
    *
-   * @var FileSystemInterface
+   * @var \Drupal\Core\File\FileSystemInterface
    */
   protected $fileSystem;
 
   /**
    * Service for fetching a stream wrapper for a file or directory.
    *
-   * @var StreamWrapperManagerInterface
+   * @var \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface
    */
   protected $streamWrapperManager;
 
@@ -61,24 +61,24 @@ class FileExampleReadWriteForm extends FormBase {
   /**
    * Service for invoking hooks and other module operations.
    *
-   * @var ModuleHandlerInterface
+   * @var \Drupal\Core\Extension\ModuleHandlerInterface
    */
   protected $moduleHandler;
 
   /**
    * Constructs a new FileExampleReadWriteForm page.
    *
-   * @param StateInterface $state
+   * @param \Drupal\Core\State\StateInterface $state
    *   Storage interface for state data.
-   * @param FileSystemInterface $file_system
+   * @param \Drupal\Core\File\FileSystemInterface $file_system
    *   Interface for common file system operations.
-   * @param StreamWrapperManagerInterface $stream_wrapper_manager
+   * @param \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface $stream_wrapper_manager
    *   Interface to obtain stream wrappers used to manipulate a given file
    *   scheme.
-   * @param ModuleHandlerInterface $module_handler
+   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
    *   Interface to get information about the status of modules and other
    *   extensions.
-   * @param RequestStack $request_stack
+   * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
    *   Access to the current request, including to session objects.
    */
   public function __construct(
@@ -194,7 +194,7 @@ protected function setDefaultDirectory($uri) {
    * @param string $uri
    *   The URI of the file, like public://test.txt.
    *
-   * @return FileInterface|bool
+   * @return \Drupal\file\Entity\FileInterface|bool
    *   A file object that matches the URI, or FALSE if not a managed file.
    *
    * @todo This should still work. An entity query could be used instead.
@@ -772,7 +772,7 @@ public function handleDirectoryDelete(array &$form, FormStateInterface $form_sta
    *
    * @param array $form
    *   FormAPI form.
-   * @param FormStateInterface $form_state
+   * @param \Drupal\Core\Form\FormStateInterface $form_state
    *   FormAPI form state.
    */
   public function handleDirectoryExists(array &$form, FormStateInterface $form_state) {
@@ -810,7 +810,7 @@ public function handleShowSession(array &$form, FormStateInterface $form_state)
    *
    * @param array $form
    *   FormAPI form.
-   * @param FormStateInterface $form_state
+   * @param \Drupal\Core\Form\FormStateInterface $form_state
    *   FormAPI form state.
    *
    * @todo Note this does NOT clear any managed file references in Drupal's DB.

phpcs.xml.dist

@@ -7,7 +7,7 @@
 <ruleset name="drupal_examples">
   <description>Default PHP CodeSniffer configuration for Examples for Developers.</description>
   <file>.</file>
-  <arg name="extensions" value="css,inc,install,module,php,profile,test,theme"/>
+  <arg name="extensions" value="css,inc,install,module,php,profile,test,theme,yml"/>
   <rule ref="Drupal.Array.Array.CommaLastItem"/>
   <rule ref="Drupal.CSS"/>
   <rule ref="Drupal.Classes"/>
@@ -16,9 +16,10 @@
       <exclude name="Drupal.Commenting.DocComment.MissingShort"/>
       <exclude name="Drupal.Commenting.DocComment.TagsNotGrouped"/>
   </rule>
-  <rule ref="Drupal.Commenting.InlineComment"/>
+  <rule ref="Drupal.Commenting.DataTypeNamespace"/>
   <rule ref="Drupal.Commenting.FileComment.NamespaceNoFileDoc"/>
   <rule ref="Drupal.Commenting.FunctionComment"/>
+  <rule ref="Drupal.Commenting.InlineComment"/>
   <rule ref="Drupal.ControlStructures"/>
   <rule ref="Drupal.Files"/>
   <rule ref="Drupal.Formatting"/>

stream_wrapper_example/src/StreamWrapper/MockSessionTrait.php

@@ -22,7 +22,7 @@ trait MockSessionTrait {
   /**
    * A representation of the HTTP request.
    *
-   * @var RequestStack|ProphecyInterface
+   * @var \Symfony\Component\HttpFoundation\RequestStack|\Prophecy\Prophecy\ProphecyInterface
    */
   protected $requestStack;
 

stream_wrapper_example/src/StreamWrapper/SessionWrapper.php

@@ -17,7 +17,7 @@ class SessionWrapper {
   /**
    * Representation of the current HTTP request.
    *
-   * @var RequestStack
+   * @var \Symfony\Component\HttpFoundation\RequestStack
    */
   protected $requestStack;
 
@@ -31,7 +31,7 @@ class SessionWrapper {
   /**
    * Construct our helper object.
    *
-   * @param RequestStack $request_stack
+   * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
    *   An object used to read data from the current HTTP request.
    */
   public function __construct(RequestStack $request_stack) {

tests/modules/examples_description_test/examples_description_test.info.yml

@@ -5,4 +5,3 @@ package: Testing
 core: 8.x
 dependencies:
   - examples
-