<?php
/**
 * Interface for SLIR Image Library
 *
 * This file is part of SLIR (Smart Lencioni Image Resizer).
 *
 * Copyright (c) 2014 Joe Lencioni <joe.lencioni@gmail.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 * @copyright Copyright © 2014, Joe Lencioni
 * @license MIT
 * @since 4.9.0
 * @package SLIR
 */

/**
 * SLIR Image Library interface
 * @package SLIR
 * @since 4.9.0
 */
namespace lencioni\SLIR\libs;

interface SLIRImageLibrary
{
  /**
   * Resamples the image into the destination image
   * @param SLIRImageLibrary $destination
   * @param integer $width
   * @param integer $height
   * @return SLIRImageLibrary
   * @since 4.9.0
   */
  public function resample(SLIRImageLibrary $destination);

  /**
   * Copies the image into the destination image without reszing
   * @param SLIRImageLibrary $destination
   * @return SLIRImageLibrary
   * @since 4.9.0
   */
  public function copy(SLIRImageLibrary $destination);

  /**
   * Sets the path of the file
   * @param string $path
   * @return SLIRImageLibrary
   * @since 4.9.0
   */
  public function setPath($path);

  /**
   * Gets the path of the file
   * @return string
   * @since 4.9.0
   */
  public function getPath();

  /**
   * Sets the path of the original file
   * @param string $path
   * @return SLIRImageLibrary
   * @since 4.9.0
   */
  public function setOriginalPath($path);

  /**
   * Gets the path of the original file
   * @return string
   * @since 4.9.0
   */
  public function getOriginalPath();

  /**
   * Gets the width of the image
   * @return integer
   * @since 4.9.0
   */
  public function getWidth();

  /**
   * Gets the height of the image
   * @return integer
   * @since 4.9.0
   */
  public function getHeight();

  /**
   * Sets the width of the image
   * @param integer $width
   * @return SLIRImageLibrary
   * @since 4.9.0
   */
  public function setWidth($width);

  /**
   * Sets the height of the image
   * @param integer $height
   * @return SLIRImageLibrary
   * @since 4.9.0
   */
  public function setHeight($height);

  /**
   * Gets the width of the cropped image
   * @return integer
   * @since 4.9.0
   */
  public function getCropWidth();

  /**
   * Gets the height of the cropped image
   * @return integer
   * @since 4.9.0
   */
  public function getCropHeight();

  /**
   * Sets the width of the cropped image
   * @param integer $width
   * @return SLIRImageLibrary
   * @since 4.9.0
   */
  public function setCropWidth($width);

  /**
   * Sets the height of the cropped image
   * @param integer $height
   * @return SLIRImageLibrary
   * @since 4.9.0
   */
  public function setCropHeight($height);

  /**
   * Gets cropper to be used
   * @return string
   * @since 4.9.0
   */
  public function getCropper();

  /**
   * Sets the cropper to be used
   * @param string $cropper
   * @return SLIRImageLibrary
   * @since 4.9.0
   */
  public function setCropper($cropper);

  /**
   * @return integer
   * @since 4.9.0
   */
  public function getArea();

  /**
   * Gets info about the image
   * @param string $info
   * @return mixed
   * @since 4.9.0
   */
  public function getInfo($info = null);

  /**
   * Gets the width / height
   * @return float
   * @since 4.9.0
   */
  public function getRatio();

  /**
   * Gets the cropWidth / cropHeight
   * @return float
   * @since 4.9.0
   */
  public function getCropRatio();

  /**
   * Gets the MIME type of the image
   * @return string
   * @since 4.9.0
   */
  public function getMimeType();

  /**
   * @return string raw image data
   * @since 4.9.0
   */
  public function getData();

  /**
   * @return integer size of image data
   */
  public function getDatasize();

  /**
   * Creates a new, blank image
   * @param integer $width
   * @param integer $height
   * @return SLIRImageLibrary
   */
  public function create();

  /**
   * @return integer
   * @since 4.9.0
   */
  public function getQuality();

  /**
   * @param integer $quality
   * @return SLIRImageLibrary
   */
  public function setQuality($quality);

  /**
   * @return string
   * @since 4.9.0
   */
  public function getBackground();

  /**
   * @param string $color in hex
   * @return SLIRImageLibrary
   */
  public function setBackground($color);

  /**
   * Turns on transparency for image if no background fill color is
   * specified, otherwise, fills background
   *
   * @since 4.9.0
   * @return SLIRImageLibrary
   */
  public function background();

  /**
   * Turns on the alpha channel to enable transparency in the image
   * @return SLIRImageLibrary
   * @since 4.9.0
   */
  public function enableTransparency($destination = '');

  /**
   * Fills the image with the set background color
   * @return SLIRImageLibrary
   * @since 4.9.0
   */
  public function fill();

  /**
   * @return boolean
   * @since 4.9.0
   */
  public function getProgressive();

  /**
   * @param boolean $progressive
   * @return SLIRImageLibrary
   */
  public function setProgressive($progressive);

  /**
   * Turns interlacing on or off
   * @return SLIRImageLibrary
   * @since 4.9.0
   */
  public function interlace();

  /**
   * Performs the actual cropping of the image
   *
   * @param integer $cropWidth
   * @param integer $cropHeight
   * @param string $fill color in hex
   * @return SLIRImageLibrary
   * @since 4.9.0
   */
  public function crop();

  /**
   * @return float
   * @since 4.9.0
   */
  public function getSharpeningFactor();

  /**
   * @param float $sharpeningFactor
   * @return SLIRImageLibrary
   */
  public function setSharpeningFactor($sharpeningFactor);

  /**
   * Sharpens the image
   * @return SLIRImageLibrary
   * @since 4.9.0
   */
  public function sharpen();

  /**
   * Outputs the image to the client
   * @return SLIRImageLibrary
   * @since 4.9.0
   */
  public function output();

  /**
   * Saves the image to disk
   * @param string $path
   * @return SLIRImageLibrary
   * @since 4.9.0
   */
  public function save();

  /**
   * Destroys the image resource
   * @return SLIRImageLibrary
   * @since 4.9.0
   */
  public function destroy();

  /**
   * Resizes, crops, sharpens, fills background, etc.
   * @return SLIRImageLibrary
   * @since 4.9.0
   */
  public function applyTransformations();
}
