switch to camel case, where we can

things like `ifthenelse` are still all mashed up, though

Author: jcupitt

README.md

@@ -22,39 +22,58 @@ which gives some more background.
 <?php
 include 'vips.php';
 
-$image = Vips\Image::new_from_file($argv[1]);
+$image = Vips\Image::newFromFile($argv[1]);
 
 echo "width = ", $image->width, "\n";
 
 $image = $image->invert();
 
-$image->write_to_file($argv[2]);
+$image->writeToFile($argv[2]);
 ?>
 ```
 
-### TODO
+Almost all methods return a new image for the result, so you can chain them.
+For example:
 
-Broken:
+```
+$image = $image->more(12)->ifThenElse(255, $image);
+```
 
-* phpDoc is not working for some reason.
+will make a mask of pixels greater than 12, then use the mask to set pixels to
+either 255 or the original image.
 
-Some features that other vips bindings have are not yet implemented:
+You use long, double, array and image as parameters. For example:
 
-* Not tried to make a proper package or namespace it yet. Does not 
-  install `vips.php`.
+```
+$image = $image->add(2);
+```
 
-* You can't assign to an array index to change an image band.
+to add two to every band element, or:
 
-* In-place operations, like `circle`, are not yet supported.
+```
+$image = $image->add([1, 2, 3]);
+```
 
-* No exceptions yet.
+to add 1 to the first band, 2 to the second and 3 to the third. Or:
 
-* No logging at the moment. 
+```
+$image = $image->add($image2);
+```
+
+to add two images. 
+
+Almost all methods can take an optional final argument, an array of options.
+For example:
+
+```
+$image->writeToFile("fred.jpg", ["Q" => 90]);
+$image = $image->embed("fred.jpg", ["Q" => 90]);
+```
 
-Some things will never be done:
+There are around 300 operations in the library, see the vips docs for an
+introduction:
 
-* You can't use `()` to get a pixel value, since php does not support multiple
-  arguments to `__invoke()`.
+http://www.vips.ecs.soton.ac.uk/supported/current/doc/html/libvips/
 
 ### How it works
 

tests/018.phpt

@@ -6,6 +6,6 @@ can import Vips\Image class
 <?php 
   include 'vips.php';
 
-  $image = Vips\Image::new_from_array([1, 2, 3]);
+  $image = Vips\Image::newFromArray([1, 2, 3]);
 ?>
 --EXPECT--

tests/019.phpt

@@ -1,13 +1,13 @@
 --TEST--
-Vips\Image::new_from_file works
+Vips\Image::newFromFile works
 --SKIPIF--
 <?php if (!extension_loaded("vips")) print "skip"; ?>
 --FILE--
 <?php 
   include 'vips.php';
 
   $filename = dirname(__FILE__) . "/images/img_0076.jpg";
-  $image = Vips\Image::new_from_file($filename, ["shrink" => 2]);
+  $image = Vips\Image::newFromFile($filename, ["shrink" => 2]);
   if ($image->width == 800) {
   	echo "pass\n";
   }

tests/020.phpt

@@ -1,5 +1,5 @@
 --TEST--
-Vips\Image::new_from_buffer works
+Vips\Image::newFromBuffer works
 --SKIPIF--
 <?php if (!extension_loaded("vips")) print "skip"; ?>
 --FILE--
@@ -9,7 +9,7 @@ Vips\Image::new_from_buffer works
   $filename = dirname(__FILE__) . "/images/img_0076.jpg";
   $buffer = file_get_contents($filename);
 
-  $image = Vips\Image::new_from_buffer($buffer, "", ["shrink" => 2]);
+  $image = Vips\Image::newFromBuffer($buffer, "", ["shrink" => 2]);
   if ($image->width == 800) {
   	echo "pass\n";
   }

tests/021.phpt

@@ -1,12 +1,12 @@
 --TEST--
-Vips\Image::new_from_array works
+Vips\Image::newFromArray works
 --SKIPIF--
 <?php if (!extension_loaded("vips")) print "skip"; ?>
 --FILE--
 <?php 
   include 'vips.php';
 
-  $image = Vips\Image::new_from_array([1, 2, 3], 8, 12);
+  $image = Vips\Image::newFromArray([1, 2, 3], 8, 12);
 
   if ($image->width == 3 &&
 	$image->height == 1 &&

tests/022.phpt

@@ -1,5 +1,5 @@
 --TEST--
-Vips\Image::write_to_file works
+Vips\Image::writeToFile works
 --SKIPIF--
 <?php if (!extension_loaded("vips")) print "skip"; ?>
 --FILE--
@@ -9,9 +9,9 @@ Vips\Image::write_to_file works
   $filename = dirname(__FILE__) . "/images/img_0076.jpg";
   $output_filename = dirname(__FILE__) . "/x.tif";
 
-  $image = Vips\Image::new_from_file($filename);
-  $image->write_to_file($output_filename);
-  $image = Vips\Image::new_from_file($output_filename);
+  $image = Vips\Image::newFromFile($filename);
+  $image->writeToFile($output_filename);
+  $image = Vips\Image::newFromFile($output_filename);
 
   if ($image->width == 1600) {
 	echo "pass";

tests/023.phpt

@@ -1,5 +1,5 @@
 --TEST--
-Vips\Image::write_to_buffer works
+Vips\Image::writeToBuffer works
 --SKIPIF--
 <?php if (!extension_loaded("vips")) print "skip"; ?>
 --FILE--
@@ -9,11 +9,11 @@ Vips\Image::write_to_buffer works
   $filename = dirname(__FILE__) . "/images/img_0076.jpg";
   $output_filename = dirname(__FILE__) . "/x.jpg";
 
-  $image = Vips\Image::new_from_file($filename);
+  $image = Vips\Image::newFromFile($filename);
 
-  $buffer1 = $image->write_to_buffer(".jpg");
+  $buffer1 = $image->writeToBuffer(".jpg");
 
-  $image->write_to_file($output_filename);
+  $image->writeToFile($output_filename);
   $buffer2 = file_get_contents($output_filename);
 
   if ($buffer1 == $buffer2) {

tests/024.phpt

@@ -8,7 +8,7 @@ Vips\Image::__call works
 
   $filename = dirname(__FILE__) . "/images/img_0076.jpg";
 
-  $image = Vips\Image::new_from_file($filename);
+  $image = Vips\Image::newFromFile($filename);
   $image = $image->embed(10, 20, 3000, 2000, ["extend" => "copy"]);
 
   if ($image->width == 3000) {

tests/028.phpt

@@ -6,7 +6,7 @@ Vips\Image::bandjoin works
 <?php 
   include 'vips.php';
 
-  $image = Vips\Image::new_from_array([[1, 2, 3], [4, 5, 6]]);
+  $image = Vips\Image::newFromArray([[1, 2, 3], [4, 5, 6]]);
   $rgb = $image->bandjoin([$image, $image]);
 
   if ($rgb->bands == 3 &&

tests/029.phpt

@@ -6,7 +6,7 @@ Vips\Image::add(const) works
 <?php 
   include 'vips.php';
 
-  $image = Vips\Image::new_from_array([[1, 2, 3], [4, 5, 6]]);
+  $image = Vips\Image::newFromArray([[1, 2, 3], [4, 5, 6]]);
   $image = $image->add(1);
 
   $pixel = $image->crop(0, 0, 1, 1);

tests/030.phpt

@@ -6,7 +6,7 @@ Vips\Image::getpoint() works
 <?php 
   include 'vips.php';
 
-  $image = Vips\Image::new_from_array([[1, 2, 3], [4, 5, 6]]);
+  $image = Vips\Image::newFromArray([[1, 2, 3], [4, 5, 6]]);
   $rgb = $image->bandjoin([$image, $image]);
   $rgb = $rgb->add(1);
 

tests/031.phpt

@@ -6,7 +6,7 @@ Vips\Image::bandjoin(const) works
 <?php 
   include 'vips.php';
 
-  $image = Vips\Image::new_from_array([[1, 2, 3], [4, 5, 6]]);
+  $image = Vips\Image::newFromArray([[1, 2, 3], [4, 5, 6]]);
   $imagea = $image->bandjoin(255);
 
   $pixel = $imagea->getpoint(0, 0);

tests/032.phpt

@@ -7,7 +7,7 @@ __set and __get work
   include 'vips.php';
 
   $filename = dirname(__FILE__) . "/images/img_0076.jpg";
-  $image = Vips\Image::new_from_file($filename);
+  $image = Vips\Image::newFromFile($filename);
 
   $image->poop = "banana";
   $value = $image->poop;

tests/033.phpt

@@ -7,7 +7,7 @@ Vips\Image::ifthenelse(image, const) works
   include 'vips.php';
 
   $filename = dirname(__FILE__) . "/images/img_0076.jpg";
-  $image = Vips\Image::new_from_file($filename);
+  $image = Vips\Image::newFromFile($filename);
 
   $image = $image->more(34)->ifthenelse(255, $image);
 

tests/034.phpt

@@ -7,7 +7,7 @@ Vips\Image::ifthenelse(const, image) works
   include 'vips.php';
 
   $filename = dirname(__FILE__) . "/images/img_0076.jpg";
-  $image = Vips\Image::new_from_file($filename);
+  $image = Vips\Image::newFromFile($filename);
 
   $image = $image->more(34)->ifthenelse($image, 255);
 

tests/035.phpt

@@ -7,7 +7,7 @@ Vips\Image::ifthenelse(const, const) works
   include 'vips.php';
 
   $filename = dirname(__FILE__) . "/images/img_0076.jpg";
-  $image = Vips\Image::new_from_file($filename);
+  $image = Vips\Image::newFromFile($filename);
 
   $image = $image->more(34)->ifthenelse(128, 255);
 

tests/036.phpt

@@ -21,7 +21,7 @@ operator expansions all work
   } 
 
   $filename = dirname(__FILE__) . "/images/img_0076.jpg";
-  $image = Vips\Image::new_from_file($filename);
+  $image = Vips\Image::newFromFile($filename);
 
   $pass = TRUE;
 

tests/037.phpt

@@ -6,7 +6,7 @@ Vips\Image::maxpos works
 <?php 
   include 'vips.php';
 
-  $image = Vips\Image::new_from_array([[1, 2, 3], [4, 5, 6]]);
+  $image = Vips\Image::newFromArray([[1, 2, 3], [4, 5, 6]]);
 
   $result = $image->maxpos();
 

tests/038.phpt

@@ -7,7 +7,7 @@ Vips\Image::bandrank() works
   include 'vips.php';
 
   $filename = dirname(__FILE__) . "/images/img_0076.jpg";
-  $image = Vips\Image::new_from_file($filename);
+  $image = Vips\Image::newFromFile($filename);
 
   $image = $image->bandrank($image);
 

tests/039.phpt

@@ -21,7 +21,7 @@ rounding works
   } 
 
   $filename = dirname(__FILE__) . "/images/img_0076.jpg";
-  $image = Vips\Image::new_from_file($filename);
+  $image = Vips\Image::newFromFile($filename);
   $image = $image->add([0.1, 1.5, 0.9]);
 
   $pass = TRUE;

tests/040.phpt

@@ -7,7 +7,7 @@ Vips\Image::bandand works
   include 'vips.php';
 
   $filename = dirname(__FILE__) . "/images/img_0076.jpg";
-  $image = Vips\Image::new_from_file($filename);
+  $image = Vips\Image::newFromFile($filename);
 
   $pass = TRUE;
 

tests/041.phpt

@@ -7,7 +7,7 @@ Vips\Image::[] works
   include 'vips.php';
 
   $filename = dirname(__FILE__) . "/images/img_0076.jpg";
-  $image = Vips\Image::new_from_file($filename);
+  $image = Vips\Image::newFromFile($filename);
 
   $image = $image->invert()[1];
 

vips.php

@@ -63,7 +63,7 @@ class Image implements \ArrayAccess
      * Wrap a Vips\Image around an underlying vips resource. 
      *
      * Don't call this yourself, users should stick to (for example)
-     * Vips\Image::new_from_file().
+     * Vips\Image::newFromFile().
      *
      * @param resource $image The underlying vips image resource that this
      *  class should wrap.
@@ -120,7 +120,7 @@ static private function is_2D($value)
     private static function imageize($match_image, $value)
     {
         if (self::is_2D($value)) {
-            $result = self::new_from_array($value);
+            $result = self::newFromArray($value);
         }
         else {
             $pixel = self::black(1, 1)->add($value)->cast($match_image->format);
@@ -192,7 +192,7 @@ private static function wrap($result)
      *
      * @return A new Vips\Image.
      */
-    public static function new_from_file($filename, $options = []) 
+    public static function newFromFile($filename, $options = []) 
     {
         $options = self::unwrap($options);
         $result = vips_image_new_from_file($filename, $options);
@@ -209,7 +209,7 @@ public static function new_from_file($filename, $options = [])
      *
      * @return A new Vips\Image.
      */
-    public static function new_from_buffer($buffer, 
+    public static function newFromBuffer($buffer, 
         $option_string = "", $options = []) 
     {
         $options = self::unwrap($options);
@@ -230,7 +230,7 @@ public static function new_from_buffer($buffer,
      *
      * @return A new Vips\Image.
      */
-    public static function new_from_array($array, $scale = 1, $offset = 0) 
+    public static function newFromArray($array, $scale = 1, $offset = 0) 
     {
         $result = vips_image_new_from_array($array, $scale, $offset);
         return self::wrap($result);
@@ -245,7 +245,7 @@ public static function new_from_array($array, $scale = 1, $offset = 0)
      *
      * @return bool TRUE for success and FALSE for failure.
      */
-    public function write_to_file($filename, $options = []) 
+    public function writeToFile($filename, $options = []) 
     {
         $options = self::unwrap($options);
         $result = vips_image_write_to_file($this->image, $filename, $options);
@@ -261,7 +261,7 @@ public function write_to_file($filename, $options = [])
      *
      * @return string The formatted image. 
      */
-    public function write_to_buffer($suffix, $options = []) 
+    public function writeToBuffer($suffix, $options = []) 
     {
         $options = self::unwrap($options);
         $result = vips_image_write_to_buffer($this->image, $suffix, $options);
@@ -488,7 +488,7 @@ public function more($other, $options = [])
         return self::call_enum($other, "relational", "more", $options);
     }
 
-    public function moreeq($other, $options = [])
+    public function moreEq($other, $options = [])
     {
         return self::call_enum($other, "relational", "moreeq", $options);
     }
@@ -498,7 +498,7 @@ public function less($other, $options = [])
         return self::call_enum($other, "relational", "less", $options);
     }
 
-    public function lesseq($other, $options = [])
+    public function lessEq($other, $options = [])
     {
         return self::call_enum($other, "relational", "lesseq", $options);
     }
@@ -508,7 +508,7 @@ public function equal($other, $options = [])
         return self::call_enum($other, "relational", "equal", $options);
     }
 
-    public function noteq($other, $options = [])
+    public function notEq($other, $options = [])
     {
         return self::call_enum($other, "relational", "noteq", $options);
     }