AutoPlacement
in package
implements
JsonSerializable
Auto-placement configuration for automatic component insertion.
The AutoPlacement object controls how advertisements and other components are automatically placed throughout the article.
Tags
Table of Contents
Interfaces
- JsonSerializable
Properties
- $advertisement : AdvertisementAutoPlacement|null
- Advertisement auto-placement configuration.
- $conditional : array<int, array<string, mixed>>|null
- Conditional auto-placement configurations.
Methods
- addConditional() : $this
- Add a conditional auto-placement.
- isEmpty() : bool
- Check if the auto-placement has any configuration.
- jsonSerialize() : array<string, mixed>
- {@inheritdoc}
- setAdvertisement() : $this
- Set the advertisement auto-placement.
- setConditional() : $this
- Set conditional auto-placements.
- withAdFrequency() : self
- Create an AutoPlacement with specific ad frequency.
- withAdsDisabled() : self
- Create an AutoPlacement with ads disabled.
Properties
$advertisement
Advertisement auto-placement configuration.
private
AdvertisementAutoPlacement|null
$advertisement
= null
$conditional
Conditional auto-placement configurations.
private
array<int, array<string, mixed>>|null
$conditional
= null
Methods
addConditional()
Add a conditional auto-placement.
public
addConditional(Condition $condition[, AdvertisementAutoPlacement|null $advertisement = null ]) : $this
Parameters
- $condition : Condition
-
The condition to match.
- $advertisement : AdvertisementAutoPlacement|null = null
-
Optional ad config for this condition.
Return values
$thisisEmpty()
Check if the auto-placement has any configuration.
public
isEmpty() : bool
Return values
bool —True if any configuration is set.
jsonSerialize()
{@inheritdoc}
public
jsonSerialize() : array<string, mixed>
Return values
array<string, mixed>setAdvertisement()
Set the advertisement auto-placement.
public
setAdvertisement(AdvertisementAutoPlacement $advertisement) : $this
Parameters
- $advertisement : AdvertisementAutoPlacement
-
The advertisement configuration.
Return values
$thissetConditional()
Set conditional auto-placements.
public
setConditional(array<int, array<string, mixed>> $conditional) : $this
Parameters
- $conditional : array<int, array<string, mixed>>
-
Array of conditional placements.
Return values
$thiswithAdFrequency()
Create an AutoPlacement with specific ad frequency.
public
static withAdFrequency(int $frequency) : self
Parameters
- $frequency : int
-
Number of components between ads.
Return values
self —A new AutoPlacement instance.
withAdsDisabled()
Create an AutoPlacement with ads disabled.
public
static withAdsDisabled() : self
Return values
self —A new AutoPlacement instance.