Documentation

Display
in package
implements ActionInterface Uses BackwardCompatibility

This class loads the posts in a topic so they can be displayed.

It uses the main sub template of the Display template. It requires a topic, and can go to the previous or next topic from it. It jumps to the correct post depending on a number/time/msg passed. It depends on the messages_per_page, defaultMaxMessages and enableAllMessages settings. It is accessed by ?topic=id_topic.START.

Although this class is not accessed using an ?action=... URL query, it behaves like an action in every other way.

Table of Contents

Interfaces

ActionInterface
Interface for all action classes.

Properties

$can_show_all  : bool
$obj  : object
$backcompat  : array<string|int, mixed>
$firstIndex  : int
$messages  : array<string|int, mixed>
$posters  : array<string|int, mixed>
$virtual_msg  : int

Methods

call()  : void
Convenience method to load() and execute() an instance of this class.
execute()  : void
Does the heavy lifting to show the posts in this 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.
prepareDisplayContext()  : array<string|int, mixed>|bool
Callback for the message display.
__construct()  : mixed
Constructor. Protected to force instantiation via load().
buildButtons()  : void
Builds the user and moderator button arrays.
checkMovedMergedRedirect()  : void
Is this a moved or merged topic that we are redirecting to?
checkPrevNextRedirect()  : void
Redirect to the previous or next topic, if requested in the URL params.
getMessagesAndPosters()  : void
Populates $this->messages and $this->posters with IDs of each post and poster in this topic.
getNotificationMode()  : void
Get notification preferences and mode.
getWhoViewing()  : void
Let's get nosey, who is viewing this topic?
incrementNumViews()  : void
Add 1 to the number of views of this topic (except for robots).
initDisplayContext()  : void
Initializes Msg::get() and loads attachments and likes.
loadEditor()  : void
Loads the editor for the quick reply.
loadEvents()  : void
Loads info about any calendar events that are linked to this topic.
loadPoll()  : void
Loads the poll linked to this topic, if applicable.
markRead()  : void
preventPrefetch()  : void
Blocks browser attempts to prefetch the topic display.
setModerators()  : void
Prepares contextual info about the modertors of this board.
setOldTopicWarning()  : void
Warn the user against replying to old topics.
setPaginationAndLinks()  : void
Constructs page index, sets next/prev/up links, etc.
setRobotNoIndex()  : void
Tells search engines not to index pages they shouldn't.
setStart()  : void
If $_REQUEST['start'] is not a number, figures out the correct numerical value and sets $_REQUEST['start'] to that value.
setUnapprovedPostsMessage()  : void
Sets the unapproved posts message.
setupTemplate()  : void
Loads the template and sets some related contextual info.
setupVerification()  : void
Sets up anti-spam verification stuff, if needed.

Properties

$can_show_all

public bool $can_show_all = false

Whether all posts in the topic can be viewed on a single page.

$obj

protected static object $obj

An instance of this class.

$backcompat

private static array<string|int, mixed> $backcompat = ['func_names' => ['call' => 'Display']]

BackwardCompatibility settings for this class.

$firstIndex

private int $firstIndex

Index of the first message.

$messages

private array<string|int, mixed> $messages = []

ID numbers of messages in this topic.

$posters

private array<string|int, mixed> $posters = []

ID numbers of the authors of the $messages.

$virtual_msg

private int $virtual_msg

Requested message in $_REQUEST['start']. Might or might not be set.

Methods

call()

Convenience method to load() and execute() an instance of this class.

public static call() : void

execute()

Does the heavy lifting to show the posts in this topic.

public execute() : void
  • Sets up anti-spam verification and old topic warnings.
  • Gets the list of users viewing the topic.
  • Loads events and polls attached to the topic.
  • Loads IDs of the posts and posters.
  • Initializes the generator for displaying single posts.
  • Marks posts, topics, and boards as read (if they should be).
  • Loads the editor and builds the button arrays.

exportStatic()

Provides a way to export a class's public static properties and methods to global namespace.

public static exportStatic() : void

To do so:

  1. Use this trait in the class.
  2. 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.

prepareDisplayContext()

Callback for the message display.

public prepareDisplayContext() : array<string|int, mixed>|bool

This function internally relies on Msg::get(). Therefore, in order for this function to return any data, you must first initialize the Msg::$getter generator like this: Msg::$getter = Msg::get($message_ids);

Return values
array<string|int, mixed>|bool —

Contextual data for a post, or false on failure.

__construct()

Constructor. Protected to force instantiation via load().

protected __construct() : mixed
  • Handles any redirects we might need to do.
  • Loads topic info.
  • Loads permissions.
  • Prepares most of the stuff for the templates.

buildButtons()

Builds the user and moderator button arrays.

protected buildButtons() : void

checkMovedMergedRedirect()

Is this a moved or merged topic that we are redirecting to?

protected checkMovedMergedRedirect() : void

checkPrevNextRedirect()

Redirect to the previous or next topic, if requested in the URL params.

protected checkPrevNextRedirect() : void

getMessagesAndPosters()

Populates $this->messages and $this->posters with IDs of each post and poster in this topic.

protected getMessagesAndPosters() : void

getNotificationMode()

Get notification preferences and mode.

protected getNotificationMode() : void

getWhoViewing()

Let's get nosey, who is viewing this topic?

protected getWhoViewing() : void

incrementNumViews()

Add 1 to the number of views of this topic (except for robots).

protected incrementNumViews() : void

initDisplayContext()

Initializes Msg::get() and loads attachments and likes.

protected initDisplayContext() : void

loadEditor()

Loads the editor for the quick reply.

protected loadEditor() : void

loadEvents()

Loads info about any calendar events that are linked to this topic.

protected loadEvents() : void

loadPoll()

Loads the poll linked to this topic, if applicable.

protected loadPoll() : void

markRead()

protected markRead() : void

preventPrefetch()

Blocks browser attempts to prefetch the topic display.

protected preventPrefetch() : void

setModerators()

Prepares contextual info about the modertors of this board.

protected setModerators() : void

setOldTopicWarning()

Warn the user against replying to old topics.

protected setOldTopicWarning() : void

setPaginationAndLinks()

Constructs page index, sets next/prev/up links, etc.

protected setPaginationAndLinks() : void

setRobotNoIndex()

Tells search engines not to index pages they shouldn't.

protected setRobotNoIndex() : void

setStart()

If $_REQUEST['start'] is not a number, figures out the correct numerical value and sets $_REQUEST['start'] to that value.

protected setStart() : void

setUnapprovedPostsMessage()

Sets the unapproved posts message.

protected setUnapprovedPostsMessage() : void

setupTemplate()

Loads the template and sets some related contextual info.

protected setupTemplate() : void

setupVerification()

Sets up anti-spam verification stuff, if needed.

protected setupVerification() : void 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results