Add a Component

[yehiasalam]

Hi,

How about adding a component, sometimes you need to get the thumbnail using a normal GET request that's handled by the controller, I added a small component, pretty much the same as the helper:

settings, (array)$settings); ``` $this->Controller = $collection->getController(); $this->options = $options; parent::__construct($collection, $settings); ``` } private function init($options = array()) { $this->options = $options; $this->set_file_extension(); $this->thumb_data = array(); $this->error = 0; } private function set_file_extension() { $this->file_extension = substr($this->options['src'], strrpos($this->options['src'], '.'), strlen($this->options['src'])); } private function set_cache_filename() { ksort($this->options); $filename_parts = array(); $cacheable_properties = array('src', 'new', 'w', 'h', 'wp', 'hp', 'wl', 'hl', 'ws', 'hs', 'f', 'q', 'sx', 'sy', 'sw', 'sh', 'zc', 'bc', 'bg', 'fltr', 'far'); ``` foreach($this->options as $key => $value) { if(in_array($key, $cacheable_properties)) { $filename_parts[$key] = $value; } } $this->cache_filename = ''; foreach($filename_parts as $key => $value) { $this->cache_filename .= $key . $value; } $last_modified = date("F d Y H:i:s.", filectime($this->options['src'])); $this->cache_filename = $this->options['save_path'] . DS . md5($this->cache_filename . $last_modified) . $this->file_extension; ``` } private function image_is_cached() { if(is_file($this->cache_filename)) { return true; } return false; } private function create_thumb() { App::import('Vendor', 'PhpThumb.PhpThumb', array('file' => 'phpThumb'.DS.'phpthumb.class.php')); ``` $this->php_thumb = new phpThumb(); foreach($this->php_thumb as $var => $value) { if(isset($this->options[$var])) { $this->php_thumb->setParameter($var, $this->options[$var]); } } if($this->php_thumb->GenerateThumbnail()) { $this->php_thumb->RenderToFile($this->cache_filename); } else { $this->error = 1; $this->error_detail = ereg_replace("[^A-Za-z0-9\/: .]", "", $this->php_thumb->fatalerror); } ``` } private function get_thumb_data() { $this->thumb_data['error'] = $this->error; ``` if($this->error) { $this->thumb_data['error_detail'] = $this->error_detail; $this->thumb_data['src'] = $this->options['error_image_path']; } else { $this->thumb_data['src'] = $this->options['display_path'] . '/' . substr($this->cache_filename, strrpos($this->cache_filename, DS) + 1, strlen($this->cache_filename)); } if(isset($this->options['w'])) { $this->thumb_data['w'] = $this->options['w']; } else { $this->thumb_data['w'] = null; } if(isset($this->options['h'])) { $this->thumb_data['h'] = $this->options['h']; } else { $this->thumb_data['h'] = null; } return $this->thumb_data; ``` } private function validate() { if(!is_file($this->options['src'])) { $this->error = 1; $this->error_detail = 'File ' . $this->options['src'] . ' does not exist'; return; } ``` $valid_extensions = array('.gif', '.jpg', '.jpeg', '.png'); if(!in_array(strtolower($this->file_extension), $valid_extensions)) { $this->error = 1; $this->error_detail = 'File ' . $this->options['src'] . ' is not a supported image type'; return; } ``` } public function generate($options = array()) { ``` $this->init($options); $this->validate(); if(!$this->error) { $this->set_cache_filename(); if(!$this->image_is_cached()) { $this->create_thumb(); } } return $this->get_thumb_data(); ``` } function generateThumbnail($image, $options) { ``` $thumbs_path = Configure::read('PhpThumb.thumbs_path'); if (empty($thumbs_path)) { return false; } $pathOptions = array( 'save_path' => WWW_ROOT . $thumbs_path, 'display_path' => '/' . $thumbs_path, 'error_image_path' => Configure::read('PhpThumb.error_image_path') ); if (!empty($options['model'])) { // model images from MeioUpload if (empty($options['field'])) { return false; } $meioupload_path = Configure::read('PhpThumb.meioupload_path'); if (empty($meioupload_path)) { $meioupload_path = 'uploads'; } $options['src'] = sprintf('%s%s/%s/%s/%s', WWW_ROOT, $meioupload_path, strtolower($options['model']), $options['field'], $image ); unset($options['model']); unset($options['field']); } else { $options['src'] = WWW_ROOT . $image; } $finalOptions = array_merge($options, $pathOptions); return $this->generate($finalOptions); ``` } public function url($image, $options) { $thumbnail = $this->generateThumbnail($image, $options); if (!empty($thumbnail['error'])) { return false; } ``` return $thumbnail['src']; ``` } public function path($image, $options){ ``` return realpath(WWW_ROOT . $this->url($image, $options) ); ``` } }

[msadouni]

I see the point, but I'd rather avoid such code duplication. I guess the best in that case would be to extract the thumbnail generation in a lib class, used by both the helper and component.

[yehiasalam]

right, ill try to code it and do a commit

[jkritikos]

Hi there,

Struggling to get the component to work, did you by any chance complete your approach? :)

[msadouni]

I haven't, but it should be doable like I proposed before : a shared lib used both by a helper and a component.

Check out the CakePHP docs on how to create a Component, it's quite simple and well explained :

• 2.x : http://book.cakephp.org/2.0/en/controllers/components.html#creating-a-component
• 1.3 : http://book.cakephp.org/1.3/en/The-Manual/Developing-with-CakePHP/Components.html#creating-components

Concerning the lib, you create it in either libs or Lib depending on your CakePHP version, then import it and using as a regular class. It's also explained somehwere in the docs.