Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions | Protected Member Functions | Protected Attributes
DeleteExpiredImages Class Reference

Public Member Functions

 __construct (\Magento\Captcha\Helper\Data $helper, \Magento\Captcha\Helper\Adminhtml\Data $adminHelper, \Magento\Framework\Filesystem $filesystem, \Magento\Store\Model\StoreManager $storeManager)
 
 execute ()
 

Protected Member Functions

 _deleteExpiredImagesForWebsite (\Magento\Captcha\Helper\Data $helper, \Magento\Store\Model\Website $website=null, \Magento\Store\Model\Store $store=null)
 

Protected Attributes

 $_helper
 
 $_adminHelper
 
 $_mediaDirectory
 
 $_storeManager
 

Detailed Description

Captcha cron actions

Definition at line 13 of file DeleteExpiredImages.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( \Magento\Captcha\Helper\Data  $helper,
\Magento\Captcha\Helper\Adminhtml\Data  $adminHelper,
\Magento\Framework\Filesystem  $filesystem,
\Magento\Store\Model\StoreManager  $storeManager 
)
Parameters
\Magento\Captcha\Helper\Data$helper
\Magento\Captcha\Helper\Adminhtml\Data$adminHelper
\Magento\Framework\Filesystem$filesystem
\Magento\Store\Model\StoreManager$storeManager

Definition at line 43 of file DeleteExpiredImages.php.

48  {
49  $this->_helper = $helper;
50  $this->_adminHelper = $adminHelper;
51  $this->_mediaDirectory = $filesystem->getDirectoryWrite(DirectoryList::MEDIA);
52  $this->_storeManager = $storeManager;
53  }
$helper
Definition: iframe.phtml:13
$storeManager
$filesystem

Member Function Documentation

◆ _deleteExpiredImagesForWebsite()

_deleteExpiredImagesForWebsite ( \Magento\Captcha\Helper\Data  $helper,
\Magento\Store\Model\Website  $website = null,
\Magento\Store\Model\Store  $store = null 
)
protected

Delete Expired Captcha Images for specific website

Parameters
\Magento\Captcha\Helper\Data$helper
\Magento\Store\Model\Website | null$website
\Magento\Store\Model\Store | null$store
Returns
void

Definition at line 78 of file DeleteExpiredImages.php.

82  {
83  $expire = time() - $helper->getConfig('timeout', $store) * 60;
84  $imageDirectory = $this->_mediaDirectory->getRelativePath($helper->getImgDir($website));
85  foreach ($this->_mediaDirectory->read($imageDirectory) as $filePath) {
86  if ($this->_mediaDirectory->isFile($filePath)
87  && pathinfo($filePath, PATHINFO_EXTENSION) == 'png'
88  && $this->_mediaDirectory->stat($filePath)['mtime'] < $expire
89  ) {
90  $this->_mediaDirectory->delete($filePath);
91  }
92  }
93  }
$helper
Definition: iframe.phtml:13

◆ execute()

execute ( )

Delete Expired Captcha Images

Returns
\Magento\Captcha\Cron\DeleteExpiredImages

Definition at line 60 of file DeleteExpiredImages.php.

61  {
62  foreach ($this->_storeManager->getWebsites() as $website) {
63  $this->_deleteExpiredImagesForWebsite($this->_helper, $website, $website->getDefaultStore());
64  }
65  $this->_deleteExpiredImagesForWebsite($this->_adminHelper);
66 
67  return $this;
68  }
_deleteExpiredImagesForWebsite(\Magento\Captcha\Helper\Data $helper, \Magento\Store\Model\Website $website=null, \Magento\Store\Model\Store $store=null)

Field Documentation

◆ $_adminHelper

$_adminHelper
protected

Definition at line 25 of file DeleteExpiredImages.php.

◆ $_helper

$_helper
protected

Definition at line 18 of file DeleteExpiredImages.php.

◆ $_mediaDirectory

$_mediaDirectory
protected

Definition at line 30 of file DeleteExpiredImages.php.

◆ $_storeManager

$_storeManager
protected

Definition at line 35 of file DeleteExpiredImages.php.


The documentation for this class was generated from the following file: