Changeset 1917 for plugins/apostrophePlugin/trunk/lib/toolkit/aMediaTools.php

Timestamp:

08/08/10 12:18:34 (22 months ago)

Author:

tboutell

Message:

Merged the cropping branch back to trunk:

Cropping is now available in the media repository. Every time you select an image for use on the site you have the opportunity to crop it. The image size constraints of the slot are taken into account. This means that you can satisfy a given set of constraints by cropping a wide variety of images that would not have been eligible for selection before.

Crops of existing images appear in the database as separate aMediaItem objects but do not duplicate the original image file. This means that many crops of a single source image can exist without significant overhead.

The slug field of a cropped version of an image contains cropping parameters. When rendering the image, Symfony routes spot these and crop the original file as needed.

By approaching the problem this way we have avoided the need for code that takes advantage of the media repository's image selection capabilities to change in any way in order to take advantage of cropping.

The single-image-select behavior of Apostrophe has changed to accommodate the extra cropping step. Single select for PDFs and videos still uses the selectSingle partial because they cannot be cropped.

Thanks to Spike Broehm for his contributions to the cropping project.

Fixes #227

Location:

plugins/apostrophePlugin/trunk

Files:

• . (modified) (1 prop)
• lib/toolkit/aMediaTools.php (modified) (3 diffs)

plugins/apostrophePlugin/trunk/lib/toolkit/aMediaTools.php

@@ -3 +3 @@
 class aMediaTools
 {
-  // These are used internally. If you want to select something
-  // with the media module please see the README, do not use these 
-  // methods directly
+  // These are used internally. See aMediaSelect for the methods you probably want
 
   static public function setSelecting($after, $multiple, $selection, 
     $options = array())
   {
+    $items = aMediaItemTable::retrieveByIds($selection);
+    $ids = array();
+    $imageInfo = array();
+    $selection = array();
+    foreach ($items as $item)
+    {
+      $croppingInfo = array();
+      if ($item->isCrop())
+      {
+        $croppingInfo = $item->getCroppingInfo();
+        $item = $item->getCropOriginal();
+      }
+      $id = $item->id;
+      $selection[] = $id;
+      $info = array('width' => $item->width, 'height' => $item->height);
+      $info = array_merge($info, $croppingInfo);
+      $imageInfo[$item->id] = $info;
+    }
+    
+    $cropping = isset($options['cropping']) && $options['cropping'];
+
     self::clearSelecting();
     self::setAttribute("selecting", true);
     self::setAttribute("after", $after);
     self::setAttribute("multiple", $multiple);
+    self::setAttribute("cropping", $cropping);
     self::setAttribute("selection", $selection);
+    self::setAttribute("imageInfo", $imageInfo);
     foreach ($options as $key => $val)
     {
@@ -140 +161 @@
     "selected_constraints" => array(
         "width" => 100,
-        "height" => 75,
-        "resizeType" => "c"),
+        "height" => false,
+        "resizeType" => "c",),
     "show_constraints" => array(
         "width" => 720,
         "height" => false,
+        "resizeType" => "s"),
+    "crop_constraints" => array(
+        "width" => 679,
+        "height" => 400,
         "resizeType" => "s"),
     'routes_register' => true,
@@ -188 +213 @@
     return $item;
   }
+  
+  // refactored this into this static method from executeMultipleList() because it is now needed
+  // for executeUpdateMultiplePreview() for cropping slideshow items
+  static public function getSelectedItems()
+  {
+    $selection = self::getSelection();
+    if (!is_array($selection))
+    {
+      throw new Exception("selection is not an array");
+    }
+    // Work around the fact that whereIn doesn't evaluate to AND FALSE
+    // when the array is empty (it just does nothing; which is an
+    // interesting variation on MySQL giving you an ERROR when the 
+    // list is empty, sigh)
+    if (count($selection))
+    {
+      // Work around the unsorted results of whereIn. You can also
+      // do that with a FIELD function
+      $unsortedItems = Doctrine_Query::create()->
+        from('aMediaItem i')->
+        whereIn('i.id', $selection)->
+        execute();
+      $itemsById = array();
+      foreach ($unsortedItems as $item)
+      {
+        $itemsById[$item->getId()] = $item;
+      }
+      $items = array();
+      foreach ($selection as $id)
+      {
+        if (isset($itemsById[$id]))
+        {
+          $items[] = $itemsById[$id];
+        }
+      }
+    }
+    else
+    {
+      $items = array();
+    }
+    
+    return $items;
+  }
+  
+  static public function getAspectRatio()
+  {
+    if (self::getAttribute('aspect-width') && self::getAttribute('aspect-width'))
+    {
+      return self::getAttribute('aspect-width') / self::getAttribute('aspect-height');
+    }
+    return 0;
+  }
+  
+  static public function getSelectedThumbnailHeight()
+  {
+    $selectedConstraints = self::getOption('selected_constraints');
+    if (false === $selectedConstraints['height'])
+    {
+      if ($aspectRatio = self::getAspectRatio())
+      {
+        return $selectedConstraints['width'] / $aspectRatio;
+      }
+      return 0; // Let's not divide by zero.
+    }
+    return $selectedConstraints['height'];
+  }
+  
+  /**
+   * This mirrors the default size math in aCrop.setAspectMask() in aCrop.js
+   */
+  static public function setDefaultCropDimensions($mediaItem)
+  {
+    $imageInfo = self::getAttribute('imageInfo');
+    $aspectRatio = self::getAspectRatio();
+    
+    if ($aspectRatio)
+    {    
+      if ($aspectRatio > 1)
+      {
+        $imageInfo[$mediaItem->id]['cropWidth'] = $mediaItem->getWidth();
+        $imageInfo[$mediaItem->id]['cropHeight'] = floor($mediaItem->getWidth() / $aspectRatio);
+      }
+      else
+      {
+        $imageInfo[$mediaItem->id]['cropHeight'] = $mediaItem->getHeight();
+        $imageInfo[$mediaItem->id]['cropWidth'] = floor($mediaItem->getHeight() * $aspectRatio);
+      }
+    }
+    else
+    {
+      $imageInfo[$mediaItem->id]['cropWidth'] = $mediaItem->getWidth();
+      $imageInfo[$mediaItem->id]['cropHeight'] = $mediaItem->getHeight();
+    }
+    
+    $imageInfo[$mediaItem->id]['cropLeft'] = 0;
+    $imageInfo[$mediaItem->id]['cropTop'] = floor(($mediaItem->getHeight() - $imageInfo[$mediaItem->id]['cropHeight']) / 2);
+        
+    self::setAttribute('imageInfo', $imageInfo);
+  }
 }