Overview

Namespaces

  • Scene7
    • Commands
      • Layer
    • Definitions
    • Helpers
      • Html
        • Attributes
    • Requests

Classes

  • Layer

Traits

  • Align
  • Anchor
  • BackgroundColor
  • Cache
  • ColorQuantization
  • Crop
  • DefaultImage
  • EmbedColorProfile
  • EmbedPathData
  • Fit
  • Format
  • Height
  • Id
  • LayerFactory
  • Locale
  • Mask
  • MaskUse
  • MaxJpegSize
  • Message
  • Name
  • OutputColorProfile
  • Perspective
  • PrintResolution
  • Quality
  • RegionOfInterest
  • Resampling
  • Resolution
  • ResponseType
  • Scale
  • ScaleView
  • Template
  • Timeout
  • Type
  • UnsharpMask
  • ViewRectangle
  • Width
  • XmpEmbed
  • Overview
  • Namespace
  • Class
 1:  2:  3:  4:  5:  6:  7:  8:  9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 
<?php

namespace Scene7\Commands;

use Scene7\Definitions\MaskUses;

trait MaskUse
{
    /**
     * @param string $use One of MaskUses
     * @return $this
     */
    public function setMaskUse($use)
    {
        if (!in_array($use, $this->getAllowedMaskUses())) {
            throw new \InvalidArgumentException('Invalid mask usage');
        }

        $this->addCommand(['maskUse' => $use]);
        return $this;
    }

    /**
     * @return string[]
     */
    public function getAllowedMaskUses()
    {
        return [
            MaskUses::NORM,
            MaskUses::INVERT,
            MaskUses::OFF,
        ];
    }
}
API documentation generated by ApiGen