API Documentation
\
Composer
Autoload
Controllers
Admin
Core
core
DebugBar
Bridge
SwiftMailer
Twig
DataCollector
PDO
DataFormatter
Storage
Helpers
lib
Lib
Models
PHPThumb
Plugins
Tests
Psr
Log
Test
Symfony
Component
HttpFoundation
File
Exception
MimeType
Session
Attribute
Flash
Storage
Handler
Proxy
Tests
File
MimeType
Session
Attribute
Flash
Storage
Handler
Proxy
VarDumper
Caster
Cloner
Dumper
Exception
Test
Tests
Caster
Fixture
Test

\PHPThumbPHPThumb

PhpThumb : PHP Thumb Library <http://phpthumb.gxdlabs.com> Copyright (c) 2009, Ian Selby/Gen X Design

Author(s): Ian Selby ian@gen-x-design.com

Licensed under the MIT License Redistributions of files must retain the above copyright notice.

Summary

Methods
Properties
Constants
__construct()
setOptions()
getFileName()
setFileName()
getFormat()
setFormat()
getIsRemoteImage()
No public properties found
No constants found
validateRequestedResource()
$fileName
$filesystem
$format
$remoteImage
$plugins
N/A
No private methods found
No private properties found
N/A

Properties

$fileName

$fileName : string

The name of the file we're manipulating This must include the path to the file (absolute paths recommended)

Type

string

$filesystem

$filesystem : \Symfony\Component\Filesystem\Filesystem

Type

\Symfony\Component\Filesystem\Filesystem

$format

$format : string

What the file format is (mime-type)

Type

string

$remoteImage

$remoteImage : boolean

Whether or not the image is hosted remotely

Type

boolean

$plugins

$plugins : array

An array of attached plugins to execute in order.

Type

array

Methods

__construct()

__construct(  $fileName, array  $options = array(), array  $plugins = array())

Parameters

$fileName
array $options
array $plugins

setOptions()

setOptions(array  $options = array())

Parameters

array $options

getFileName()

getFileName() : string

Returns the filename.

Returns

string

setFileName()

setFileName(  $fileName) : \PHPThumb\PHPThumb

Sets the filename.

Parameters

$fileName

Returns

\PHPThumb\PHPThumb

getFormat()

getFormat() : string

Returns the format.

Returns

string

setFormat()

setFormat(  $format) : \PHPThumb\PHPThumb

Sets the format.

Parameters

$format

Returns

\PHPThumb\PHPThumb

getIsRemoteImage()

getIsRemoteImage() : boolean

Returns whether the image exists remotely, i.e. it was loaded via a URL.

Returns

boolean

validateRequestedResource()

validateRequestedResource(  $filename) : boolean

Check the provided filename/url. If it is a url, validate that it is properly formatted. If it is a file, check to make sure that it actually exists on the filesystem.

Parameters

$filename

Returns

boolean