Overview
  • Package
  • Class
  • Tree
  • Todo

Packages

  • AddonValue
    • Interfaces
  • AdminHttpViewControllers
  • ApiV2Controllers
  • Authentication
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Strategies
  • Category
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • Customer
    • Address
    • Country
    • CountryZone
    • Interfaces
    • Storages
    • Validation
    • ValueObjects
  • Email
    • Collections
    • Entities
    • Exceptions
    • Interfaces
    • Repository
    • ValueObjects
  • Extensions
    • Customers
    • Emails
    • Helpers
    • Invoices
    • Orders
    • Serializers
    • Templates
  • Http
    • Collections
    • Exceptions
    • Factories
    • Interfaces
    • ValueObjects
  • HttpViewControllers
  • InfoBox
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
  • Invoice
    • Interfaces
    • ValueObjects
  • Loaders
    • CrossCuttingLoader
    • GXCoreLoader
    • Interfaces
  • Modules
    • Collections
    • Controllers
    • Interfaces
  • None
  • Order
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
    • ValueObjects
  • Precheck
  • Product
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • ProductModule
    • Collections
    • Deleter
    • Entities
    • Factories
    • Interface
    • Interfaces
    • Reader
    • Repositories
    • Writer
  • Shared
    • ClassFinder
    • Exceptions
    • FileSystem
    • Interfaces
    • Storage
    • Types
  • SharedShoppingCart
    • Interfaces
  • Slider
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
  • Statistics
    • Interfaces
  • UserConfiguration
    • Interfaces
    • Repository

Classes

  • SliderReadService
  • SliderWriteService

Class SliderWriteService

Class SliderWriteService

SliderWriteService implements SliderWriteServiceInterface
Package: Slider
Category: System
Located at Services/Core/Slider/SliderWriteService.inc.php

Methods summary

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

SliderWriteService constructor.

SliderWriteService constructor.

Parameters

$sliderRepository
$slideRepository
$slideImageRepository
$slideImageAreaRepository
$sliderAssignmentRepository
$slideImageFileStorage
public SliderInterface
# saveSlider( SliderInterface $slider )

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

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

Parameters

$slider

Returns

SliderInterface
The stored Slider instance.

Implementation of

SliderWriteServiceInterface::saveSlider()
public SliderWriteServiceInterface
# setStartPageSlider( IdType $sliderId )

Set the Slider for the start page.

Set the Slider for the start page.

Parameters

$sliderId

Returns

SliderWriteServiceInterface
Same instance for method chaining.

Implementation of

SliderWriteServiceInterface::setStartPageSlider()
public SlideInterface
# addSlide( IdType $sliderId, SlideInterface $slide )

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

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

Parameters

$sliderId
$slide

Returns

SlideInterface
The stored Slide instance.

Implementation of

SliderWriteServiceInterface::addSlide()
public SlideImageInterface
# addSlideImage( IdType $slideId, SlideImageInterface $slideImage )

Saves a SlideImage to the database.

Saves a SlideImage to the database.

Parameters

$slideId
$slideImage

Returns

SlideImageInterface
The stored SlideImage instance.

Implementation of

SliderWriteServiceInterface::addSlideImage()
public SlideImageAreaInterface
# addSlideImageArea( IdType $slideImageId, SlideImageAreaInterface $slideImageArea )

Saves a SlideImageArea to the database.

Saves a SlideImageArea to the database.

Parameters

$slideImageId
$slideImageArea

Returns

SlideImageAreaInterface
The stored SlideImageArea instance.

Implementation of

SliderWriteServiceInterface::addSlideImageArea()
public SliderWriteServiceInterface
# deleteSliderById( IdType $sliderId )

Deletes a Slider by the given slider ID.

Deletes a Slider by the given slider ID.

Parameters

$sliderId

Returns

SliderWriteServiceInterface
Same instance for method chaining.

Implementation of

SliderWriteServiceInterface::deleteSliderById()
public SliderWriteServiceInterface
# deleteSlideById( IdType $slideId )

Deletes a Slide by the given slide ID.

Deletes a Slide by the given slide ID.

Parameters

$slideId

Returns

SliderWriteServiceInterface
Same instance for method chaining.

Implementation of

SliderWriteServiceInterface::deleteSlideById()
public SliderWriteServiceInterface
# deleteSlideImageById( IdType $slideImageId )

Deletes a SlideImage by the given slide image ID.

Deletes a SlideImage by the given slide image ID.

Parameters

$slideImageId

Returns

SliderWriteServiceInterface
Same instance for method chaining.

Implementation of

SliderWriteServiceInterface::deleteSlideImageById()
public SliderWriteServiceInterface
# deleteSlideImageAreaById( IdType $slideImageAreaId )

Deletes a SlideImageArea by the given slide image area ID.

Deletes a SlideImageArea by the given slide image area ID.

Parameters

$slideImageAreaId

Returns

SliderWriteServiceInterface
Same instance for method chaining.

Implementation of

SliderWriteServiceInterface::deleteSlideImageAreaById()
public SliderWriteServiceInterface
# deleteSlideImageAreasBySlideImageId( IdType $slideImageId )

Deletes SlideImageAreas by the given slide image ID.

Deletes SlideImageAreas by the given slide image ID.

Parameters

$slideImageId

Returns

SliderWriteServiceInterface
Same instance for method chaining.

Implementation of

SliderWriteServiceInterface::deleteSlideImageAreasBySlideImageId()
public string
# importSlideImageFile( ExistingFile $sourceFile, FilenameStringType $preferredFilename )

Import slide image file.

Import slide image file.

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

Parameters

$sourceFile
The existing file to import.
$preferredFilename
The preferred filename.

Returns

string
New filename.

Throws

InvalidArgumentException
Through SlideImageFileStorage

Implementation of

SliderWriteServiceInterface::importSlideImageFile()
public string
# importSlideThumbnailImageFile( ExistingFile $sourceFile, FilenameStringType $preferredFilename )

Import slide thumbnail image file.

Import slide thumbnail image file.

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

Parameters

$sourceFile
The existing file to import.
$preferredFilename
The preferred filename.

Returns

string
New filename.

Throws

InvalidArgumentException
Through SlideImageFileStorage

Implementation of

SliderWriteServiceInterface::importSlideThumbnailImageFile()
public SliderWriteServiceInterface
# renameSlideImageFile( FilenameStringType $oldName, FilenameStringType $newName )

Rename a slide image file.

Rename a slide image file.

Parameters

$oldName
The old name of the slide image file.
$newName
The new name of the slide image file.

Returns

SliderWriteServiceInterface
Same instance for method chaining.

Throws

InvalidArgumentException
Through SlideImageFileStorage

Implementation of

SliderWriteServiceInterface::renameSlideImageFile()
public SliderWriteServiceInterface
# renameSlideThumbnailImageFile( FilenameStringType $oldName, FilenameStringType $newName )

Rename a slide thumbnail image file.

Rename a slide thumbnail image file.

Parameters

$oldName
The old name of the slide image thumbnail file.
$newName
The new name of the slide image thumbnail file.

Returns

SliderWriteServiceInterface
Same instance for method chaining.

Throws

InvalidArgumentException
Through SlideImageFileStorage

Implementation of

SliderWriteServiceInterface::renameSlideThumbnailImageFile()
public SliderWriteServiceInterface
# deleteSlideImageFile( FilenameStringType $filename )

Delete a slide image file.

Delete a slide image file.

Parameters

$filename
The filename of the slide image to be removed.

Returns

SliderWriteServiceInterface
Same instance for method chaining.

Implementation of

SliderWriteServiceInterface::deleteSlideImageFile()
public SliderWriteServiceInterface
# deleteSlideThumbnailImageFile( FilenameStringType $filename )

Delete a slide thumbnail image file.

Delete a slide thumbnail image file.

Parameters

$filename
The filename of the slide image thumbnail to be removed.

Returns

SliderWriteServiceInterface
Same instance for method chaining.

Implementation of

SliderWriteServiceInterface::deleteSlideThumbnailImageFile()
public SliderWriteServiceInterface
# deleteSliderAssignmentsBySliderId( IdType $sliderId )

Deletes all slider assignments by the given slider ID.

Deletes all slider assignments by the given slider ID.

Parameters

$sliderId

Returns

SliderWriteServiceInterface
Same instance for method chaining.

Implementation of

SliderWriteServiceInterface::deleteSliderAssignmentsBySliderId()
public SliderWriteServiceInterface
# deleteSliderAssignmentByCategoryId( IdType $categoryId )

Deletes a slider assignment by the given category ID.

Deletes a slider assignment by the given category ID.

Parameters

$categoryId

Returns

SliderWriteServiceInterface
Same instance for method chaining.

Implementation of

SliderWriteServiceInterface::deleteSliderAssignmentByCategoryId()
public SliderWriteServiceInterface
# deleteSliderAssignmentByContentId( IdType $contentId )

Deletes a slider assignment by the given content ID.

Deletes a slider assignment by the given content ID.

Parameters

$contentId

Returns

SliderWriteServiceInterface
Same instance for method chaining.

Implementation of

SliderWriteServiceInterface::deleteSliderAssignmentByContentId()
public SliderWriteServiceInterface
# deleteSliderAssignmentByProductId( IdType $productId )

Deletes a slider assignment by the given product ID.

Deletes a slider assignment by the given product ID.

Parameters

$productId

Returns

SliderWriteServiceInterface
Same instance for method chaining.

Implementation of

SliderWriteServiceInterface::deleteSliderAssignmentByProductId()
public SliderWriteServiceInterface
# saveSliderAssignmentForCategoryId( IdType $sliderId, IdType $categoryId )

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

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

Parameters

$sliderId
$categoryId

Returns

SliderWriteServiceInterface
Same instance for method chaining.

Implementation of

SliderWriteServiceInterface::saveSliderAssignmentForCategoryId()
public SliderWriteServiceInterface
# saveSliderAssignmentForContentId( IdType $sliderId, IdType $contentId )

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

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

Parameters

$sliderId
$contentId

Returns

SliderWriteServiceInterface
Same instance for method chaining.

Implementation of

SliderWriteServiceInterface::saveSliderAssignmentForContentId()
public SliderWriteServiceInterface
# saveSliderAssignmentForProductId( IdType $sliderId, IdType $productId )

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

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

Parameters

$sliderId
$productId

Returns

SliderWriteServiceInterface
Same instance for method chaining.

Implementation of

SliderWriteServiceInterface::saveSliderAssignmentForProductId()

Properties summary

protected SliderRepositoryInterface $sliderRepository
#
protected SlideRepositoryInterface $slideRepository
#
protected SlideImageRepositoryInterface $slideImageRepository
#
protected SlideImageAreaRepositoryInterface $slideImageAreaRepository
#
protected SliderAssignmentRepositoryInterface $sliderAssignmentRepository
#
protected SlideImageFileStorage $slideImageFileStorage
#
API documentation generated by ApiGen