ActionClearFolders Class Reference

Public Member Functions
	__construct ($args)

Detailed Description

Handles the action of clearing specific temporary folders within the application.

This class is responsible for clearing out temporary files and directories that are not essential for immediate functionality but may accumulate over time and use disk space. It targets temporary directories used by various components like Composer, OpenSSL, and others.

Definition at line 17 of file class.action.clearFolders.php.

Constructor & Destructor Documentation

__construct()

ActionClearFolders::__construct

(

$args

)

Constructor for the ActionClearFolders class.

Upon instantiation, it clears specified temporary folders in both the root and core temporary paths. It excludes certain files and folders from being deleted to prevent essential data loss.

Parameters

array

$args

Arguments that might be used for further extension of constructor functionality.

Clears specific temporary folders in the root temporary path.

Util\clearFolder is used to clear the contents of the root temporary path, excluding certain essential items such as 'cachegrind', 'composer', 'openssl', 'mailpit', 'xlight', 'npm-cache', 'pip', 'yarn', and '.gitignore'. This ensures that important data and configurations are not lost.

Parameters

string	$bearsamppRoot-,>getTmpPath()	The root temporary path to be cleared.
array	$exclusions	List of folders and files to be excluded from deletion.

Clears the core temporary path.

Util\clearFolder is used to clear the contents of the core temporary path, excluding the '.gitignore' file. This ensures that the core temporary path is cleaned without removing the '.gitignore' file which might be necessary for version control.

Parameters

string	$bearsamppCore-,>getTmpPath()	The core temporary path to be cleared.
array	$exclusions	List of folders and files to be excluded from deletion.

Definition at line 27 of file class.action.clearFolders.php.

    {
        global $bearsamppRoot, $bearsamppCore;
 
        /**
         * Clears specific temporary folders in the root temporary path.
         *
         * Util::clearFolder is used to clear the contents of the root temporary path, excluding
         * certain essential items such as 'cachegrind', 'composer', 'openssl', 'mailpit', 'xlight', 'npm-cache',
         * 'pip', 'yarn', and '.gitignore'. This ensures that important data and configurations are not lost.
         *
         * @param string $bearsamppRoot->getTmpPath() The root temporary path to be cleared.
         * @param array $exclusions List of folders and files to be excluded from deletion.
         */
        Util::clearFolder($bearsamppRoot->getTmpPath(), array('cachegrind', 'composer', 'openssl', 'mailhog', 'mailpit', 'xlight', 'npm-cache', 'pip', 'yarn', '.gitignore'));
 
        // Clear logs
        Util::clearFolder($bearsamppRoot->getLogsPath(), array('mailpit.err.log', 'mailpit.out.log', 'memcached.err.log', 'memcached.out.log', 'xlight.err.log', 'xlight.log', '.gitignore') );
 
        /**
         * Clears the core temporary path.
         *
         * Util::clearFolder is used to clear the contents of the core temporary path, excluding
         * the '.gitignore' file. This ensures that the core temporary path is cleaned without
         * removing the '.gitignore' file which might be necessary for version control.
         *
         * @param string $bearsamppCore->getTmpPath() The core temporary path to be cleared.
         * @param array $exclusions List of folders and files to be excluded from deletion.
         */
        Util::clearFolder($bearsamppCore->getTmpPath(), array('.gitignore'));
    }

References $bearsamppCore, $bearsamppRoot, and Util\clearFolder().

---

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

• E:/Bearsampp-development/sandbox/core/classes/actions/class.action.clearFolders.php