Autodoc
  • Namespace
  • Class
  • Tree

Namespaces

  • BlueTihi
    • Context
  • Brickrouge
    • Element
      • Nodes
    • Renderer
    • Widget
  • ICanBoogie
    • ActiveRecord
    • AutoConfig
    • CLDR
    • Composer
    • Core
    • Event
    • Exception
    • HTTP
      • Dispatcher
      • Request
    • I18n
      • Translator
    • Mailer
    • Modules
      • Taxonomy
        • Support
      • Thumbnailer
        • Versions
    • Object
    • Operation
      • Dispatcher
    • Prototype
    • Routes
    • Routing
      • Dispatcher
    • Session
  • Icybee
    • ActiveRecord
      • Model
    • ConfigOperation
    • Document
    • EditBlock
    • Element
      • ActionbarContextual
      • ActionbarSearch
      • ActionbarToolbar
    • FormBlock
    • Installer
    • ManageBlock
    • Modules
      • Articles
      • Cache
        • Collection
        • ManageBlock
      • Comments
        • ManageBlock
      • Contents
        • ManageBlock
      • Dashboard
      • Editor
        • Collection
      • Files
        • File
        • ManageBlock
      • Forms
        • Form
        • ManageBlock
      • I18n
      • Images
        • ManageBlock
      • Members
      • Modules
        • ManageBlock
      • Nodes
        • ManageBlock
        • Module
      • Pages
        • BreadcrumbElement
        • LanguagesElement
        • ManageBlock
        • NavigationBranchElement
        • NavigationElement
        • Page
        • PageController
      • Registry
      • Search
      • Seo
      • Sites
        • ManageBlock
      • Taxonomy
        • Terms
          • ManageBlock
        • Vocabulary
          • ManageBlock
      • Users
        • ManageBlock
        • NonceLogin
        • Roles
      • Views
        • ActiveRecordProvider
        • Collection
        • View
    • Operation
      • ActiveRecord
      • Constructor
      • Module
      • Widget
    • Rendering
  • None
  • Patron
  • PHP

Classes

  • AdjustThumbnailOptions
  • AdjustThumbnailVersion
  • CacheManager
  • GetOperation
  • Hooks
  • Module
  • PopThumbnailVersion
  • Thumbnail
  • Version
  • Versions

Exceptions

  • VersionNotDefined

Constants

  • CACHE_VERSIONS

Class GetOperation

ICanBoogie\Object implements ICanBoogie\ToArrayRecursive uses ICanBoogie\ToArrayRecursiveTrait, ICanBoogie\PrototypeTrait
Extended by ICanBoogie\Operation
Extended by ICanBoogie\Modules\Thumbnailer\GetOperation

Direct known subclasses

Icybee\Modules\Images\ThumbnailOperation

Namespace: ICanBoogie\Modules\Thumbnailer
Located at vendor/icanboogie-modules/thumbnailer/lib/operations/get.php

Methods summary

protected ICanBoogie\Modules\Thumbnailer\Version
# resolve_version( ICanBoogie\HTTP\Request $request )

Tries to create a ICanBoogie\Modules\Thumbnailer\Version instance from the request.

Tries to create a ICanBoogie\Modules\Thumbnailer\Version instance from the request.

Parameters

$request
ICanBoogie\HTTP\Request
$request

Returns

ICanBoogie\Modules\Thumbnailer\Version
public
# get( )

Returns the location of the thumbnail on the server, relative to the document root.

Returns the location of the thumbnail on the server, relative to the document root.

The thumbnail is created using the parameters supplied, if it is not already available in the cache.

Throws

ICanBoogie\HTTP\HTTPError
public
# get_construct( ICanBoogie\FileCache $cache, string $destination, array $userdata )

Constructor for the cache entry.

Constructor for the cache entry.

Parameters

$cache
ICanBoogie\FileCache
$cache The cache object.
$destination
string
$destination The file to create.
$userdata
array
$userdata An array with the path of the original image and the options to use to create the thumbnail.

Throws

ICanBoogie\Exception
protected
# apply_filter( mixed $image, mixed $filter )
protected boolean
# validate( ICanBoogie\Errors $errors )

Validates the operation before processing.

Validates the operation before processing.

The method is abstract and therefore must be implemented by subclasses.

Returns

boolean
true if the operation is valid, false otherwise.

Throws

Exception
If something horribly wrong happens.
protected mixed
# process( )

Operation interface to the ICanBoogie\Modules\Thumbnailer\GetOperation::get() method.

Operation interface to the ICanBoogie\Modules\Thumbnailer\GetOperation::get() method.

The function uses the ICanBoogie\Modules\Thumbnailer\GetOperation::get() method to obtain the location of the image version. A HTTP redirection is made to the location of the image.

A HTTPException exception with code 404 is thrown if the function fails to obtain the location of the image version.

Returns

mixed
Depends on the implementation.

Throws

ICanBoogie\HTTP\HTTPError
public static
# fill_callback( mixed $image, mixed $w, mixed $h )

Methods inherited from ICanBoogie\Operation

__construct(), __invoke(), control(), control_authentication(), control_form(), control_method(), control_ownership(), control_permission(), control_record(), control_session_token(), encode(), format_class_name(), from(), from_module_request(), from_request(), from_route(), get_controls(), get_is_forwarded(), get_module(), get_request(), get_response(), lazy_get_form(), lazy_get_properties(), lazy_get_record(), reset()

Methods inherited from ICanBoogie\Object

resolve_facade_properties(), resolve_private_properties(), to_array(), to_json()

Methods inherited from ICanBoogie\ToArrayRecursive

to_array_recursive()

Methods used from ICanBoogie\ToArrayRecursiveTrait

to_array_recursive()

Methods used from ICanBoogie\PrototypeTrait

__call(), __get(), __set(), __sleep(), __wakeup(), get_prototype(), has_method(), has_property(), last_chance_get(), last_chance_set()

Magic methods summary

Constants summary

string VERSION '2.1'
#

Constants inherited from ICanBoogie\Operation

CONTROL_AUTHENTICATION, CONTROL_FORM, CONTROL_METHOD, CONTROL_OWNERSHIP, CONTROL_PERMISSION, CONTROL_RECORD, CONTROL_SESSION_TOKEN, DESTINATION, KEY, NAME, RESTFUL_BASE, RESTFUL_BASE_LENGTH, SESSION_TOKEN

Properties summary

public static mixed $background
#

Properties inherited from ICanBoogie\Operation

$destination, $form, $format, $key, $method, $module, $properties, $request, $response

Magic properties

public Modules\Thumbnailer $module
#
public string $repository
#

Path to the thumbnails repository.

Path to the thumbnails repository.

public ICanBoogie\FileCache $cache
#

Thumbnails cache manager.

Thumbnails cache manager.

Magic properties inherited from ICanBoogie\Operation

$is_forwarded, $record, $request

Magic properties inherited from ICanBoogie\Object

$prototype

Autodoc API documentation generated by ApiGen 2.8.0