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

  • AsyncGenerator

Class AsyncGenerator

Asynchronous thumbnail generator.

BEdita\Core\Filesystem\ThumbnailGenerator implements BEdita\Core\Filesystem\GeneratorInterface uses Cake\Core\InstanceConfigTrait (not available)
Extended by BEdita\Core\Filesystem\Thumbnail\AsyncGenerator
Namespace: BEdita\Core\Filesystem\Thumbnail
Since: 4.0.0
Located at Core/src/Filesystem/Thumbnail/AsyncGenerator.php

Methods summary

protected BEdita\Core\Filesystem\GeneratorInterface
# getBaseGenerator( )

Get generator used for actually creating the thumbnail.

Get generator used for actually creating the thumbnail.

Returns

BEdita\Core\Filesystem\GeneratorInterface
public string
# getUrl( BEdita\Core\Model\Entity\Stream $stream, array $options = [] )

Get URL for a generated thumbnail.

Get URL for a generated thumbnail.

Parameters

$stream
Stream entity instance.
$options
Thumbnail options.

Returns

string
public boolean
# generate( BEdita\Core\Model\Entity\Stream $stream, array $options = [] )

Generate a thumbnail for a Stream entity using the provided options, and return the URL.

Generate a thumbnail for a Stream entity using the provided options, and return the URL.

Parameters

$stream
Stream entity instance.
$options
Thumbnail options.

Returns

boolean
Is the thumbnail ready? Synchronous generators should return true, asynchronous generators should return false.
public boolean
# exists( BEdita\Core\Model\Entity\Stream $stream, array $options = [] )

Check if a thumbnail for a Stream entity using the provided options already exists.

Check if a thumbnail for a Stream entity using the provided options already exists.

Parameters

$stream
Stream entity instance.
$options
Thumbnail options.

Returns

boolean
Is the thumbnail ready?
public
# delete( BEdita\Core\Model\Entity\Stream $stream )

Delete all created thumbnails for a stream.

Delete all created thumbnails for a stream.

This method does nothing: any asynchronous job that might be still pending will be marked as complete as soon as it is attempted.

Parameters

$stream
Stream entity instance.

See

\BEdita\Core\Job\Service\ThumbnailService::run()

Codecoverageignore

Methods inherited from BEdita\Core\Filesystem\ThumbnailGenerator

initialize()

Properties summary

protected array $_defaultConfig

Default configuration for adapter.

Default configuration for adapter.

# [ 'baseGenerator' => 'default', 'service' => 'thumbnail', 'max_attempts' => 2, ]
BEdita API doc | 4-cactus API documentation generated by ApiGen