Index
A
- Action — Class in namespace Bolt\Thumbs
- Actions used when creating thumbnails.
- $Color — Property in class Color
- Controller::alias() — Method in class Controller
- Returns a thumbnail response.
- Creator::autoscale() — Method in class Creator
- If target width and/or height are set to 0, they are set based on the image's height/width.
- ImageResource::allocateColor() — Method in class ImageResource
- Allocate a color for an image.
- ImageResource::allocateTransparentColor() — Method in class ImageResource
- Allocate a transparent color for an image.
- $Transaction — Property in class Transaction
B
C
- Color — Class in namespace Bolt\Thumbs
- An object representation of a color.
- Controller — Class in namespace Bolt\Thumbs
- Controller for the thumbnail route.
- Controller::connect() — Method in class Controller
- {@inheritdoc}
- Creator — Class in namespace Bolt\Thumbs
- Creates thumbnails.
- Creator::create() — Method in class Creator
- Creates a thumbnail for the given transaction.
- Creator::checkForUpscale() — Method in class Creator
- Limits the target width/height to the image's height/width if upscale is not allowed.
- CreatorInterface — Class in namespace Bolt\Thumbs
- CreatorInterface::create() — Method in class CreatorInterface
- Creates a thumbnail for the given transaction.
- ImageResource::createFromFile() — Method in class ImageResource
- Creates an ImageResource from a file.
- ImageResource::createFromString() — Method in class ImageResource
- Creates an ImageResource from a string of image data.
- ImageResource::createNew() — Method in class ImageResource
- Creates a new image given the width and height.
- ImageResource::convertJpegQualityToPngCompression() — Method in class ImageResource
- Convert JPEG quality scale to PNG compression scale.
- ImageResource::convertPngCompressionToJpegQuality() — Method in class ImageResource
- Convert PNG compression scale to JPEG quality scale.
- $Responder — Property in class Responder
- $Responder — Property in class Responder
- $Responder — Property in class Responder
- Response::create() — Method in class Response
- Factory method for chainability.
D
- Controller::defaultResponse() — Method in class Controller
- Get the default error image on restriction errors or undefined aliases
- $Finder — Property in class Finder
E
- $Responder — Property in class Responder
- $Transaction — Property in class Transaction
F
- Finder — Class in namespace Bolt\Thumbs
- $Finder — Property in class Finder
- $Finder — Property in class Finder
- Finder::find() — Method in class Finder
- Searches the filesystem for the image based on the path, or returns the default image if not found.
- FinderInterface — Class in namespace Bolt\Thumbs
- FinderInterface::find() — Method in class FinderInterface
- Finds the image based on the given path.
- ImageResource::fill() — Method in class ImageResource
- Flood fill.
- ImageResource::flip() — Method in class ImageResource
- Flips the image.
- $Responder — Property in class Responder
- $Transaction — Property in class Transaction
G
- $Color — Property in class Color
- Color::getRed() — Method in class Color
- Color::getGreen() — Method in class Color
- Color::getBlue() — Method in class Color
- Color::getAlpha() — Method in class Color
- Color::getIndex() — Method in class Color
- ImageResource::getResource() — Method in class ImageResource
- Returns the GD resource.
- ImageResource::getDimensions() — Method in class ImageResource
- Returns the image dimensions.
- ImageResource::getType() — Method in class ImageResource
- Returns the image type.
- ImageResource::getInfo() — Method in class ImageResource
- Returns the image's info.
- ImageResource::getExif() — Method in class ImageResource
- ImageResource::getColorAt() — Method in class ImageResource
- Returns the color at a point.
- ImageResource::getQuality() — Method in class ImageResource
- Returns the quality setting.
- Point::getX() — Method in class Point
- Returns the x-coordinate of the point.
- Point::getY() — Method in class Point
- Returns the y-coordinate of the point.
- Responder::getThumbnail() — Method in class Responder
- Returns thumbnail data for the given transaction.
- Response::getThumbnail() — Method in class Response
- Thumbnail::getImage() — Method in class Thumbnail
- Thumbnail::getThumbnail() — Method in class Thumbnail
- Transaction::getHash() — Method in class Transaction
- Returns a hash string of this transaction.
- Transaction::getRequestPath() — Method in class Transaction
- Returns the request path for this thumbnail, used for saving a static file.
- Transaction::getFilePath() — Method in class Transaction
- Returns the filepath. Used for finding image in filesystem.
- Transaction::getSrcImage() — Method in class Transaction
- Transaction::getErrorImage() — Method in class Transaction
- Transaction::getAction() — Method in class Transaction
- Transaction::getTarget() — Method in class Transaction
I
- $Color — Property in class Color
- Controller::isRestricted() — Method in class Controller
- Check if thumbnail request for specific resolution is allowed
- ImageResource — Class in namespace Bolt\Thumbs
- An object representation of GD's native image resources.
- $ImageResource — Property in class ImageResource
- ImageResource::isJpegOrientationNormalized() — Method in class ImageResource
- Returns whether JPEG orientation is normalized or not.
- $Thumbnail — Property in class Thumbnail
L
N
- $ImageResource — Property in class ImageResource
- ImageResource::normalizeJpegOrientation() — Method in class ImageResource
- If orientation in EXIF data is not normal, flip and/or rotate image until it is correct
P
- Point — Class in namespace Bolt\Thumbs
- A value object which has X and Y coordinates.
Q
- $ImageResource — Property in class ImageResource
R
- $Color — Property in class Color
- Creator::resize() — Method in class Creator
- Do the actual resize/crop/fit/border logic and return the image data.
- Creator::resizeSvg() — Method in class Creator
- Resize SVG image.
- $ImageResource — Property in class ImageResource
- ImageResource::resample() — Method in class ImageResource
- Resize part of an image with resampling.
- ImageResource::rotate() — Method in class ImageResource
- Rotates the image.
- ImageResource::resetInfo() — Method in class ImageResource
- If image changes, info needs to be recreated
- Responder — Class in namespace Bolt\Thumbs
- Responder is responsible for processing the transaction.
- Responder::respond() — Method in class Responder
- Process the transaction and return a thumbnail.
- ResponderInterface — Class in namespace Bolt\Thumbs
- ResponderInterface::respond() — Method in class ResponderInterface
- Process the transaction and return a thumbnail.
- Response — Class in namespace Bolt\Thumbs
- A Thumbnail Response.
- ServiceProvider::register() — Method in class ServiceProvider
- {@inheritdoc}
- $Transaction — Property in class Transaction
S
- Controller::serve() — Method in class Controller
- Serve a request for a thumbnail
- $Creator — Property in class Creator
- ImageResource::setNormalizeJpegOrientation() — Method in class ImageResource
- Enable or disable JPEG orientation normalization.
- ImageResource::setQuality() — Method in class ImageResource
- Sets the quality setting.
- Point::setX() — Method in class Point
- Sets the x-coordinate for this point.
- Point::setY() — Method in class Point
- Sets the x-coordinate for this point.
- Responder::saveStaticThumbnail() — Method in class Responder
- Saves a static copy of the thumbnail to the web folder.
- Response::setThumbnail() — Method in class Response
- Response::setAutoLastModified() — Method in class Response
- Automatically sets the Last-Modified header according the file modification date.
- Response::setAutoEtag() — Method in class Response
- Automatically sets the ETag header according to the checksum of the file.
- ServiceProvider — Class in namespace Bolt\Thumbs
- Register thumbnails service.
- $Transaction — Property in class Transaction
- Transaction::setSrcImage() — Method in class Transaction
- Transaction::setErrorImage() — Method in class Transaction
- Transaction::setAction() — Method in class Transaction
- Transaction::setTarget() — Method in class Transaction
T
- Color::transparent() — Method in class Color
- Shortcut to create a transparent color.
- Controller::thumbnail() — Method in class Controller
- Returns a thumbnail response.
- $ImageResource — Property in class ImageResource
- ImageResource::toFile() — Method in class ImageResource
- Writes the image to a file.
- ImageResource::toString() — Method in class ImageResource
- Returns the image as a data string.
- $Response — Property in class Response
- Thumbnail — Class in namespace Bolt\Thumbs
- Stores thumbnail data and image file.
- $Thumbnail — Property in class Thumbnail
- Transaction — Class in namespace Bolt\Thumbs
- A storage entity for a thumbnail creation request.
- $Transaction — Property in class Transaction
V
- Creator::verifyInfo() — Method in class Creator
- Verifies that the image's info can be read correctly.
- ImageResource::verifyColor() — Method in class ImageResource
- Verifies that a color is allocated.
- Point::verify() — Method in class Point
- Verifies that the coordinate is valid.
W
- Color::white() — Method in class Color
- Shortcut to create a white color.
- $Responder — Property in class Responder
X
Y
_
- Color::__construct() — Method in class Color
- Color constructor.
- Creator::__construct() — Method in class Creator
- Creator constructor.
- Finder::__construct() — Method in class Finder
- Finder constructor.
- ImageResource::__construct() — Method in class ImageResource
- Constructor.
- ImageResource::__toString() — Method in class ImageResource
- ImageResource::__clone() — Method in class ImageResource
- ImageResource::__destroy() — Method in class ImageResource
- Point::__construct() — Method in class Point
- Point constructor.
- Point::__toString() — Method in class Point
- Responder::__construct() — Method in class Responder
- Responder constructor.
- Response::__construct() — Method in class Response
- Constructor.
- Thumbnail::__construct() — Method in class Thumbnail
- Thumbnail constructor.
- Thumbnail::__toString() — Method in class Thumbnail
- {@inheritdoc}
- Transaction::__construct() — Method in class Transaction
- Transaction Constructor.