ILIAS
release_9 Revision v9.13-25-g2c18ec4c24f
◀ ilDoc Overview
PagesToExtract.php
Go to the documentation of this file.
1
<?php
18
declare(strict_types=1);
19
20
namespace
ILIAS\ResourceStorage\Flavour\Definition
;
21
22
use
ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\ExtractPages
;
23
28
class
PagesToExtract
implements
FlavourDefinition
29
{
30
public
const
FOREVER_ID
=
'cbcb933538e2dfe9460d7a225f7b543b556ee580f41bd4f06cf16a4ca8dd8c8c'
;
31
private
const
QUALITY
= 75;
32
private
int
$quality
;
33
protected
bool
$persist
;
34
protected
int
$max_size
= 500;
35
protected
int
$max_pages
= 5;
36
protected
bool
$fill
=
false
;
37
protected
bool
$use_max_quality
=
false
;
38
39
public
function
__construct
(
40
bool
$persist,
41
int
$max_size = 500,
42
int
$max_pages = 5,
43
bool
$fill =
false
,
44
int
$quality = self::QUALITY
45
) {
46
$this->
persist
=
$persist
;
47
$this->max_size =
$max_size
;
48
$this->max_pages =
$max_pages
;
49
$this->fill =
$fill
;
50
$this->quality =
$quality
;
51
}
52
53
public
function
getId
(): string
54
{
55
return
self::FOREVER_ID;
56
}
57
58
public
function
getFlavourMachineId
(): string
59
{
60
return
ExtractPages::ID
;
61
}
62
63
public
function
getMaxPages
():
int
64
{
65
return
$this->max_pages
;
66
}
67
68
public
function
getMaxSize
():
int
69
{
70
return
$this->max_size
;
71
}
72
73
public
function
isFill
(): bool
74
{
75
return
$this->fill
;
76
}
77
78
public
function
getQuality
():
int
79
{
80
return
$this->quality
;
81
}
82
83
public
function
useMaxQuality
(): bool
84
{
85
return
$this->use_max_quality
;
86
}
87
88
89
public
function
getInternalName
(): string
90
{
91
return
'extracted_pages'
;
92
}
93
94
public
function
getVariantName
(): ?string
95
{
96
return
$this->max_size .
'x'
. $this->max_size . ($this->fill ?
'_fill'
:
''
) .
'_'
. $this->
getQuality
();
97
}
98
99
public
function
persist
(): bool
100
{
101
return
$this->persist
;
102
}
103
}
ILIAS\ResourceStorage\Flavour\Definition\PagesToExtract\QUALITY
const QUALITY
Definition:
PagesToExtract.php:31
ILIAS\ResourceStorage\Flavour\Definition\PagesToExtract\$quality
int $quality
Definition:
PagesToExtract.php:32
ILIAS\ResourceStorage\Flavour\Definition\PagesToExtract\getInternalName
getInternalName()
This defines the speaky internal name of the definition, as the consumer would like to use it...
Definition:
PagesToExtract.php:89
ILIAS\ResourceStorage\Flavour\Definition\PagesToExtract\$persist
bool $persist
Definition:
PagesToExtract.php:33
ILIAS\ResourceStorage\Flavour\Definition\PagesToExtract\persist
persist()
Define whether the generated flavor and the respective streams should be persisted, or whether they should only be generated and used in-memory.
Definition:
PagesToExtract.php:99
ILIAS\ResourceStorage\Flavour\Definition\PagesToExtract\useMaxQuality
useMaxQuality()
Definition:
PagesToExtract.php:83
ILIAS\ResourceStorage\Flavour\Definition\PagesToExtract\FOREVER_ID
const FOREVER_ID
Definition:
PagesToExtract.php:30
ILIAS\ResourceStorage\Flavour\Definition\PagesToExtract\getMaxSize
getMaxSize()
Definition:
PagesToExtract.php:68
ILIAS\ResourceStorage\Flavour\Definition\PagesToExtract\getFlavourMachineId
getFlavourMachineId()
Defines the ID of the machine that supports this definition.
Definition:
PagesToExtract.php:58
ILIAS\ResourceStorage\Flavour\Definition\PagesToExtract\$max_pages
int $max_pages
Definition:
PagesToExtract.php:35
ILIAS\ResourceStorage\Flavour\Definition\PagesToExtract\$use_max_quality
bool $use_max_quality
Definition:
PagesToExtract.php:37
ILIAS\ResourceStorage\Flavour\Definition\PagesToExtract\$max_size
int $max_size
Definition:
PagesToExtract.php:34
ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\ExtractPages\ID
const ID
Definition:
ExtractPages.php:43
ILIAS\ResourceStorage\Flavour\Definition\PagesToExtract\getId
getId()
Definition:
PagesToExtract.php:53
ILIAS\ResourceStorage\Flavour\Definition\PagesToExtract\__construct
__construct(bool $persist, int $max_size=500, int $max_pages=5, bool $fill=false, int $quality=self::QUALITY)
Definition:
PagesToExtract.php:39
ILIAS\ResourceStorage\Flavour\Definition\PagesToExtract\getVariantName
getVariantName()
If a definition can be used in several variants (e.g.
Definition:
PagesToExtract.php:94
ILIAS\ResourceStorage\Flavour\Definition\PagesToExtract\getMaxPages
getMaxPages()
Definition:
PagesToExtract.php:63
ILIAS\ResourceStorage\Flavour\Definition
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
Definition:
CropToRectangle.php:21
ILIAS\ResourceStorage\Flavour\Definition\PagesToExtract\isFill
isFill()
Definition:
PagesToExtract.php:73
ILIAS\ResourceStorage\Flavour\Definition\PagesToExtract
Definition:
PagesToExtract.php:28
ILIAS\ResourceStorage\Flavour\Definition\PagesToExtract\$fill
bool $fill
Definition:
PagesToExtract.php:36
ExtractPages
ILIAS\ResourceStorage\Flavour\Definition\PagesToExtract\getQuality
getQuality()
Definition:
PagesToExtract.php:78
ILIAS\ResourceStorage\Flavour\Definition\FlavourDefinition
Definition:
FlavourDefinition.php:25
ILIAS\Repository\int
int(string $key)
Definition:
trait.BaseGUIRequest.php:61
src
ResourceStorage
Flavour
Definition
PagesToExtract.php
Generated on Wed Sep 10 2025 14:12:07 for ILIAS by
1.8.13 (using
Doxyfile
)