API Documentation » \SliderWriteService

category	System
package	Slider

SliderWriteService constructor.

__construct(\SliderRepositoryInterface $sliderRepository, \SlideRepositoryInterface $slideRepository, \SlideImageRepositoryInterface $slideImageRepository, \SlideImageAreaRepositoryInterface $slideImageAreaRepository, \SliderAssignmentRepositoryInterface $sliderAssignmentRepository, \SlideImageFileStorage $slideImageFileStorage)

Arguments

$sliderRepository

\SliderRepositoryInterface

$slideRepository

\SlideRepositoryInterface

$slideImageRepository

\SlideImageRepositoryInterface

$slideImageAreaRepository

\SlideImageAreaRepositoryInterface

$sliderAssignmentRepository

\SliderAssignmentRepositoryInterface

$slideImageFileStorage

\SlideImageFileStorage

Saves a Slide to the database and delegates to child-repositories.

addSlide(\IdType $sliderId, \SlideInterface $slide) : \SlideInterface

Arguments

$sliderId

\IdType

$slide

\SlideInterface

Response

\SlideInterface

The stored Slide instance.

Saves a SlideImage to the database.

addSlideImage(\IdType $slideId, \SlideImageInterface $slideImage) : \SlideImageInterface

Arguments

$slideId

\IdType

$slideImage

\SlideImageInterface

Response

\SlideImageInterface

The stored SlideImage instance.

Saves a SlideImageArea to the database.

addSlideImageArea(\IdType $slideImageId, \SlideImageAreaInterface $slideImageArea) : \SlideImageAreaInterface

Arguments

$slideImageId

\IdType

$slideImageArea

\SlideImageAreaInterface

Response

\SlideImageAreaInterface

The stored SlideImageArea instance.

Deletes a Slide by the given slide ID.

deleteSlideById(\IdType $slideId) : \SliderWriteServiceInterface

Arguments

$slideId

\IdType

Response

\SliderWriteServiceInterface

Same instance for method chaining.

Deletes a SlideImageArea by the given slide image area ID.

deleteSlideImageAreaById(\IdType $slideImageAreaId) : \SliderWriteServiceInterface

Arguments

$slideImageAreaId

\IdType

Response

\SliderWriteServiceInterface

Same instance for method chaining.

Deletes SlideImageAreas by the given slide image ID.

deleteSlideImageAreasBySlideImageId(\IdType $slideImageId) : \SliderWriteServiceInterface

Arguments

$slideImageId

\IdType

Response

\SliderWriteServiceInterface

Same instance for method chaining.

Deletes a SlideImage by the given slide image ID.

deleteSlideImageById(\IdType $slideImageId) : \SliderWriteServiceInterface

Arguments

$slideImageId

\IdType

Response

\SliderWriteServiceInterface

Same instance for method chaining.

Delete a slide image file.

deleteSlideImageFile(\FilenameStringType $filename) : \SliderWriteServiceInterface

Arguments

$filename

\FilenameStringType

The filename of the slide image to be removed.

Response

\SliderWriteServiceInterface

Same instance for method chaining.

Deletes a slider assignment by the given category ID.

deleteSliderAssignmentByCategoryId(\IdType $categoryId) : \SliderWriteServiceInterface

Arguments

$categoryId

\IdType

Response

\SliderWriteServiceInterface

Same instance for method chaining.

Deletes a slider assignment by the given content ID.

deleteSliderAssignmentByContentId(\IdType $contentId) : \SliderWriteServiceInterface

Arguments

$contentId

\IdType

Response

\SliderWriteServiceInterface

Same instance for method chaining.

Deletes a slider assignment by the given product ID.

deleteSliderAssignmentByProductId(\IdType $productId) : \SliderWriteServiceInterface

Arguments

$productId

\IdType

Response

\SliderWriteServiceInterface

Same instance for method chaining.

Deletes all slider assignments by the given slider ID.

deleteSliderAssignmentsBySliderId(\IdType $sliderId) : \SliderWriteServiceInterface

Arguments

$sliderId

\IdType

Response

\SliderWriteServiceInterface

Same instance for method chaining.

Deletes a Slider by the given slider ID.

deleteSliderById(\IdType $sliderId) : \SliderWriteServiceInterface

Arguments

$sliderId

\IdType

Response

\SliderWriteServiceInterface

Same instance for method chaining.

Delete a slide thumbnail image file.

deleteSlideThumbnailImageFile(\FilenameStringType $filename) : \SliderWriteServiceInterface

Arguments

$filename

\FilenameStringType

The filename of the slide image thumbnail to be removed.

Response

\SliderWriteServiceInterface

Same instance for method chaining.

Import slide image file.

importSlideImageFile(\ExistingFile $sourceFile, \FilenameStringType $preferredFilename) : string

Use this method for importing an uploaded file to the correct slides directory.

Throws	\InvalidArgumentException Through SlideImageFileStorage

Arguments

$sourceFile

\ExistingFile

The existing file to import.

$preferredFilename

\FilenameStringType

The preferred filename.

Response

string

New filename.

Import slide thumbnail image file.

importSlideThumbnailImageFile(\ExistingFile $sourceFile, \FilenameStringType $preferredFilename) : string

Use this method for importing an uploaded file to the correct thumbnails directory.

Throws	\InvalidArgumentException Through SlideImageFileStorage

Arguments

$sourceFile

\ExistingFile

The existing file to import.

$preferredFilename

\FilenameStringType

The preferred filename.

Response

string

New filename.

Rename a slide image file.

renameSlideImageFile(\FilenameStringType $oldName, \FilenameStringType $newName) : \SliderWriteServiceInterface

Throws	\InvalidArgumentException Through SlideImageFileStorage

Arguments

$oldName

\FilenameStringType

The old name of the slide image file.

$newName

\FilenameStringType

The new name of the slide image file.

Response

\SliderWriteServiceInterface

Same instance for method chaining.

Rename a slide thumbnail image file.

renameSlideThumbnailImageFile(\FilenameStringType $oldName, \FilenameStringType $newName) : \SliderWriteServiceInterface

Throws	\InvalidArgumentException Through SlideImageFileStorage

Arguments

$oldName

\FilenameStringType

The old name of the slide image thumbnail file.

$newName

\FilenameStringType

The new name of the slide image thumbnail file.

Response

\SliderWriteServiceInterface

Same instance for method chaining.

Saves a Slider to the database and delegates to child-repositories.

saveSlider(\SliderInterface $slider) : \SliderInterface

Arguments

$slider

\SliderInterface

Response

\SliderInterface

The stored Slider instance.

Inserts a slider assignment for the given category ID into the database.

saveSliderAssignmentForCategoryId(\IdType $sliderId, \IdType $categoryId) : \SliderWriteServiceInterface

Arguments

$sliderId

\IdType

$categoryId

\IdType

Response

\SliderWriteServiceInterface

Same instance for method chaining.

Inserts a slider assignment for the given content ID into the database.

saveSliderAssignmentForContentId(\IdType $sliderId, \IdType $contentId) : \SliderWriteServiceInterface

Arguments

$sliderId

\IdType

$contentId

\IdType

Response

\SliderWriteServiceInterface

Same instance for method chaining.

Inserts a slider assignment for the given product ID into the database.

saveSliderAssignmentForProductId(\IdType $sliderId, \IdType $productId) : \SliderWriteServiceInterface

Arguments

$sliderId

\IdType

$productId

\IdType

Response

\SliderWriteServiceInterface

Same instance for method chaining.

Set the Slider for the start page.

setStartPageSlider(\IdType $sliderId) : \SliderWriteServiceInterface

Arguments

$sliderId

\IdType

Response

\SliderWriteServiceInterface

Same instance for method chaining.

sliderRepository

sliderRepository : \SliderRepositoryInterface

var

Type(s)

\SliderRepositoryInterface

slideRepository

slideRepository : \SlideRepositoryInterface

var

Type(s)

\SlideRepositoryInterface

slideImageRepository

slideImageRepository : \SlideImageRepositoryInterface

var

Type(s)

\SlideImageRepositoryInterface

slideImageAreaRepository

slideImageAreaRepository : \SlideImageAreaRepositoryInterface

var

Type(s)

\SlideImageAreaRepositoryInterface

sliderAssignmentRepository

sliderAssignmentRepository : \SliderAssignmentRepositoryInterface

var

Type(s)

\SliderAssignmentRepositoryInterface

slideImageFileStorage

slideImageFileStorage : \SlideImageFileStorage

var

Type(s)

\SlideImageFileStorage

SliderWriteService

Methods

SliderWriteService constructor.

Arguments

$sliderRepository

$slideRepository

$slideImageRepository

$slideImageAreaRepository

$sliderAssignmentRepository

$slideImageFileStorage

Saves a Slide to the database and delegates to child-repositories.

Arguments

$sliderId

$slide

Response

Saves a SlideImage to the database.

Arguments

$slideId

$slideImage

Response

Saves a SlideImageArea to the database.

Arguments

$slideImageId

$slideImageArea

Response

Deletes a Slide by the given slide ID.

Arguments

$slideId

Response

Deletes a SlideImageArea by the given slide image area ID.

Arguments

$slideImageAreaId

Response

Deletes SlideImageAreas by the given slide image ID.

Arguments

$slideImageId

Response

Deletes a SlideImage by the given slide image ID.

Arguments

$slideImageId

Response

Delete a slide image file.

Arguments

$filename

Response

Deletes a slider assignment by the given category ID.

Arguments

$categoryId

Response

Deletes a slider assignment by the given content ID.

Arguments

$contentId

Response

Deletes a slider assignment by the given product ID.

Arguments

$productId

Response

Deletes all slider assignments by the given slider ID.

Arguments

$sliderId

Response

Deletes a Slider by the given slider ID.

Arguments

$sliderId

Response

Delete a slide thumbnail image file.

Arguments

$filename

Response

Import slide image file.

Arguments

$sourceFile

$preferredFilename

Response

Import slide thumbnail image file.

Arguments

$sourceFile

$preferredFilename

Response

Rename a slide image file.