Semantic MediaWiki and related extensions
Static Public Member Functions | List of all members
ST\SemanticTasksMailer Class Reference

Static Public Member Functions

static mailAssigneesUpdatedTask (Assignees $assignees, WikiPage $article, User $current_user, $text, $summary, $minoredit, $watchthis, $sectionanchor, $flags, $revision)
 
static mailAssignees (WikiPage $article, Content $content, User $user, $status, Assignees $assignees, $revision)
 
static mailNotification (array $assignees, $text, Title $title, User $user, $status)
 
static setUserMailer (\ST\UserMailer $user_mailer)
 
static generateDiffBodyTxt (Title $title, IContextSource $context=null)
 
static remindAssignees ()
 
static printDebug ( $debugText, $debugArr=null)
 

Detailed Description

This class handles the creation and sending of notification emails.

Member Function Documentation

◆ generateDiffBodyTxt()

static ST\SemanticTasksMailer::generateDiffBodyTxt ( Title  $title,
IContextSource  $context = null 
)
static

Generates a diff txt

Code is similar to DifferenceEngine::generateTextDiffBody

Parameters
Title$title
IContextSource$context
Returns
string
Exceptions
ComplexityException
MWException

◆ mailAssignees()

static ST\SemanticTasksMailer::mailAssignees ( WikiPage  $article,
Content  $content,
User  $user,
  $status,
Assignees  $assignees,
  $revision 
)
static
Parameters
WikiPage$article
Content$content
User$user
integer$status
Assignees$assignees
Returns
boolean
Exceptions
ComplexityException
MWExceptionboolean $wgSemanticTasksNotifyIfUnassigned

◆ mailAssigneesUpdatedTask()

static ST\SemanticTasksMailer::mailAssigneesUpdatedTask ( Assignees  $assignees,
WikiPage  $article,
User  $current_user,
  $text,
  $summary,
  $minoredit,
  $watchthis,
  $sectionanchor,
  $flags,
  $revision 
)
static

Mails the assignees when the task is modified

Parameters
Assignees$assignees
WikiPage$article
User$current_user
Content$text
string$summaryUnused
bool$minoredit
null$watchthisUnused
null$sectionanchorUnused
$flags
Returns
boolean
Exceptions
ComplexityException
MWException

◆ mailNotification()

static ST\SemanticTasksMailer::mailNotification ( array  $assignees,
  $text,
Title  $title,
User  $user,
  $status 
)
static

Sends mail notifications

Parameters
array$assignees
string$text
Title$title
User$user
integer$status
Exceptions
MWException
ComplexityExceptionstring $wgSitename
Todo:
This should probably be refactored

◆ printDebug()

static ST\SemanticTasksMailer::printDebug (   $debugText,
  $debugArr = null 
)
static

Prints debugging information. $debugText is what you want to print, $debugVal is the level at which you want to print the information.

boolean $wgSemanticTasksDebug

Parameters
string$debugText
string$debugArrprivate

◆ remindAssignees()

static ST\SemanticTasksMailer::remindAssignees ( )
static

Run by the maintenance script to remind the assignees

Returns
boolean
Exceptions
Exceptionstring $wgSitename Language $wgLang

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

About | General disclaimer | Privacy policy