telyn / c2ephp

agents/PRAY/TagBlock.php

Doc Comments +2 added lines, -1 removed lines

@@ -25,7 +25,7 @@ 
      * @param $name The name of the block. Cannot be null.
      * @param $content The binary data this block contains. Can be null.
      * @param $flags The flags relating to this block. Should be zero or real flags.
-     * @param $type The block's 4-character type. Must be defined.
+     * @param string $type The block's 4-character type. Must be defined.
      */
     public function TagBlock($prayfile,$name,$content,$flags,$type) {
         parent::PrayBlock($prayfile,$name,$content,$flags,$type);
@@ -40,6 +40,7 @@ 
     /**
      * Returns the tag's value as a string, or
      * nothing if the tag doesn't exist.
+     * @param string $key
      */
     public function GetTag($key) {
         $this->EnsureDecompiled();

Spacing +19 added lines, -19 removed lines

@@ -27,10 +27,10 @@ 
      * @param $flags The flags relating to this block. Should be zero or real flags.
      * @param $type The block's 4-character type. Must be defined.
      */
-    public function TagBlock($prayfile,$name,$content,$flags,$type) {
-        parent::PrayBlock($prayfile,$name,$content,$flags,$type);
-        if($prayfile instanceof PRAYFile) {
-        } else if(is_array($prayfile)) {
+    public function TagBlock($prayfile, $name, $content, $flags, $type) {
+        parent::PrayBlock($prayfile, $name, $content, $flags, $type);
+        if ($prayfile instanceof PRAYFile) {
+        } else if (is_array($prayfile)) {
             $this->tags = $prayfile;
         }
     }
@@ -43,8 +43,8 @@ 
      */
     public function GetTag($key) {
         $this->EnsureDecompiled();
-        foreach($this->tags as $tk => $tv) {
-            if($key == $tk) {
+        foreach ($this->tags as $tk => $tv) {
+            if ($key == $tk) {
                 return $tv;
             }
         }
@@ -66,7 +66,7 @@ 
      * @param $tag Name of the tag to set
      * @param $value The value to set the tag to
      */
-    public function SetTag($tag,$value) {
+    public function SetTag($tag, $value) {
         $this->EnsureDecompiled();
         $this->tags[$tag] = $value;
     }
@@ -82,24 +82,24 @@ 
         $compiled = '';
         $ints = array();
         $strings = array();
-        foreach($this->tags as $key=>$value) {
-            if(is_int($value)) {
+        foreach ($this->tags as $key=>$value) {
+            if (is_int($value)) {
                 $ints[$key] = $value;
             } else {
                 $strings[$key] = $value;
             }
         }
-        $compiled .= pack('V',sizeof($ints));
-        foreach($ints as $key=>$value) {
-            $compiled .= pack('V',strlen($key));
+        $compiled .= pack('V', sizeof($ints));
+        foreach ($ints as $key=>$value) {
+            $compiled .= pack('V', strlen($key));
             $compiled .= $key;
-            $compiled .= pack('V',$value);
+            $compiled .= pack('V', $value);
         }
-        $compiled .= pack('V',sizeof($strings));
-        foreach($strings as $key=>$value) {
-            $compiled .= pack('V',strlen($key));
+        $compiled .= pack('V', sizeof($strings));
+        foreach ($strings as $key=>$value) {
+            $compiled .= pack('V', strlen($key));
             $compiled .= $key;
-            $compiled .= pack('V',strlen($value));
+            $compiled .= pack('V', strlen($value));
             $compiled .= $value;
         }
         return $compiled;
@@ -114,7 +114,7 @@ 
         $blockReader = new StringReader($this->GetData());
         
         $numInts = $blockReader->ReadInt(4);
-        for($i=0;$i<$numInts;$i++) {
+        for ($i = 0; $i < $numInts; $i++) {
             $nameLength = $blockReader->ReadInt(4);
             $name = $blockReader->Read($nameLength);
             $int = $blockReader->ReadInt(4);
@@ -123,7 +123,7 @@ 
         
         
         $numStrings = $blockReader->ReadInt(4);
-        for($i=0;$i<$numStrings;$i++) {
+        for ($i = 0; $i < $numStrings; $i++) {
             $nameLength = $blockReader->ReadInt(4);
             $name = $blockReader->Read($nameLength);
             $stringLength = $blockReader->ReadInt(4);

agents/PRAYFile.php

Doc Comments +1 added lines, -1 removed lines

@@ -57,7 +57,7 @@
 
     /// @brief Compiles the PRAYFile.
     /**
-     * @return A binary string containing the PRAYFile's contents.
+     * @return string binary string containing the PRAYFile's contents.
      */
     public function Compile() {
         $compiled = 'PRAY';

Spacing +23 added lines, -23 removed lines

@@ -12,7 +12,7 @@ 
     /// @cond INTERNAL_DOCS
 
     private $reader;
-    private $blocks=array();
+    private $blocks = array();
     private $parsed = false;
 
     /// @endcond
@@ -23,9 +23,9 @@ 
      * @param $reader The IReader to read from. If null, means this
      * is a user-generated PRAYFile.
      */
-    function PRAYFile($reader=null) {
+    function PRAYFile($reader = null) {
         $this->blocks = array();
-        if($reader instanceof IReader) {
+        if ($reader instanceof IReader) {
             $this->reader = $reader;
             $this->Parse();
         } else {
@@ -37,9 +37,9 @@ 
 
     /// @brief Reads the PRAYFile stored in the reader. Called automatically.
     private function Parse() {
-        if(!$this->parsed) {
-            if($this->ParseHeader()) {
-                while($this->ParseBlockHeader()) {
+        if (!$this->parsed) {
+            if ($this->ParseHeader()) {
+                while ($this->ParseBlockHeader()) {
                 }
                 $this->parsed = true;
                 //print_r($this->blocks);
@@ -61,7 +61,7 @@ 
      */
     public function Compile() {
         $compiled = 'PRAY';
-        foreach($this->blocks as $block) {
+        foreach ($this->blocks as $block) {
             $compiled .= $block->Compile();
         }
         return $compiled;
@@ -72,8 +72,8 @@ 
      * @param $block The PrayBlock to add.
      */
     public function AddBlock(PrayBlock $block) {
-        foreach($this->blocks as $checkBlock) {
-            if($checkBlock->GetName() == $block->GetName()) {
+        foreach ($this->blocks as $checkBlock) {
+            if ($checkBlock->GetName() == $block->GetName()) {
                 throw new Exception("PRAY Files cannot contain multiple blocks with the same name");
             }
         }
@@ -88,16 +88,16 @@ 
      * @param $type The type(s) of blocks to return, as the
      * PRAYBLOCK_TYPE_* constants. (see PrayBlock for block types)
      */
-    public function GetBlocks($type=FALSE) { //gets all blocks or one type of block
-        if(!$type) {
+    public function GetBlocks($type = FALSE) { //gets all blocks or one type of block
+        if (!$type) {
             return $this->blocks;
         } else {
-            if(is_string($type)) {
+            if (is_string($type)) {
                 $type = array($type);
             }
             $retblocks = array();
-            foreach($this->blocks as $block) {
-                if(in_array($block->GetType(),$type)) {
+            foreach ($this->blocks as $block) {
+                if (in_array($block->GetType(), $type)) {
                     $retblocks[] = $block;
                 }
             }
@@ -111,9 +111,9 @@ 
      * for a particular CreatureHistoryEvent, for example.
      */
     public function GetBlockByName($name) {
-        foreach($this->blocks as $blockid => $block) {
+        foreach ($this->blocks as $blockid => $block) {
 
-            if($block->GetName() == $name) {
+            if ($block->GetName() == $name) {
                 return $block;
             }
         }
@@ -127,7 +127,7 @@ 
      *  It's not much of a header, but it's a header nonetheless.
      */
     private function ParseHeader() {
-        if($this->reader->Read(4) == "PRAY") {
+        if ($this->reader->Read(4) == "PRAY") {
             return true;
         } else {
             return false;
@@ -143,28 +143,28 @@ 
      */
     private function ParseBlockHeader() {
         $blocktype = $this->reader->Read(4);
-        if($blocktype=="") {
+        if ($blocktype == "") {
             return false;
         }
         $name = trim($this->reader->Read(128));
-        if($name=="") {
+        if ($name == "") {
             return false;
         }
         $length = $this->reader->ReadInt(4);
-        if($length===false) {
+        if ($length === false) {
             return false;
         }
         $fulllength = $this->reader->ReadInt(4); //full means uncompressed
-        if($fulllength===false) {
+        if ($fulllength === false) {
             return false;
         }
         $flags = $this->reader->ReadInt(4);
-        if($flags===false) {
+        if ($flags === false) {
             return false;
         }
 
         $content = $this->reader->Read($length);
-        $this->blocks[] = PrayBlock::MakePrayBlock($blocktype,$this,$name,$content,$flags);
+        $this->blocks[] = PrayBlock::MakePrayBlock($blocktype, $this, $name, $content, $flags);
 
         return true;
     }

sprites/C16File.php

Doc Comments +1 added lines, -1 removed lines

@@ -53,7 +53,7 @@
     }
     /// @brief Compiles the file's data into a C16 binary string
     /**
-     * @return A binary string containing the C16File's data.
+     * @return string binary string containing the C16File's data.
      */
     public function Compile() {
         $data = ''; 

Spacing +18 added lines, -18 removed lines

@@ -16,30 +16,30 @@ 
      * If $reader is null, creates an empty C16File ready to add sprites to.
      * @param $reader The reader to read the sprites from. Can be null.
      */
-    public function C16File(IReader $reader=null)
+    public function C16File(IReader $reader = null)
     {
-        if($reader != null) {
+        if ($reader != null) {
             parent::SpriteFile('C16');
             $buffer = $reader->ReadInt(4);
-            if(($buffer & 1) == 1) {
+            if (($buffer & 1) == 1) {
                 $this->encoding = '565';
             } else {
                 $this->encoding = '555';
             }
 
-            if(($buffer & 2) == 0) { //buffer & 2 == 2 => RLE. buffer & 2 == 0 => non-RLE (same as s16 but not supported here because it's complex dude.
+            if (($buffer & 2) == 0) { //buffer & 2 == 2 => RLE. buffer & 2 == 0 => non-RLE (same as s16 but not supported here because it's complex dude.
                 throw new Exception('This file is probably a S16 masquerading as a C16!');
-            } else if($buffer > 3) {
+            } else if ($buffer > 3) {
                 throw new Exception('File encoding not recognised. ('.$buffer.')');
             }
 
             $buffer = $reader->ReadInt(2);
-            if($buffer < 1)
+            if ($buffer < 1)
                 throw new Exception('Sprite file appears to contain less than 1 frame.');
             $frameCount = $buffer;
-            for($x=0; $x < $frameCount; $x++)
+            for ($x = 0; $x < $frameCount; $x++)
             {
-                $this->AddFrame(new C16Frame($reader,$this->encoding));
+                $this->AddFrame(new C16Frame($reader, $this->encoding));
             }
         }
     }
@@ -58,30 +58,30 @@ 
     public function Compile() {
         $data = ''; 
         $flags = 2; // 0b00 => 555 S16, 0b01 => 565 S16, 0b10 => 555 C16, 0b11 => 565 C16
-        if($this->encoding == '565') {
+        if ($this->encoding == '565') {
             $flags = $flags | 1;
         }
-        $data .= pack('V',$flags);
-        $data .= pack('v',$this->GetFrameCount());
+        $data .= pack('V', $flags);
+        $data .= pack('v', $this->GetFrameCount());
         $idata = '';
         $offset = 6+(8*$this->GetFrameCount());
-        foreach($this->GetFrames() as $frame) {
+        foreach ($this->GetFrames() as $frame) {
             $offset += ($frame->GetHeight()-1)*4;
         }
 
-        foreach($this->GetFrames() as $frame) {
-            $data .= pack('V',$offset);
-            $data .= pack('vv',$frame->GetWidth(),$frame->GetHeight());
+        foreach ($this->GetFrames() as $frame) {
+            $data .= pack('V', $offset);
+            $data .= pack('vv', $frame->GetWidth(), $frame->GetHeight());
 
             $framedata = $frame->Encode();
             $framebin = $framedata['data'];
-            foreach($framedata['lineoffsets'] as $lineoffset) {
-                $data .= pack('V',$lineoffset+$offset);
+            foreach ($framedata['lineoffsets'] as $lineoffset) {
+                $data .= pack('V', $lineoffset+$offset);
             }
             $offset += strlen($framebin); 
             $idata .= $framebin;
         }
-        return $data . $idata;
+        return $data.$idata;
     }
 
 }

Braces +3 added lines, -2 removed lines

@@ -34,8 +34,9 @@
             }
 
             $buffer = $reader->ReadInt(2);
-            if($buffer < 1)
-                throw new Exception('Sprite file appears to contain less than 1 frame.');
+            if($buffer < 1) {
+                            throw new Exception('Sprite file appears to contain less than 1 frame.');
+            }
             $frameCount = $buffer;
             for($x=0; $x < $frameCount; $x++)
             {

sprites/S16File.php

Doc Comments +1 added lines, -1 removed lines

@@ -55,7 +55,7 @@
 
     /// @brief Compiles the S16 file into a binary string.
     /**
-     * @return a binary string containing s16 data of whatever the
+     * @return string binary string containing s16 data of whatever the
      * current encoding set by SetEncoding() is. If you haven't set
      * it, it's most likely 565.
      */

Spacing +11 added lines, -11 removed lines

@@ -29,17 +29,17 @@ 
         parent::SpriteFile('S16');
         $this->reader = $reader;
         $buffer = $this->reader->ReadInt(4);
-        if($buffer == 1) {
+        if ($buffer == 1) {
             $this->encoding = "565";
-        } else if($buffer == 0) {
+        } else if ($buffer == 0) {
             $this->encoding = "555";
         } else {
             throw new Exception("File encoding not recognised. (".$buffer.'|'.$this->reader->GetPosition().')');
         }
         $this->frameCount = $this->reader->ReadInt(2);
-        for($i=0; $i < $this->frameCount; $i++)
+        for ($i = 0; $i < $this->frameCount; $i++)
         {
-            $this->AddFrame(new S16Frame($this->reader,$this->encoding));
+            $this->AddFrame(new S16Frame($this->reader, $this->encoding));
         }
     }
     /// @brief Sets the encoding (555 or 565) of this s16 file.
@@ -69,22 +69,22 @@ 
         // 0b01 => 565 S16,
         // 0b10 => 555 C16,
         // 0b11 => 565 C16
-        if($this->encoding == '565') {
+        if ($this->encoding == '565') {
             $flags = $flags | 1;
         }
-        $data .= pack('V',$flags);
-        $data .= pack('v',$this->GetFrameCount());
+        $data .= pack('V', $flags);
+        $data .= pack('v', $this->GetFrameCount());
         $idata = '';
         $offset = 6+(8*$this->GetFrameCount());
-        foreach($this->GetFrames() as $frame) {
-            $data .= pack('V',$offset);
-            $data .= pack('vv',$frame->GetWidth(),$frame->GetHeight());
+        foreach ($this->GetFrames() as $frame) {
+            $data .= pack('V', $offset);
+            $data .= pack('vv', $frame->GetWidth(), $frame->GetHeight());
 
             $framebin = $frame->Encode();
             $offset += strlen($framebin); 
             $idata .= $framebin;
         }
-        return $data . $idata;
+        return $data.$idata;
     }
 }
 ?>

sprites/S16Frame.php

Doc Comments +1 added lines, -1 removed lines

@@ -41,7 +41,7 @@
     /// @brief Encodes the image into s16 frame data.
     /**
      * @param $format 555 or 565.
-     * @return s16 image data in the format specified
+     * @return string image data in the format specified
      */
 
     public function Encode($format='565') {

Spacing +17 added lines, -17 removed lines

@@ -17,19 +17,19 @@ 
     
     /// @brief Instantiate an S16Frame
     
-    public function S16Frame($reader,$encoding='565',$width=false,$height=false,$offset=false)
+    public function S16Frame($reader, $encoding = '565', $width = false, $height = false, $offset = false)
     {
-        if($reader instanceof IReader) {
+        if ($reader instanceof IReader) {
             $this->reader = $reader;
             $this->encoding = $encoding;
-            if($width === false || $height === false || $offset === false) {
+            if ($width === false || $height === false || $offset === false) {
                 $this->offset = $this->reader->ReadInt(4);
                 parent::SpriteFrame($this->reader->ReadInt(2), $this->reader->ReadInt(2));
             } else {
-                parent::SpriteFrame($width,$height);
+                parent::SpriteFrame($width, $height);
                 $this->offset = $offset;
             }
-        } else if(get_resource_type($reader) == 'gd') {
+        } else if (get_resource_type($reader) == 'gd') {
             $this->gdImage = $reader;
             $this->decoded = true;
             $this->encoding = $encoding;
@@ -44,23 +44,23 @@ 
      * @return s16 image data in the format specified
      */
 
-    public function Encode($format='565') {
+    public function Encode($format = '565') {
         $this->EnsureDecoded();
         $data = ''; 
-        for($y = 0; $y < $this->GetHeight(); $y++) {
-            for($x = 0; $x < $this->GetWidth(); $x++ ) {
+        for ($y = 0; $y < $this->GetHeight(); $y++) {
+            for ($x = 0; $x < $this->GetWidth(); $x++) {
 
-                $pixel = $this->GetPixel($x,$y);
-                if($pixel['red'] > 255 || $pixel['green'] > 255 || $pixel['blue'] > 255) {
+                $pixel = $this->GetPixel($x, $y);
+                if ($pixel['red'] > 255 || $pixel['green'] > 255 || $pixel['blue'] > 255) {
                     throw new Exception('Pixel colour out of range.');
                 }
                 $newpixel = 0;
-                if($this->encoding == '555') {
+                if ($this->encoding == '555') {
                     $newpixel = (($pixel['red'] << 7) & 0xF800) | (($pixel['green'] << 2) & 0x03E0) | (($pixel['blue'] >> 3) & 0x001F);
                 } else {
                     $newpixel = (($pixel['red'] << 8) & 0xF800) | (($pixel['green'] << 3) & 0x07E0) | (($pixel['blue'] >> 3) & 0x001F);
                 }
-                $data .= pack('v',$newpixel);
+                $data .= pack('v', $newpixel);
             }
         }
         return $data;
@@ -73,24 +73,24 @@ 
      * TODO: Internal documentation S16Frame::Decode()
      */
     protected function Decode() {
-        if($this->decoded) { return $this->gdImage; }
+        if ($this->decoded) { return $this->gdImage; }
 
             $image = imagecreatetruecolor($this->GetWidth(),
                 $this->GetHeight());
         $this->reader->Seek($this->offset);
-        for($y = 0; $y < $this->GetHeight(); $y++)
+        for ($y = 0; $y < $this->GetHeight(); $y++)
         {
-            for($x = 0; $x < $this->GetWidth(); $x++)
+            for ($x = 0; $x < $this->GetWidth(); $x++)
             {
                 $pixel = $this->reader->ReadInt(2);
                 $red = 0; $green = 0; $blue = 0;
-                if($this->encoding == "565")
+                if ($this->encoding == "565")
                 {
                     $red   = ($pixel & 0xF800) >> 8;
                     $green = ($pixel & 0x07E0) >> 3;
                     $blue  = ($pixel & 0x001F) << 3;
                 }
-                else if($this->encoding == "555")
+                else if ($this->encoding == "555")
                 {
                     $red   = ($pixel & 0x7C00) >> 7;
                     $green = ($pixel & 0x03E0) >> 2;

Braces +1 added lines, -2 removed lines

@@ -89,8 +89,7 @@
                     $red   = ($pixel & 0xF800) >> 8;
                     $green = ($pixel & 0x07E0) >> 3;
                     $blue  = ($pixel & 0x001F) << 3;
-                }
-                else if($this->encoding == "555")
+                } else if($this->encoding == "555")
                 {
                     $red   = ($pixel & 0x7C00) >> 7;
                     $green = ($pixel & 0x03E0) >> 2;

sprites/SPRFrame.php

Doc Comments +1 added lines, -1 removed lines

@@ -97,7 +97,7 @@
      * Called automatically by SPRFile::Compile() \n
      * Generally end-users won't want a single frame of SPR data,
      * so add it to an SPRFile and call SPRFile::Compile().
-     * @return a binary string of SPR data.
+     * @return string binary string of SPR data.
      */
     public function Encode() {
         $data = '';

Spacing +23 added lines, -23 removed lines

@@ -25,26 +25,26 @@ 
      * @param $height Ignored when creating an SPRFrame from a GD image.
      * @param $offset How far through the IReader the SPRFrame is. May not ever be used.
      */
-    public function SPRFrame($reader,$width=0,$height=0,$offset=false) {
-        if($reader instanceof IReader) {
+    public function SPRFrame($reader, $width = 0, $height = 0, $offset = false) {
+        if ($reader instanceof IReader) {
             $this->reader = $reader;
-            parent::SpriteFrame($width,$height);
-            if($offset !== false) {
+            parent::SpriteFrame($width, $height);
+            if ($offset !== false) {
                 $this->offset = $offset;
             } else {
                 $this->offset = $this->reader->GetPosition();
             }
 
             //initialise palette if necessary.
-            if(empty(self::$sprToRGB)) {
+            if (empty(self::$sprToRGB)) {
                 $paletteReader = new FileReader(dirname(__FILE__).'/palette.dta');
-                for($i = 0;$i<256;$i++) {
-                    self::$sprToRGB[$i] = array('r'=>$paletteReader->ReadInt(1)*4,'g'=>$paletteReader->ReadInt(1)*4,'b'=>$paletteReader->ReadInt(1)*4);
+                for ($i = 0; $i < 256; $i++) {
+                    self::$sprToRGB[$i] = array('r'=>$paletteReader->ReadInt(1)*4, 'g'=>$paletteReader->ReadInt(1)*4, 'b'=>$paletteReader->ReadInt(1)*4);
                 }
                 unset($paletteReader);
             }
-        } else if(get_resource_type($reader) == 'gd') {
-            parent::SpriteFrame(imagesx($reader),imagesy($reader),true);
+        } else if (get_resource_type($reader) == 'gd') {
+            parent::SpriteFrame(imagesx($reader), imagesy($reader), true);
             $this->gdImage = $reader;
         } else {
             throw new Exception('$reader was not an IReader or a gd image.');
@@ -58,13 +58,13 @@ 
      * feel free to use it yourself, it's not going anywhere.
      */
     public function Flip() {
-        if($this->HasBeenDecoded()) {
+        if ($this->HasBeenDecoded()) {
             throw new Exception('Too late!');
             return;
         }
         $tempData = '';
-        for($i=($this->GetHeight()-1);$i>-1;$i--) {
-            $tempData .= $this->reader->GetSubString($this->offset+($this->GetWidth())*$i,($this->GetWidth()));
+        for ($i = ($this->GetHeight()-1); $i > -1; $i--) {
+            $tempData .= $this->reader->GetSubString($this->offset+($this->GetWidth())*$i, ($this->GetWidth()));
         }
         $this->reader = new StringReader($tempData);
         $this->offset = 0;
@@ -78,12 +78,12 @@ 
     protected function Decode() {    
         $image = imagecreatetruecolor($this->GetWidth(), $this->GetHeight());
         $this->reader->Seek($this->offset);
-        for($y = 0; $y < $this->GetHeight(); $y++)
+        for ($y = 0; $y < $this->GetHeight(); $y++)
         {
-            for($x = 0; $x < $this->GetWidth(); $x++)
+            for ($x = 0; $x < $this->GetWidth(); $x++)
             {
                 $colour = self::$sprToRGB[$this->reader->ReadInt(1)];
-                imagesetpixel($image,$x,$y,imagecolorallocate($image,$colour['r'],$colour['g'],$colour['b']));
+                imagesetpixel($image, $x, $y, imagecolorallocate($image, $colour['r'], $colour['g'], $colour['b']));
             }
         }
         $this->gdImage = $image;
@@ -101,10 +101,10 @@ 
      */
     public function Encode() {
         $data = '';
-        for($y = 0; $y < $this->GetHeight(); $y++ ) {
-            for($x = 0; $x < $this->GetWidth(); $x++ ) {
+        for ($y = 0; $y < $this->GetHeight(); $y++) {
+            for ($x = 0; $x < $this->GetWidth(); $x++) {
                 $color = $this->GetPixel($x, $y);
-                $data .= pack('C',$this->RGBToSPR($color['red'], $color['green'], $color['blue']));
+                $data .= pack('C', $this->RGBToSPR($color['red'], $color['green'], $color['blue']));
             }
         }
         return $data;
@@ -117,13 +117,13 @@ 
      * Runs in O(n) time.
      */
 
-    private function RGBToSPR($r,$g,$b) {
+    private function RGBToSPR($r, $g, $b) {
         //start out with the maximum distance.
-        $minDistance = ($r^2) + ($g^2) + ($b^2);
+        $minDistance = ($r ^ 2)+($g ^ 2)+($b ^ 2);
         $minKey = 0;
-        foreach(self::$sprToRGB as $key => $colour) {
-            $distance = pow(($r-$colour['r']),2) +  pow(($g-$colour['g']),2) +  pow(($b-$colour['b']),2);
-            if($distance == 0) {
+        foreach (self::$sprToRGB as $key => $colour) {
+            $distance = pow(($r-$colour['r']), 2)+pow(($g-$colour['g']), 2)+pow(($b-$colour['b']), 2);
+            if ($distance == 0) {
                 return $key;
             } else if ($distance < $minDistance) {
                 $minKey = $key;

sprites/SpriteFile.php

Doc Comments +4 added lines, -1 removed lines

@@ -11,6 +11,9 @@ 
 
   /// @cond INTERNAL_DOCS
   
+  /**
+   * @param string $filetype
+   */
   public function SpriteFile($filetype) {
     $this->spritefiletype = $filetype;
   }
@@ -102,7 +105,7 @@ 
   /**
    * May be removed in a future release.
    * Use GetFrame($frame)->ToPNG() instead.
-   * @param $frame The 0-based index of the frame to delete.
+   * @param integer $frame The 0-based index of the frame to delete.
    * @return A binary string containing a PNG.
    */
   public function ToPNG($frame) {

Indentation +92 added lines, -92 removed lines

@@ -3,110 +3,110 @@
 /// @brief Superclass for all SpriteFile types
 abstract class SpriteFile {
 
-  /// @cond INTERNAL_DOCS
+    /// @cond INTERNAL_DOCS
     
-  private $frames = array();
-  private $spritefiletype;
-  /// @endcond
+    private $frames = array();
+    private $spritefiletype;
+    /// @endcond
 
-  /// @cond INTERNAL_DOCS
+    /// @cond INTERNAL_DOCS
   
-  public function SpriteFile($filetype) {
+    public function SpriteFile($filetype) {
     $this->spritefiletype = $filetype;
-  }
-  /// @endcond
+    }
+    /// @endcond
 
-  /// @brief Gets a SpriteFrame from the SpriteFile.
-  /**
-   * @param $frame The 0-based index of the frame to get.
-   * @return A SpriteFrame
-   */
-  public function GetFrame($frame) {
-      return $this->frames[$frame];
-  }
-  /// @brief Gets the entire frame array.
-  /**
-   * @return An array of SpriteFrames
-   */
-  public function GetFrames() {
-      return $this->frames;
-  }
+    /// @brief Gets a SpriteFrame from the SpriteFile.
+    /**
+     * @param $frame The 0-based index of the frame to get.
+     * @return A SpriteFrame
+     */
+    public function GetFrame($frame) {
+        return $this->frames[$frame];
+    }
+    /// @brief Gets the entire frame array.
+    /**
+     * @return An array of SpriteFrames
+     */
+    public function GetFrames() {
+        return $this->frames;
+    }
 
-  /// @brief Compiles the SpriteFile into a binary string
-  /**
-   * @return A binary string containing the SpriteFile's data and frames.
-   */
-  public abstract function Compile();
+    /// @brief Compiles the SpriteFile into a binary string
+    /**
+     * @return A binary string containing the SpriteFile's data and frames.
+     */
+    public abstract function Compile();
 
-  /// @brief Adds a SpriteFrame to the SpriteFile
-  /**
-   * If necessary, this function converts the SpriteFrame to the
-   * correct format.
-   * At the moment, this can only add a SpriteFrame to the end of the
-   * SpriteFile. TODO: I aim to fix this by the CCSF 2011.
-   * @internal
-   * This process uses some magic which require all types of
-   * SpriteFile and SpriteFrame to use 3-character identifiers.
-   * This means that if you want to make your own sprite formats
-   * you'll need to override this function and provide all our magic
-   * plus your own.
-   * @endinternal
-   * @param $frame A SpriteFrame
-   * @param $position Where to put the frame. Currently un-used.
-   */
-  public function AddFrame(SpriteFrame $frame, $position=false) {
-      /*
+    /// @brief Adds a SpriteFrame to the SpriteFile
+    /**
+     * If necessary, this function converts the SpriteFrame to the
+     * correct format.
+     * At the moment, this can only add a SpriteFrame to the end of the
+     * SpriteFile. TODO: I aim to fix this by the CCSF 2011.
+     * @internal
+     * This process uses some magic which require all types of
+     * SpriteFile and SpriteFrame to use 3-character identifiers.
+     * This means that if you want to make your own sprite formats
+     * you'll need to override this function and provide all our magic
+     * plus your own.
+     * @endinternal
+     * @param $frame A SpriteFrame
+     * @param $position Where to put the frame. Currently un-used.
+     */
+    public function AddFrame(SpriteFrame $frame, $position=false) {
+        /*
       if($position === false) {
           $position = sizeof($this->frames);
       } else if($position < 0) {
           $position = sizeof($this->frames) - $position;
       }
       */
-      if($this->spritefiletype == substr(get_class($frame),0,3)) {
-          //$this->frames[$position] = $frame;
-          $this->frames[] = $frame;
-      } else {
-          //$this->frames[$position] = $frame->ToSpriteFrame($this->spritefiletype);
-          $this->frames[] = $frame->ToSpriteFrame($this->spritefiletype);
-      }
-  }
-  /// @brief Replaces a frame in the SpriteFile
-  /**
-   * Replaces the frame in the given position
-   * Uses the same magic as AddFrame
-   * @param $frame A SpriteFrame of any type.
-   * @param $position Which frame to replace. If negative, counts
-   * backwards from the end of the frames array.
-   */
-  public function ReplaceFrame(SpriteFrame $frame, $position) {
-      if($position < 0) {
-          $position = sizeof($this->frames) - $position;
-      }
-      $this->frames[$position] = $frame->ToSpriteFrame($this->spritefiletype);
-  }
-  /// @brief Gets the number of frames currently stored in this SpriteFile.
-  /**
-   * @return The number of frames
-   */
-  public function GetFrameCount() {
-      return sizeof($this->frames);
-  }
-  /// @brief Deletes the frame in the given position.
-  /**
-   * @param $frame The 0-based index of the frame to delete.
-   */
-  public function DeleteFrame($frame) {
-      unset($this->frames[$frame]);
-  }
-  /// @brief Converts the given frame to PNG. <strong>Deprecated.</strong>
-  /**
-   * May be removed in a future release.
-   * Use GetFrame($frame)->ToPNG() instead.
-   * @param $frame The 0-based index of the frame to delete.
-   * @return A binary string containing a PNG.
-   */
-  public function ToPNG($frame) {
-      return $this->frames[$frame]->ToPNG();
-  }
+        if($this->spritefiletype == substr(get_class($frame),0,3)) {
+            //$this->frames[$position] = $frame;
+            $this->frames[] = $frame;
+        } else {
+            //$this->frames[$position] = $frame->ToSpriteFrame($this->spritefiletype);
+            $this->frames[] = $frame->ToSpriteFrame($this->spritefiletype);
+        }
+    }
+    /// @brief Replaces a frame in the SpriteFile
+    /**
+     * Replaces the frame in the given position
+     * Uses the same magic as AddFrame
+     * @param $frame A SpriteFrame of any type.
+     * @param $position Which frame to replace. If negative, counts
+     * backwards from the end of the frames array.
+     */
+    public function ReplaceFrame(SpriteFrame $frame, $position) {
+        if($position < 0) {
+            $position = sizeof($this->frames) - $position;
+        }
+        $this->frames[$position] = $frame->ToSpriteFrame($this->spritefiletype);
+    }
+    /// @brief Gets the number of frames currently stored in this SpriteFile.
+    /**
+     * @return The number of frames
+     */
+    public function GetFrameCount() {
+        return sizeof($this->frames);
+    }
+    /// @brief Deletes the frame in the given position.
+    /**
+     * @param $frame The 0-based index of the frame to delete.
+     */
+    public function DeleteFrame($frame) {
+        unset($this->frames[$frame]);
+    }
+    /// @brief Converts the given frame to PNG. <strong>Deprecated.</strong>
+    /**
+     * May be removed in a future release.
+     * Use GetFrame($frame)->ToPNG() instead.
+     * @param $frame The 0-based index of the frame to delete.
+     * @return A binary string containing a PNG.
+     */
+    public function ToPNG($frame) {
+        return $this->frames[$frame]->ToPNG();
+    }
 }
 ?>

Spacing +4 added lines, -4 removed lines

@@ -54,7 +54,7 @@ 
    * @param $frame A SpriteFrame
    * @param $position Where to put the frame. Currently un-used.
    */
-  public function AddFrame(SpriteFrame $frame, $position=false) {
+  public function AddFrame(SpriteFrame $frame, $position = false) {
       /*
       if($position === false) {
           $position = sizeof($this->frames);
@@ -62,7 +62,7 @@ 
           $position = sizeof($this->frames) - $position;
       }
       */
-      if($this->spritefiletype == substr(get_class($frame),0,3)) {
+      if ($this->spritefiletype == substr(get_class($frame), 0, 3)) {
           //$this->frames[$position] = $frame;
           $this->frames[] = $frame;
       } else {
@@ -79,8 +79,8 @@ 
    * backwards from the end of the frames array.
    */
   public function ReplaceFrame(SpriteFrame $frame, $position) {
-      if($position < 0) {
-          $position = sizeof($this->frames) - $position;
+      if ($position < 0) {
+          $position = sizeof($this->frames)-$position;
       }
       $this->frames[$position] = $frame->ToSpriteFrame($this->spritefiletype);
   }

sprites/SpriteFrame.php

Doc Comments +8 added lines, -4 removed lines

@@ -42,7 +42,7 @@ 
     /// @brief Gets the GD Image resource for this sprite frame.
     /// <strong> Deprecated</strong>
     /**
-     *  @return a GD image resource. See http://php.net/image 
+     *  @return resource GD image resource. See http://php.net/image 
      */
     public function GetGDImage() {
         $this->EnsureDecoded();
@@ -54,6 +54,10 @@ 
         return $this->width;
     }
     /// @brief Gets the height of the frame in pixels
+
+    /**
+     * @return integer
+     */
     public function GetHeight() {
         return $this->height;
     }
@@ -69,8 +73,8 @@ 
      *    [alpha] => 0 
      * )</pre>
      * @see http://php.net/imagecolorsforindex
-     * @param $x The x-coordinate of the pixel to get.
-     * @param $y The y-coordinate of the pixel to get.
+     * @param integer $x The x-coordinate of the pixel to get.
+     * @param integer $y The y-coordinate of the pixel to get.
      * @return An associative array containing the keys 'red','green','blue','alpha'.
      */
     public function GetPixel($x,$y) {
@@ -150,7 +154,7 @@ 
 
     /// @brief Converts this SpriteFrame into a PNG.
     /**
-     * @return A binary string in PNG format, ready for output! :)
+     * @return string binary string in PNG format, ready for output! :)
      */
     public function ToPNG() {
         $this->EnsureDecoded();

Spacing +8 added lines, -8 removed lines

@@ -22,10 +22,10 @@ 
      * Width and height must both be non-zero.
      * @see C16Frame::C16Frame()
      */
-    public function SpriteFrame($width,$height,$decoded=false) {
-        if($width == 0) {
+    public function SpriteFrame($width, $height, $decoded = false) {
+        if ($width == 0) {
             throw new Exception('Zero width');
-        } else if($height == 0) {
+        } else if ($height == 0) {
             throw new Exception('Zero height');
         }
         $this->width = $width;
@@ -73,7 +73,7 @@ 
      * @param $y The y-coordinate of the pixel to get.
      * @return An associative array containing the keys 'red','green','blue','alpha'.
      */
-    public function GetPixel($x,$y) {
+    public function GetPixel($x, $y) {
         $this->EnsureDecoded();
         $colori = imagecolorat($this->gdImage, $x, $y);
         $color = imagecolorsforindex($this->gdImage, $colori);
@@ -88,7 +88,7 @@ 
      * @param $g The green component of the pixel. 0-255.
      * @param $b The blue component of the pixel. 0-255.
      */
-    public function SetPixel($x,$y,$r,$g,$b) {
+    public function SetPixel($x, $y, $r, $g, $b) {
         $this->EnsureDecoded();
         imagesetpixel($this->gdImage, $x, $y, imagecolorallocate($this->gdImage, $r, $g, $b));
     }
@@ -101,7 +101,7 @@ 
      * if it does't already.
      */
     protected function EnsureDecoded() {
-        if(!$this->decoded)
+        if (!$this->decoded)
             $this->Decode();
 
         $this->decoded = true;
@@ -133,10 +133,10 @@ 
      */
     public function ToSpriteFrame($type) {
         $this->EnsureDecoded();
-        if(substr(get_class($this),0,3) == $type && substr(get_class($this),3) == 'Frame') {
+        if (substr(get_class($this), 0, 3) == $type && substr(get_class($this), 3) == 'Frame') {
             return $this;
         }
-        switch($type) {
+        switch ($type) {
         case 'C16':
             return new C16Frame($this->GetGDImage());
         case 'S16':

Braces +3 added lines, -2 removed lines

@@ -101,8 +101,9 @@
      * if it does't already.
      */
     protected function EnsureDecoded() {
-        if(!$this->decoded)
-            $this->Decode();
+        if(!$this->decoded) {
+                    $this->Decode();
+        }
 
         $this->decoded = true;
     }

support/Archiver.php

Doc Comments +3 added lines

@@ -12,6 +12,9 @@
 		return false; //coming soon
 	}	
 }
+/**
+ * @param string $data
+ */
 function Archive($data,$filehandle=null) {
 	if(is_resource($filehandle)) {
 		return false;

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

Spacing +6 added lines, -6 removed lines

@@ -1,19 +1,19 @@
 <?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);
+	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)) {
+	} else if (is_resource($data)) {
 		return false; //coming soon
 	}	
 }
-function Archive($data,$filehandle=null) {
-	if(is_resource($filehandle)) {
+function Archive($data, $filehandle = null) {
+	if (is_resource($filehandle)) {
 		return false;
 	}
 	$data = gzcompress($data);