TopicRemove
in package
implements
ActionInterface
Uses
BackwardCompatibility
This action handles the deletion of topics.
Table of Contents
Interfaces
- ActionInterface
- Interface for all action classes.
Properties
- $obj : object
- $backcompat : array<string|int, mixed>
Methods
- call() : void
- Convenience method to load() and execute() an instance of this class.
- execute() : void
- Completely remove an entire topic.
- exportStatic() : void
- Provides a way to export a class's public static properties and methods to global namespace.
- load() : object
- Static wrapper for constructor.
- old() : mixed
- So long as you are sure... all old posts will be gone.
- removeDeleteConcurrence() : bool
- Try to determine if the topic has already been deleted by another user.
- __construct() : mixed
- Constructor. Protected to force instantiation via self::load().
Properties
$obj
protected
static object
$obj
An instance of this class. This is used by the load() method to prevent mulitple instantiations.
$backcompat
private
static array<string|int, mixed>
$backcompat
= ['func_names' => ['call' => 'RemoveTopic2', 'removeDeleteConcurrence' => 'removeDeleteConcurrence', 'old' => 'RemoveOldTopics2']]
BackwardCompatibility settings for this class.
Methods
call()
Convenience method to load() and execute() an instance of this class.
public
static call() : void
execute()
Completely remove an entire topic.
public
execute() : void
Redirects to the board when completed.
exportStatic()
Provides a way to export a class's public static properties and methods to global namespace.
public
static exportStatic() : void
To do so:
- Use this trait in the class.
- At the END of the class's file, call its exportStatic() method.
Although it might not seem that way at first glance, this approach conforms to section 2.3 of PSR 1, since executing this method is simply a dynamic means of declaring functions when the file is included; it has no other side effects.
Regarding the $backcompat items:
A class's static properties are not exported to global variables unless explicitly included in $backcompat['prop_names']. Likewise, a class's static methods are not exported as global functions unless explicitly included in $backcompat['func_names'].
$backcompat['prop_names'] is a simple array where the keys are the names of one or more of a class's static properties, and the values are the names of global variables. In each case, the global variable will be set to a reference to the static property. Static properties that are not named in this array will not be exported.
$backcompat['func_names'] is a simple array where the keys are the names of one or more of a class's static methods, and the values are the names that should be used for global functions that will encapsulate those methods. Methods that are not named in this array will not be exported.
Adding non-static properties or methods to the $backcompat arrays will produce runtime errors. It is the responsibility of the developer to make sure not to do this.
load()
Static wrapper for constructor.
public
static load() : object
Return values
object —An instance of this class.
old()
So long as you are sure... all old posts will be gone.
public
static old() : mixed
Used by SMF\Actions\Admin\Maintenance to prune old topics.
removeDeleteConcurrence()
Try to determine if the topic has already been deleted by another user.
public
static removeDeleteConcurrence() : bool
Return values
bool —False if it can't be deleted (recycling not enabled or no recycling board set), true if we've confirmed it can be deleted. Dies with an error if it's already been deleted.
__construct()
Constructor. Protected to force instantiation via self::load().
protected
__construct() : mixed