PlatoCreative\Imgix\Imgix
Represents an Image via Imgix
Synopsis
class Imgix
extends Image
{
- // constants
- const ORIENTATION_SQUARE = 0;
- const ORIENTATION_PORTRAIT = 1;
- const ORIENTATION_LANDSCAPE = 2;
- // members
- private static $sub_domain = NULL;
- private static $secure_url_token = NULL;
- private static string $folder_path = 'assets/';
- protected boolean $responsive = false;
- protected array $parameters = ;
- private static boolean $use_imgix = true;
- private static array $casting = ;
- // methods
- public string getTag()
- public string forTemplate()
- public string getURL()
- public string Link()
- public Image|null CMSThumbnail()
- public Image|null StripThumbnail()
- public Image|null Fit()
- public Image FitMax()
- public Image|null Fill()
- public Image FillMax()
- public Image|null Pad()
- public Image|null ScaleWidth()
- public Image ScaleMaxWidth()
- public Image|null ScaleHeight()
- public Image ScaleMaxHeight()
- public Image CropWidth()
- public Image CropHeight()
- public void Responsive()
- public void Compress()
- public void Enhance()
- public void Format()
- public void Redeye()
- public void Top()
- public void Bottom()
- public void Left()
- public void Right()
- public void Faces()
- public void Entropy()
- public void Edges()
- public void FocusPoint()
- public void FocusFill()
- public void FocusFillMax()
- public void FocusCropWidth()
- public void FocusCropHeight()
- public void setParameter()
- public void getParameter()
- public boolean isSize()
- public boolean isWidth()
- public boolean isHeight()
- public void setDimensions()
Hierarchy
Extends
- SilverStripe\Assets\Image
Constants
Name | Value |
---|---|
ORIENTATION_SQUARE | 0 |
ORIENTATION_PORTRAIT | 1 |
ORIENTATION_LANDSCAPE | 2 |
Members
private
- $casting
- $folder_path
- $secure_url_token
- $sub_domain
- $use_imgix
protected
- $parameters
- $responsive
Methods
public
- Bottom()
- CMSThumbnail() — Resize this image for the CMS. Use in templates with $CMSThumbnail
- Compress()
- CropHeight() — Crop image on Y axis if it exceeds specified height. Retain width.
- CropWidth() — Crop image on X axis if it exceeds specified width. Retain height.
- Edges()
- Enhance()
- Entropy()
- Faces()
- Fill() — Resize and crop image to fill specified dimensions.
- FillMax() — Crop this image to the aspect ratio defined by the specified width and height, then scale down the image to those dimensions if it exceeds them.
- Fit() — Scale image proportionally to fit within the specified bounds
- FitMax() — Proportionally scale down this image if it is wider or taller than the specified dimensions.
- FocusCropHeight()
- FocusCropWidth()
- FocusFill()
- FocusFillMax()
- FocusPoint()
- Format()
- Left()
- Link() — Alias for getURL().
- Pad() — Fit image to specified dimensions and fill leftover space with a solid colour (default white). Use in templates with $Pad.
- Redeye()
- Responsive()
- Right()
- ScaleHeight() — Scale image proportionally by height. Use in templates with $ScaleHeight.
- ScaleMaxHeight() — Proportionally scale down this image if it is taller than the specified height.
- ScaleMaxWidth() — Proportionally scale down this image if it is wider than the specified width.
- ScaleWidth() — Scale image proportionally by width. Use in templates with $ScaleWidth.
- StripThumbnail() — Resize this image for use as a thumbnail in a strip. Use in templates with $StripThumbnail.
- Top()
- forTemplate() — Return an XHTML img tag for this Image.
- getParameter()
- getTag() — Return an XHTML img tag for this Image, or NULL if the image file doesn't exist on the filesystem.
- getURL() — Gets the relative URL accessible through the web.
- isHeight() — Determine if this image is of the specified width
- isSize() — Determine if this image is of the specified size
- isWidth() — Determine if this image is of the specified width
- setDimensions()
- setParameter()