Changeset 1917 for plugins/apostrophePlugin/trunk/lib/model/doctrine/PluginaMediaItem.class.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/model/doctrine/PluginaMediaItem.class.php (modified) (4 diffs)

plugins/apostrophePlugin/trunk/lib/model/doctrine/PluginaMediaItem.class.php

@@ -20 +20 @@
     }
     // Let the culture be the user's culture
-    return aZendSearch::saveInDoctrineAndLucene($this, null, $conn);
+    $result = aZendSearch::saveInDoctrineAndLucene($this, null, $conn);
+    $crops = $this->getCrops();
+    foreach ($crops as $crop)
+    {
+      $crop->setTitle($this->getTitle());
+      $crop->setDescription($this->getDescription());
+      $crop->setCredit($this->getCredit());
+      $crop->save();
+    }
+    return $result;
   }
 
@@ -33 +42 @@
     $ret = aZendSearch::deleteFromDoctrineAndLucene($this, null, $conn);
     $this->clearImageCache();
+    
+    $this->deleteCrops();
+    
     // Don't even think about trashing the original until we know
     // it's gone from the db and so forth
@@ -132 +144 @@
     $path = $this->getOriginalPath($this->getFormat());
     $result = copy($file, $path);
+    // Crops are invalid if you replace the original image
+    $this->deleteCrops();
     return $result;
   }
@@ -249 +263 @@
     $options = aDimensions::constrain($this->getWidth(), $this->getHeight(), $this->getFormat(), $options);
 
-    return "aMediaBackend/image?" . http_build_query(
-      array("slug" => $this->slug, "width" => $options['width'], "height" => $options['height'], 
-        "resizeType" => $options['resizeType'], "format" => $options['format']));
+    $params = array("slug" => $this->slug, "width" => $options['width'], "height" => $options['height'], 
+      "resizeType" => $options['resizeType'], "format" => $options['format']);
+
+    // check for null because 0 is valid
+    if (!is_null($options['cropLeft']) && !is_null($options['cropTop']) && !is_null($options['cropWidth']) && !is_null($options['cropHeight']))
+    {      
+      $params = array_merge(
+        $params,
+        array("cropLeft" => $options['cropLeft'], "cropTop" => $options['cropTop'],
+          "cropWidth" => $options['cropWidth'], "cropHeight" => $options['cropHeight'])
+      );
+    }
+    return "aMediaBackend/image?" . http_build_query($params);
+  }
+  
+  public function getCropThumbnailUrl()
+  {    
+    $selectedConstraints = aMediaTools::getOption('selected_constraints');
+    
+    if ($aspectRatio = aMediaTools::getAspectRatio()) // this returns 0 if aspect-width and aspect-height were not set
+    {
+      $selectedConstraints = array_merge(
+        $selectedConstraints, 
+        array('height' => floor($selectedConstraints['width'] / $aspectRatio))
+      );
+    }
+    
+    
+    $imageInfo = aMediaTools::getAttribute('imageInfo');
+    if (isset($imageInfo[$this->id]['cropLeft']) &&
+        isset($imageInfo[$this->id]['cropTop']) && isset($imageInfo[$this->id]['cropWidth']) && isset($imageInfo[$this->id]['cropHeight']))
+    {
+      $selectedConstraints = array_merge(
+        $selectedConstraints, 
+        array(
+          'cropLeft' => $imageInfo[$this->id]['cropLeft'],
+          'cropTop' => $imageInfo[$this->id]['cropTop'],
+          'cropWidth' => $imageInfo[$this->id]['cropWidth'],
+          'cropHeight' => $imageInfo[$this->id]['cropHeight']
+        )
+      );
+    }
+      
+    return $this->getScaledUrl($selectedConstraints);
+  }
+  
+  // Crops of other images have periods in the slug. Real slugs are always [\w_]+ (well, the i18n equivalent)
+  public function isCrop()
+  {
+    return (strpos($this->slug, '.') !== false);
+  }
+  
+  public function getCrops()
+  {
+    // This should perform well because there is an index on the slug and
+    // indexes are great with prefix queries
+    return $this->getTable()->createQuery('m')->where('m.slug LIKE ?', array($this->slug . '.%'))->execute();
+    
+  }
+  
+  public function deleteCrops()
+  {
+    $crops = $this->getCrops();
+    // Let's make darn sure the PHP stuff gets called rather than using a delete all trick of some sort
+    foreach ($crops as $crop)
+    {
+      $crop->delete();
+    }
+  }
+  
+  public function findOrCreateCrop($info)
+  {
+    $slug = $this->slug . '.' . $info['cropLeft'] . '.' . $info['cropTop'] . '.' . $info['cropWidth'] . '.' . $info['cropHeight'];
+    $crop = $this->getTable()->findOneBySlug($slug);
+    if (!$crop)
+    {
+      $crop = $this->copy(false);
+      $crop->slug = $slug;
+      $crop->width = $info['cropWidth'];
+      $crop->height = $info['cropHeight'];
+    }
+    return $crop;
+  }
+  
+  public function getCroppingInfo()
+  {
+    $p = preg_split('/\./', $this->slug);
+    if (count($p) == 5)
+    {
+      return array('cropLeft' => $p[1], 'cropTop' => $p[2], 'cropWidth' => $p[3], 'cropHeight' => $p[4]);
+    }
+    else
+    {
+      return array();
+    }
+  }
+  
+  public function getCropOriginal()
+  {
+    if (!$this->isCrop())
+    {
+      return $this;
+    }
+    $p = preg_split('/\./', $this->slug);
+    return $this->getTable()->findOneBySlug($p[0]);
   }
 }