IMPROVED : Refactored resources management

Author: Progi1984

CHANGELOG.md

@@ -3,9 +3,11 @@
 ## 0.2.0 - Not Released
 ### Features
 - MSProjectExchange Reader - @Progi1984 GH-4
+- MSProjectExchange Writer - @Progi1984 GH-2
 ### Bugfix
 
 ### Miscellaneous
+- Refactored resources management
 
 
 ## 0.1.0 - 2014-08-08

samples/Sample_01_Simple.php

@@ -35,10 +35,9 @@
 $objTask1->setEndDate('03-01-2012');
 $objTask1->setProgress(0.5);
 $objTask1->addResource($objRes1);
-$objTask1Res = $objTask1->getResources();
 echo 'Resources "Start of the project"'.EOL;
-foreach ($objTask1Res as $res){
-     echo ' > '.$objPHPProject->getResource($res)->getTitle().EOL;;
+foreach ($objTask1->getResources() as $oResource){
+     echo ' > '.$oResource->getTitle().EOL;
 }
 
 $objTask2 = $objPHPProject->createTask();
@@ -51,10 +50,11 @@
 $objTask21->setProgress(1);
 $objTask21->addResource($objRes2);
 $objTask21->addResource($objRes1);
-$objTask21Res = $objTask21->getResources();
+$objTask21->addResource($objRes1);
+
 echo 'Resources "Analysis Code"'.EOL;
-foreach ($objTask21Res as $res){
-     echo ' > '.$objPHPProject->getResource($res)->getTitle().EOL;;
+foreach ($objTask21->getResources() as $oResource){
+     echo ' > '.$oResource->getTitle().EOL;;
 }
 
 $objTask22 = $objTask2->createTask();

samples/Sample_02_ReadGanttProject.php

@@ -27,17 +27,14 @@
 
 // Ressources
 echo date('H:i:s') . ' Get ressources'.EOL;
-$oResources = $objPHPProject->getAllResources();
-foreach ($oResources as $item){
-    echo 'Resource : '.$item->getTitle().EOL;
+foreach ($objPHPProject->getAllResources() as $oResource){
+    echo 'Resource : '.$oResource->getTitle().EOL;
 }
 echo EOL;
 
 // Tasks
 echo date('H:i:s') . ' Get tasks'.EOL;
-$arrTasks = $objPHPProject->getAllTasks();
-
-foreach ($arrTasks as $oTask){
+foreach ($objPHPProject->getAllTasks() as $oTask){
 	echoTask($objPHPProject, $oTask);
 }
 

samples/Sample_Header.php

@@ -15,7 +15,7 @@
 Autoloader::register();
 
 // Set writers
-$writers = array('GanttProject' => 'gan'/*, 'MSProjectExchange' => 'mpx'*/);
+$writers = array('GanttProject' => 'gan', 'MsProjectMPX' => 'mpx');
 
 // Return to the caller script when runs by CLI
 if (CLI) {
@@ -115,8 +115,8 @@ function echoTask($oPHPProject, $oTask, $level = 0) {
     echo ' '.str_repeat('>', 2 * ($level + 1)).' Resources : '.EOL;
     $oTaskResources = $oTask->getResources();
     if(!empty($oTaskResources)){
-        foreach ($oTaskResources as $itemRes){
-            echo ' '.str_repeat('>', 2 * ($level + 2)).' Resource : '.$oPHPProject->getResourceFromIndex($itemRes)->getTitle().EOL;
+        foreach ($oTaskResources as $oResource){
+            echo ' '.str_repeat('>', 2 * ($level + 2)).' Resource : '.$oResource->getTitle().EOL;
         }
     }
     echo EOL;

src/PhpProject/PhpProject.php

@@ -168,7 +168,7 @@ public function getAllResources()
     /**
      * Get active resource
      *
-     * @return Resource
+     * @return Resource|null
      */
     public function getActiveResource()
     {
@@ -178,22 +178,6 @@ public function getActiveResource()
         return null;
     }
 
-    /**
-     * Get resource by index
-     *
-     * @param int $pIndex Resource index
-     * @return Resource
-     * @throws \Exception
-     */
-    public function getResource($pIndex = 0)
-    {
-        if (!isset($this->resourceCollection[$pIndex])) {
-            throw new \Exception('Resource index is out of bounds.');
-        } else {
-            return $this->resourceCollection[$pIndex];
-        }
-    }
-    
     /**
      * Get resource from index
      *
@@ -260,22 +244,6 @@ public function getActiveTask()
         return null;
     }
 
-    /**
-     * Get task by index
-     *
-     * @param int $pIndex Task index
-     * @return Task
-     * @throws \Exception
-     */
-    public function getTask($pIndex = 0)
-    {
-        if (!isset($this->taskCollection[$pIndex])) {
-            throw new \Exception('Task index is out of bounds.');
-        } else {
-            return $this->taskCollection[$pIndex];
-        }
-    }
-    
     /**
      * Get task from index
      *

src/PhpProject/Task.php

@@ -253,18 +253,18 @@ public function setIndex($value)
      * Add a resource used by the current task
      * @param PHPProject_Resource $pResource
      */
-    public function addResource(Resource $pResource)
+    public function addResource(Resource $oResource)
     {
-        if (array_search($pResource->getIndex(), $this->resourceCollection) === false) {
-            $this->resourceCollection[] = $pResource->getIndex();
+        if (!in_array($oResource, $this->resourceCollection)) {
+            $this->resourceCollection[] = &$oResource;
         }
         return $this;
     }
 
     /**
      * Returns a collection of all resources used by the task
      * 
-     * @return integer[]
+     * @return Resource[]
      */
     public function getResources()
     {

src/PhpProject/Writer/GanttProject.php

@@ -179,9 +179,8 @@ public function save ($pFilename)
         $oXML->endElement();
 
         // task
-        $arrTasks = $this->phpProject->getAllTasks();
         $iTaskIndex = 0;
-        foreach ($arrTasks as $oTask) {
+        foreach ($this->phpProject->getAllTasks() as $oTask) {
             $iTaskIndex = $this->writeTask($oXML, $oTask, $iTaskIndex);
         }
 
@@ -192,11 +191,8 @@ public function save ($pFilename)
         $oXML->startElement('resources');
 
         // resource
-        $arrResources = $this->phpProject->getAllResources();
-        foreach ($arrResources as $oResource) {
-            if ($oResource instanceof \PhpOffice\PhpProject\Resource) {
-                $this->writeResource($oXML, $oResource);
-            }
+        foreach ($this->phpProject->getAllResources() as $oResource) {
+            $this->writeResource($oXML, $oResource);
         }
 
         // >resources
@@ -328,10 +324,9 @@ private function writeTask (XMLWriter $oXML, Task $oTask, $iNbTasks)
 
         // Resources Allocations
         if ($oTask->getResourceCount() > 0) {
-            $arrResources = $oTask->getResources();
-            foreach ($arrResources as $resourceIdx) {
+            foreach ($oTask->getResources() as $oResource) {
                 $itmAllocation = array();
-                $itmAllocation['id_res'] = $resourceIdx;
+                $itmAllocation['id_res'] = $oResource->getIndex();
                 $itmAllocation['id_task'] = $iNbTasks;
                 $this->arrAllocations[] = $itmAllocation;
             }

tests/PhpProject/Tests/PhpProjectTest.php

@@ -72,9 +72,6 @@ public function testResource()
         $this->assertCount(1, $object->getAllResources());
         $this->assertInternalType('array', $object->getAllResources());
         $this->assertInstanceOf('PhpOffice\\PhpProject\\Resource', $object->getActiveResource());
-        // Get Resource
-        $this->assertInstanceOf('PhpOffice\\PhpProject\\Resource', $object->getResource());
-        $this->assertInstanceOf('PhpOffice\\PhpProject\\Resource', $object->getResource(0));
     }
 
     public function testResourceFromIndex()
@@ -89,16 +86,6 @@ public function testResourceFromIndex()
         $this->assertNull($object->getResourceFromIndex(1));
     }
 
-    /**
-     * @expectedException \Exception
-     * @expectedExceptionMessage Resource index is out of bounds.
-     */
-    public function testResourceException()
-    {
-        $object = new PhpProject();
-        $object->getResource();
-    }
-    
     public function testTask()
     {
         $object = new PhpProject();
@@ -123,10 +110,6 @@ public function testTask()
         $this->assertEquals(1, $object->getActiveTaskIndex());
         $this->assertInternalType('array', $object->getAllTasks());
         $this->assertInstanceOf('PhpOffice\\PhpProject\\Task', $object->getActiveTask());
-        // Get Task
-        $this->assertInstanceOf('PhpOffice\\PhpProject\\Task', $object->getTask());
-        $this->assertInstanceOf('PhpOffice\\PhpProject\\Task', $object->getTask(0));
-        $this->assertInstanceOf('PhpOffice\\PhpProject\\Task', $object->getTask(1));
         // Active Task
         $this->assertInstanceOf('PhpOffice\\PhpProject\\Task', $object->setActiveTaskIndex(0));
         $this->assertEquals(0, $object->getActiveTaskIndex());
@@ -155,16 +138,6 @@ public function testTaskFromIndex()
         $this->assertNull($object->getTaskFromIndex(1));
     }
 
-    /**
-     * @expectedException \Exception
-     * @expectedExceptionMessage Task index is out of bounds.
-     */
-    public function testTaskException()
-    {
-        $object = new PhpProject();
-        $object->getTask();
-    }
-    
     /**
      * @expectedException \Exception
      * @expectedExceptionMessage Task index is out of bounds.