namespace refactor

Author: thomas-kl1

Api/Data/StudentInterface.php

@@ -1,6 +1,20 @@
 <?php
-
-namespace Blackbird\TeacherStudents\Api\Data;
+/**
+ * Blackbird Data Model Sample Module
+ *
+ * NOTICE OF LICENSE
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to contact@bird.eu so we can send you a copy immediately.
+ *
+ * @category    Blackbird
+ * @package     Blackbird_DataModelSample
+ * @copyright   Copyright (c) 2018 Blackbird (https://black.bird.eu)
+ * @author      Blackbird Team
+ * @license     MIT
+ * @support     help@bird.eu
+ */
+namespace Blackbird\DataModelSample\Api\Data;
 
 /**
  * Interface StudentInterface
@@ -15,7 +29,7 @@ interface StudentInterface
     /**
      * Get Student ID
      *
-     * @return int mixed
+     * @return int
      */
     public function getId();
 
@@ -37,23 +51,23 @@ public function getAge();
      * Set Student ID
      *
      * @param int $id
-     * @return mixed
+     * @return \Blackbird\DataModelSample\Api\Data\StudentInterface
      */
     public function setId($id);
 
     /**
      * Set Student Name
      *
      * @param string $name
-     * @return mixed
+     * @return \Blackbird\DataModelSample\Api\Data\StudentInterface
      */
     public function setName($name);
 
     /**
      * Set Student Age
      *
      * @param int $age
-     * @return mixed
+     * @return \Blackbird\DataModelSample\Api\Data\StudentInterface
      */
     public function setAge($age);
-}
+}

Api/Data/TeacherInterface.php

@@ -1,6 +1,20 @@
 <?php
-
-namespace Blackbird\TeacherStudents\Api\Data;
+/**
+ * Blackbird Data Model Sample Module
+ *
+ * NOTICE OF LICENSE
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to contact@bird.eu so we can send you a copy immediately.
+ *
+ * @category    Blackbird
+ * @package     Blackbird_DataModelSample
+ * @copyright   Copyright (c) 2018 Blackbird (https://black.bird.eu)
+ * @author      Blackbird Team
+ * @license     MIT
+ * @support     help@bird.eu
+ */
+namespace Blackbird\DataModelSample\Api\Data;
 
 /**
  * Interface TeacherInterface
@@ -45,31 +59,31 @@ public function getClasses();
      * Set the Teacher Id
      *
      * @param int $id
-     * @return mixed
+     * @return \Blackbird\DataModelSample\Api\Data\TeacherInterface
      */
     public function setId($id);
 
     /**
      * Set the Teacher Name
      *
      * @param string $name
-     * @return mixed
+     * @return \Blackbird\DataModelSample\Api\Data\TeacherInterface
      */
     public function setName($name);
 
     /**
      * Set the Teacher Age
      *
      * @param int $age
-     * @return mixed
+     * @return \Blackbird\DataModelSample\Api\Data\TeacherInterface
      */
     public function setAge($age);
 
     /**
      * Set the Teacher Classes
      *
      * @param string $classes
-     * @return mixed
+     * @return \Blackbird\DataModelSample\Api\Data\TeacherInterface
      */
     public function setClasses($classes);
-}
+}

Api/StudentRepositoryInterface.php

@@ -1,42 +1,56 @@
 <?php
-
-namespace Blackbird\TeacherStudents\Api;
+/**
+ * Blackbird Data Model Sample Module
+ *
+ * NOTICE OF LICENSE
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to contact@bird.eu so we can send you a copy immediately.
+ *
+ * @category    Blackbird
+ * @package     Blackbird_DataModelSample
+ * @copyright   Copyright (c) 2018 Blackbird (https://black.bird.eu)
+ * @author      Blackbird Team
+ * @license     MIT
+ * @support     help@bird.eu
+ */
+namespace Blackbird\DataModelSample\Api;
 
 /**
  * Interface StudentRepositoryInterface
- * @package Blackbird\TeacherStudents\Api
+ * @package Blackbird\DataModelSample\Api
  */
 interface StudentRepositoryInterface
 {
     /**
      * Save a Student
      *
-     * @param Data\StudentInterface $student
-     * @return mixed
+     * @param \Blackbird\DataModelSample\Api\Data\StudentInterface $student
+     * @return \Blackbird\DataModelSample\Api\Data\StudentInterface
      */
     public function save(Data\StudentInterface $student);
 
     /**
      * Get Student by an Id
      *
      * @param int $studentId
-     * @return mixed
+     * @return \Blackbird\DataModelSample\Api\Data\StudentInterface
      */
     public function getById($studentId);
 
     /**
      * Delete a Student
      *
-     * @param Data\StudentInterface $student
-     * @return mixed
+     * @param \Blackbird\DataModelSample\Api\Data\StudentInterface $student
+     * @return bool
      */
     public function delete(Data\StudentInterface $student);
 
     /**
      * Delete a Student by an Id
      *
-     * @param $studentId
-     * @return mixed
+     * @param int $studentId
+     * @return bool
      */
     public function deleteById($studentId);
-}
+}

Api/TeacherRepositoryInterface.php

@@ -1,42 +1,56 @@
 <?php
-
-namespace Blackbird\TeacherStudents\Api;
+/**
+ * Blackbird Data Model Sample Module
+ *
+ * NOTICE OF LICENSE
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to contact@bird.eu so we can send you a copy immediately.
+ *
+ * @category    Blackbird
+ * @package     Blackbird_DataModelSample
+ * @copyright   Copyright (c) 2018 Blackbird (https://black.bird.eu)
+ * @author      Blackbird Team
+ * @license     MIT
+ * @support     help@bird.eu
+ */
+namespace Blackbird\DataModelSample\Api;
 
 /**
  * Interface TeacherRepositoryInterface
- * @package Blackbird\TeacherStudents\Api
+ * @package Blackbird\DataModelSample\Api
  */
 interface TeacherRepositoryInterface
 {
     /**
      * Save a Teacher
      *
-     * @param Data\TeacherInterface $teacher
-     * @return mixed
+     * @param \Blackbird\DataModelSample\Api\Data\TeacherInterface $teacher
+     * @return \Blackbird\DataModelSample\Api\Data\TeacherInterface
      */
     public function save(Data\TeacherInterface $teacher);
 
     /**
      * Get Teacher by an Id
      *
      * @param int $teacherId
-     * @return mixed
+     * @return \Blackbird\DataModelSample\Api\Data\TeacherInterface
      */
     public function getById($teacherId);
 
     /**
      * Delete a Teacher
      *
-     * @param Data\TeacherInterface $teacher
-     * @return mixed
+     * @param \Blackbird\DataModelSample\Api\Data\TeacherInterface $teacher
+     * @return bool
      */
     public function delete(Data\TeacherInterface $teacher);
 
     /**
      * Delete a Teacher by an Id
      *
-     * @param $teacherId
-     * @return mixed
+     * @param int $teacherId
+     * @return bool
      */
     public function deleteById($teacherId);
-}
+}

Model/ResourceModel/Student.php

@@ -1,35 +1,49 @@
 <?php
-
-namespace Blackbird\TeacherStudents\Model\ResourceModel;
+/**
+ * Blackbird Data Model Sample Module
+ *
+ * NOTICE OF LICENSE
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to contact@bird.eu so we can send you a copy immediately.
+ *
+ * @category    Blackbird
+ * @package     Blackbird_DataModelSample
+ * @copyright   Copyright (c) 2018 Blackbird (https://black.bird.eu)
+ * @author      Blackbird Team
+ * @license     MIT
+ * @support     help@bird.eu
+ */
+namespace Blackbird\DataModelSample\Model\ResourceModel;
 
 use Magento\Framework\EntityManager\EntityManager;
 use Magento\Framework\EntityManager\MetadataPool;
 use Magento\Framework\Model\AbstractModel;
 use Magento\Framework\Model\ResourceModel\Db\AbstractDb;
 use Magento\Framework\Model\ResourceModel\Db\Context;
-use Blackbird\TeacherStudents\Api\Data\StudentInterface;
+use Blackbird\DataModelSample\Api\Data\StudentInterface;
 
 /**
  * Class Student
- * @package Blackbird\TeacherStudents\Model\ResourceModel
+ * @package Blackbird\DataModelSample\Model\ResourceModel
  */
 class Student extends AbstractDb
 {
     /**
-     * @var MetadataPool
+     * @var \Magento\Framework\EntityManager\MetadataPool
      */
-    protected $metadataPool;
+    private $metadataPool;
 
     /**
-     * @var EntityManager
+     * @var \Magento\Framework\EntityManager\EntityManager
      */
-    protected $entityManager;
+    private $entityManager;
 
     /**
-     * Student constructor.
-     * @param Context $context
-     * @param MetadataPool $metadataPool
-     * @param null $connectionName
+     * @param \Magento\Framework\Model\ResourceModel\Db\Context $context
+     * @param \Magento\Framework\EntityManager\MetadataPool $metadataPool
+     * @param \Magento\Framework\EntityManager\EntityManager $entityManager
+     * @param string|null $connectionName
      */
     public function __construct(
         Context $context,
@@ -43,7 +57,7 @@ public function __construct(
     }
 
     /**
-     * Set the table and the primary key
+     * {@inheritdoc}
      */
     protected function _construct()
     {
@@ -99,4 +113,4 @@ public function delete(\Magento\Framework\Model\AbstractModel $object)
     {
         $this->entityManager->delete($object);
     }
-}
+}

Model/ResourceModel/Student/Collection.php

@@ -1,21 +1,35 @@
 <?php
-
-namespace Blackbird\TeacherStudents\Model\ResourceModel\Student;
+/**
+ * Blackbird Data Model Sample Module
+ *
+ * NOTICE OF LICENSE
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to contact@bird.eu so we can send you a copy immediately.
+ *
+ * @category    Blackbird
+ * @package     Blackbird_DataModelSample
+ * @copyright   Copyright (c) 2018 Blackbird (https://black.bird.eu)
+ * @author      Blackbird Team
+ * @license     MIT
+ * @support     help@bird.eu
+ */
+namespace Blackbird\DataModelSample\Model\ResourceModel\Student;
 
 use Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection;
-use Blackbird\TeacherStudents\Model;
+use Blackbird\DataModelSample\Model;
 
 /**
  * Class Collection
- * @package Blackbird\TeacherStudents\Model\ResourceModel\Student
+ * @package Blackbird\DataModelSample\Model\ResourceModel\Student
  */
 class Collection extends AbstractCollection
 {
     /**
-     * Link student model to student resource model
+     * {@inheritdoc}
      */
     protected function _construct()
     {
         $this->_init(Model\Student::class, Model\ResourceModel\Student::class);
     }
-}
+}