BEdita API doc | 4-cactus
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Download

Namespaces

  • BEdita
    • API
      • Auth
      • Controller
        • Admin
        • Component
        • Model
      • Error
      • Event
      • Exception
      • Middleware
      • Model
        • Action
      • Network
        • Exception
      • Shell
      • TestSuite
      • Utility
    • Core
      • Configure
        • Engine
      • Database
        • Type
      • Exception
      • Filesystem
        • Adapter
        • Exception
        • Thumbnail
      • I18n
      • Job
        • Service
      • Mailer
        • Preview
        • Transport
      • Model
        • Action
        • Behavior
        • Entity
        • Table
        • Validation
      • ORM
        • Inheritance
        • Locator
        • Rule
      • Shell
        • Task
      • State
      • TestSuite
        • Fixture
      • Utility

Classes

  • FilesystemAdapter
  • FilesystemRegistry
  • Thumbnail
  • ThumbnailGenerator
  • ThumbnailRegistry

Interfaces

  • GeneratorInterface

Class Thumbnail

High level interface for thumbnails.

BEdita\Core\Filesystem\Thumbnail uses Cake\Core\StaticConfigTrait (not available)
Namespace: BEdita\Core\Filesystem
Since: 4.0.0
Located at Core/src/Filesystem/Thumbnail.php

Methods summary

public static
# setRegistry( BEdita\Core\Filesystem\ThumbnailRegistry $registry = null )

Setter for thumbnails registry.

Setter for thumbnails registry.

Parameters

$registry
Thumbnail generator registry.
public static BEdita\Core\Filesystem\ThumbnailRegistry
# getRegistry( )

Getter for thumbnails registry.

Getter for thumbnails registry.

Returns

BEdita\Core\Filesystem\ThumbnailRegistry
public static BEdita\Core\Filesystem\GeneratorInterface
# getGenerator( string $name )

Get a generator by name.

Get a generator by name.

Parameters

$name
Name of generator to get.

Returns

BEdita\Core\Filesystem\GeneratorInterface
public static array
# get( BEdita\Core\Model\Entity\Stream $stream, string|array $options = 'default' )

Generate a thumbnail for a stream.

Generate a thumbnail for a stream.

Parameters

$stream
Stream to generate thumbnail for.
$options
Preset name, or array of thumbnail options.

Returns

array
Generated thumbnail URL and ready status.
protected static array
# getOptions( string|array $options )

Get options for thumbnail generation.

Get options for thumbnail generation.

Parameters

$options
Preset name, or array of options.

Returns

array
public static
# delete( BEdita\Core\Model\Entity\Stream $stream )

Delete all generated thumbnails for a stream.

Delete all generated thumbnails for a stream.

Parameters

$stream
Stream to delete thumbnails for.

Properties summary

protected static BEdita\Core\Filesystem\ThumbnailRegistry $_registry

Thumbnail registry.

Thumbnail registry.

#
protected static array $_dsnClassMap

An array mapping URL schemes to fully qualified Thumbnail generator class names.

An array mapping URL schemes to fully qualified Thumbnail generator class names.

# [ 'glide' => GlideGenerator::class, 'async' => AsyncGenerator::class, ]
BEdita API doc | 4-cactus API documentation generated by ApiGen