telyn / c2ephp

support/Archiver.php

Indentation +17 added lines, -17 removed lines

@@ -1,24 +1,24 @@
 <?php
 function DeArchive($data) {
-	if(is_string($data)) {
-		if(substr($data,0,55) == "Creatures Evolution Engine - Archived information file.") {
-			$data = substr($data,strpos($data,chr(0x1A).chr(0x04))+2);
-			$data = gzuncompress($data);
-			return $data;
-		}
-		die('Couldn\'t dearchive -- Probably invalid file');
-		return false;
-	} else if(is_resource($data)) {
-		return false; //coming soon
-	}	
+    if(is_string($data)) {
+        if(substr($data,0,55) == "Creatures Evolution Engine - Archived information file.") {
+            $data = substr($data,strpos($data,chr(0x1A).chr(0x04))+2);
+            $data = gzuncompress($data);
+            return $data;
+        }
+        die('Couldn\'t dearchive -- Probably invalid file');
+        return false;
+    } else if(is_resource($data)) {
+        return false; //coming soon
+    }	
 }
 function Archive($data,$filehandle=null) {
-	if(is_resource($filehandle)) {
-		return false;
-	}
-	$data = gzcompress($data);
-	$data = "Creatures Evolution Engine - Archived information file. zLib 1.13 compressed.".chr(0x1A).chr(0x04).$data;
-	return $data;
+    if(is_resource($filehandle)) {
+        return false;
+    }
+    $data = gzcompress($data);
+    $data = "Creatures Evolution Engine - Archived information file. zLib 1.13 compressed.".chr(0x1A).chr(0x04).$data;
+    return $data;
 	
 }
 ?>
\ No newline at end of file

agents/COB/AgentBlock.php

Doc Comments +3 added lines, -3 removed lines

@@ -51,8 +51,8 @@ 
     /** As defaults can be made for everything else these are the only non-optional
      * parts of a COB file in my opinion. Even then they could just be '' if you
      * really felt like it. 
-     * @param $agentName The name of the agent (as displayed in the C2 injector)
-     * @param $agentDescription The description of the agent (as displayed in the C2 injector)
+     * @param string|false $agentName The name of the agent (as displayed in the C2 injector)
+     * @param string $agentDescription The description of the agent (as displayed in the C2 injector)
      */
     public function COBAgentBlock($agentName, $agentDescription) {
         parent::COBBlock(COB_BLOCK_AGENT);
@@ -381,7 +381,7 @@ 
 
     /// @brief Creates a new COBDependency
     /** @param string $type The type of dependency ('sprite' or 'sound').
-     * @param $name The name of the dependency (four characters, no file extension)
+     * @param string $name The name of the dependency (four characters, no file extension)
      */
     public function COBDependency($type, $name) {
         $this->type = $type;

agents/CreatureHistory/CreatureHistoryEvent.php

Doc Comments +7 added lines, -7 removed lines

@@ -119,12 +119,12 @@ 
      * (number of seconds passed since 1st Jan, 1970)
      * @param $lifestage The lifestage this creature had achieved at
      * the time of this event.
-     * @param $moniker1 The first moniker associated with this event.
-     * @param $moniker2 The second moniker associated with this event.
-     * @param $usertext The user text assosciated with this event.
-     * @param $photograph The photograph associated with this event.
-     * @param $worldname The name of the world the creature was inhabiting at the time of this event 
-     * @param $worldUID The UID of the world the creature was inhabiting at the the time of this event
+     * @param false|string $moniker1 The first moniker associated with this event.
+     * @param false|string $moniker2 The second moniker associated with this event.
+     * @param false|string $usertext The user text assosciated with this event.
+     * @param false|string $photograph The photograph associated with this event.
+     * @param false|string $worldname The name of the world the creature was inhabiting at the time of this event 
+     * @param false|string $worldUID The UID of the world the creature was inhabiting at the the time of this event
      */
     public function CreatureHistoryEvent($eventtype, $worldtime, $creatureage, $timestamp, $lifestage, $moniker1, $moniker2, $usertext, $photograph, $worldname, $worldUID) {
         $this->eventtype = $eventtype;
@@ -142,7 +142,7 @@ 
 
     /// @brief Add DS-specific information to the CreatureHistoryEvent
     /**
-     * @param $DSUserID The UID of the Docking Station user whose world the creature was in at the time of the event
+     * @param false|string $DSUserID The UID of the Docking Station user whose world the creature was in at the time of the event
      * @param $unknown1 I don't know! But it comes right after the DSUID in the GLST format.
      * @param $unknown2 I don't know! But it comes right after unknown1.
      */

agents/PRAY/AGNTBlock.php

Doc Comments +2 added lines, -2 removed lines

@@ -13,7 +13,7 @@ 
      * will be read from the PRAYFile.
      * @param PRAYFile $prayfile The PRAYFile associated with this AGNT block.
      * It is allowed to be null.
-     * @param $name The name of this block.
+     * @param string $name The name of this block.
      * @param $content This block's content.
      * @param $flags Any flags this block may have. I think this is a
      * single byte. Check http://www.creatureswiki.net/wiki/PRAY
@@ -26,7 +26,7 @@ 
     /**
      * Sometimes this ends in .agnt or .dsag, because some people
      * don't do their PRAYING properly.
-     * @return The agent name
+     * @return string agent name
      */
     public function GetAgentName() {
         return $this->GetName();

agents/PRAY/CreaturesArchiveBlock.php

Doc Comments +1 added lines, -1 removed lines

@@ -11,7 +11,7 @@
 
     /// @brief Instantiates a new CreaturesArchiveBlock
     /**
-     * @param $prayfile The PRAYFile this CreaturesArchive belongs to. May be null.
+     * @param PRAYFile $prayfile The PRAYFile this CreaturesArchive belongs to. May be null.
      * @param $name The name of this block
      * @param $content This block's binary data.
      * @param $flags the flags of this block

agents/PRAY/EGGSBlock.php

Doc Comments +1 added lines, -1 removed lines

@@ -14,7 +14,7 @@
      * will be read from the PRAYFile.
      * @param PRAYFile $prayfile The PRAYFile associated with this AGNT block.
      * It is allowed to be null.
-     * @param $name The name of this block.
+     * @param string $name The name of this block.
      * @param $content This block's content.
      * @param $flags Any flags this block may have. I think this is a
      * single byte. Check http://www.creatureswiki.net/wiki/PRAY

agents/PRAY/FILEBlock.php

Doc Comments +1 added lines, -1 removed lines

@@ -19,7 +19,7 @@
      * will be read from the PRAYFile.
      * @param PRAYFile $prayfile The PRAYFile this FILEBlock belongs to. Can
      * be null.
-     * @param $name The name of this file block (also the file's
+     * @param string $name The name of this file block (also the file's
      * name)
      * @param $content The binary data of this file block.
      * @param $flags The block's flags. See PrayBlock.

agents/PRAY/GENEBlock.php

Doc Comments +1 added lines, -1 removed lines

@@ -15,7 +15,7 @@
      * If $prayfile is not null, all the data for this block
      * will be read from the PRAYFile.
      * @param PRAYFile $prayfile The PRAYFile object this block belongs to. Can be null.
-     * @param $name The block's name. This is a creature's moniker with .genetics appended.
+     * @param string $name The block's name. This is a creature's moniker with .genetics appended.
      * @param $content The block's binary data. Used when constructing from a PrayFile
      * @param $flags The block's flags, which apply to the binary data as-is.
      */

agents/PRAY/GLSTBlock.php

Doc Comments +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
      * will be read from the PRAYFile.
      * @param PRAYFile $object The PRAYFile this FILEBlock belongs to, or the
      * CreatureHistory object to store. <b>Cannot</b> be null.
-     * @param $name The name of this block. I think it's usually the
+     * @param string $name The name of this block. I think it's usually the
      * creature's moniker with .GLST appended.
      * @param $content The binary data of this file block.
      * @param $flags The block's flags. See PrayBlock.