EZ-Components

2026-07-21 17:02:19 +00:00 · 2009-02-17 15:27:43 +00:00
parent 359c3c55c9
commit 0a8e90a8b3
572 changed files with 64490 additions and 0 deletions
@@ -0,0 +1,90 @@
+<?php
+/**
+ * File containing the ezcImageEffectFilters interface.
+ *
+ * @package ImageConversion
+ * @version 1.3.5
+ * @copyright Copyright (C) 2005-2008 eZ systems as. All rights reserved.
+ * @license http://ez.no/licenses/new_bsd New BSD License
+ * @filesource
+*/
+
+/**
+ * This interface has to be implemented by ezcImageFilters classes to
+ * support effect filters.
+ *
+ * @see ezcImageHandler
+ * @see ezcImageTransformation
+ * @see ezcImageFiltersInterface
+ *
+ * @package ImageConversion
+ * @version 1.3.5
+ */
+interface ezcImageEffectFilters
+{
+    /**
+     * Noise filter.
+     * Apply a noise transformation to the image. Valid values are the following 
+     * strings:
+     * - 'Uniform'
+     * - 'Gaussian'
+     * - 'Multiplicative'
+     * - 'Impulse'
+     * - 'Laplacian'
+     * - 'Poisson'
+     *
+     * @param strings $value Noise value as described above.
+     * @return void
+     *
+     * @throws ezcImageFilterFailedException
+     *         If the operation performed by the the filter failed.
+     * @throws ezcBaseValueException
+     *         If a submitted parameter was out of range or type.
+     * @throws ezcImageInvalidReferenceException
+     *         No loaded file could be found or an error destroyed a loaded reference.
+     */
+    function noise( $value );
+
+    /**
+     * Swirl filter.
+     * Applies a swirl with the given intense to the image.
+     *
+     * @param int $value Intense of swirl.
+     * @return void
+     *
+     * @throws ezcImageInvalidReferenceException
+     *         No loaded file could be found or an error destroyed a loaded reference.
+     * @throws ezcImageFilterFailedException
+     *         If the operation performed by the the filter failed.
+     * @throws ezcBaseValueException
+     *         If a submitted parameter was out of range or type.
+     */
+    function swirl( $value );
+
+    /**
+     * Border filter.
+     * Adds a border to the image. The width is measured in pixel. The color is 
+     * defined in an array of hex values:
+     *
+     * <code>
+     * array( 
+     *      0 => <red value>,
+     *      1 => <green value>,
+     *      2 => <blue value>,
+     * );
+     * </code>
+     *
+     * @param int $width        Width of the border.
+     * @param array(int) $color Color.
+     * @return void
+     * 
+     * @throws ezcImageInvalidReferenceException
+     *         No loaded file could be found or an error destroyed a loaded reference.
+     * @throws ezcImageFilterFailedException
+     *         If the operation performed by the the filter failed.
+     * @throws ezcBaseValueException
+     *         If a submitted parameter was out of range or type.
+     */
+    function border( $width, array $color );
+}
+?>