Merge pull request #9 from clue/fields

Rename "part" to "field" in order to match Asterisk terminology

Author: clue

example/commands.php

@@ -19,7 +19,7 @@
     $api->events(false);
 
     $api->listCommands()->then(function (Response $response) {
-        echo 'Commands: ' . implode(', ', array_keys($response->getParts())) . PHP_EOL;
+        echo 'Commands: ' . implode(', ', array_keys($response->getFields())) . PHP_EOL;
     });
 
     $client->on('close', function() use ($loop) {
@@ -34,7 +34,7 @@
 
         $api->command($line)->then(
             function (Response $response) {
-                echo $response->getPart('_') . PHP_EOL;
+                echo $response->getField('_') . PHP_EOL;
             },
             function (Exception $error) use ($line) {
                 echo 'Error executing "' . $line . '": ' . $error->getMessage() . PHP_EOL;

src/Client.php

@@ -79,7 +79,7 @@ public function handleMessage(Message $message)
             return;
         }
 
-        if ($message->getPart('Response') === 'Error') {
+        if ($message->getField('Response') === 'Error') {
             $this->pending[$id]->reject(new ErrorException($message));
         } else {
             $this->pending[$id]->resolve($message);

src/Protocol/Action.php

@@ -4,15 +4,15 @@
 
 class Action extends Message
 {
-    public function __construct(array $parts = array())
+    public function __construct(array $fields = array())
     {
-        $this->parts = $parts;
+        $this->fields = $fields;
     }
 
     public function getMessageSerialized()
     {
         $message = '';
-        foreach ($this->parts as $key => $values) {
+        foreach ($this->fields as $key => $values) {
             if (!is_array($values)) {
                 $values = array($values);
             }

src/Protocol/Collection.php

@@ -12,7 +12,7 @@ class Collection extends Message
 
     public function __construct(Response $response, array $entryEvents, Event $completeEvent)
     {
-        $this->parts = $response->getParts();
+        $this->fields = $response->getFields();
         $this->response = $response;
         $this->entryEvents = $entryEvents;
         $this->completeEvent = $completeEvent;

src/Protocol/ErrorException.php

@@ -10,7 +10,7 @@ class ErrorException extends RuntimeException
 
     public function __construct(Response $response)
     {
-        parent::__construct('Error "' . $response->getPart('Message') . '"');
+        parent::__construct('Error "' . $response->getField('Message') . '"');
         $this->response = $response;
     }
 

src/Protocol/Event.php

@@ -4,13 +4,13 @@
 
 class Event extends Message
 {
-    public function __construct(array $parts)
+    public function __construct(array $fields)
     {
-        $this->parts = $parts;
+        $this->fields = $fields;
     }
 
     public function getName()
     {
-        return $this->getPart('Event');
+        return $this->getField('Event');
     }
 }

src/Protocol/Message.php

@@ -4,18 +4,18 @@
 
 abstract class Message
 {
-    protected $parts = array();
+    protected $fields = array();
 
     public function getActionId()
     {
-        return $this->getPart('ActionId');
+        return $this->getField('ActionId');
     }
 
-    public function getPart($key)
+    public function getField($key)
     {
         $key = strtolower($key);
 
-        foreach ($this->parts as $part => $value) {
+        foreach ($this->fields as $part => $value) {
             if (strtolower($part) === $key) {
                 return $value;
             }
@@ -26,11 +26,11 @@ public function getPart($key)
 
     public function toJson()
     {
-        return json_encode($this->getParts());
+        return json_encode($this->getFields());
     }
 
-    public function getParts()
+    public function getFields()
     {
-        return $this->parts;
+        return $this->fields;
     }
 }

src/Protocol/Parser.php

@@ -40,7 +40,7 @@ public function push($chunk)
 
     private function parseMessage($message)
     {
-        $parts = array();
+        $fields = array();
         foreach (explode(self::EOL, $message) as $line) {
             if (substr($line, -self::LCOMMAND_END) === self::COMMAND_END) {
                 $key = '_';
@@ -54,16 +54,16 @@ private function parseMessage($message)
                 $key = substr($line, 0, $pos);
             }
 
-            $parts[$key] = $value;
+            $fields[$key] = $value;
         }
 
-        reset($parts);
-        $key = key($parts);
+        reset($fields);
+        $key = key($fields);
 
         if ($key === 'Event') {
-            return new Event($parts);
+            return new Event($fields);
         }
 
-        return new Response($parts);
+        return new Response($fields);
     }
 }

src/Protocol/Response.php

@@ -4,8 +4,8 @@
 
 class Response extends Message
 {
-    public function __construct(array $parts)
+    public function __construct(array $fields)
     {
-        $this->parts = $parts;
+        $this->fields = $fields;
     }
 }

tests/Protocol/ParserTest.php

@@ -16,7 +16,7 @@ public function testParseResponse()
         /* @var $first Clue\React\Ami\Protocol\Response */
 
         $this->assertInstanceOf('Clue\React\Ami\Protocol\Response', $first);
-        $this->assertEquals('Success', $first->getPart('Response'));
+        $this->assertEquals('Success', $first->getField('Response'));
     }
 
     public function testParseResponseSpace()
@@ -31,7 +31,7 @@ public function testParseResponseSpace()
         /* @var $first Clue\React\Ami\Protocol\Response */
 
         $this->assertInstanceOf('Clue\React\Ami\Protocol\Response', $first);
-        $this->assertEquals(' spaces  ', $first->getPart('Message'));
+        $this->assertEquals(' spaces  ', $first->getField('Message'));
     }
 
     public function testParsingMultipleEvents()
@@ -61,8 +61,8 @@ public function testParsingCommandResponse()
         /* @var $first Clue\React\Ami\Protocol\Response */
 
         $this->assertInstanceOf('Clue\React\Ami\Protocol\Response', $first);
-        $this->assertEquals('Follows', $first->getPart('Response'));
-        $this->assertEquals("Testing: yes\nAnother Line\n--END COMMAND--", $first->getPart('_'));
+        $this->assertEquals('Follows', $first->getField('Response'));
+        $this->assertEquals("Testing: yes\nAnother Line\n--END COMMAND--", $first->getField('_'));
     }
 
     /**