$_topic
$_topic : \midcom_db_topic
The topic for which we are handling a request.
Blog Archive pages handler
Shows the various archive views.
$_topic : \midcom_db_topic
The topic for which we are handling a request.
$_master : \midcom_baseclasses_components_request
The request class that has invoked this handler instance.
$_node_toolbar : \midcom_helper_toolbar
The node toolbar for the current request context. Not available during the can_handle phase.
$_view_toolbar : \midcom_helper_toolbar
The view toolbar for the current request context. Not available during the can_handle phase.
get_url(\midcom_db_article $article, $allow_external = false)
| \midcom_db_article | $article | |
| $allow_external |
initialize(\midcom_baseclasses_components_request $master, \Symfony\Component\Routing\Router $router)
Initializes the request handler class, called by the component interface after instantiation.
Be aware that it is possible that a handler can come from a different component (or library) than the master class. Take this into account when getting the component data storage, configuration and l10n instances. Configuration is merged during runtime based on the system defaults and all parameters attached to the topic we're currently operating on.
| \midcom_baseclasses_components_request | $master | The request class |
| \Symfony\Component\Routing\Router | $router |
show(string $element) : \midcom_response_styled
Generates a response with a given style element
| string | $element |
bind_view_to_object(\midcom_core_dbaobject $object, string $page_class = 'default')
Binds the current page view to a particular object. This will automatically connect such things like metadata and toolbars to the correct object.
| \midcom_core_dbaobject | $object | The DBA class instance to bind to. |
| string | $page_class | String describing page type, will be used for substyling |
get_workflow(string $identifier, array $options = array()) : \midcom\workflow\dialog
| string | $identifier | |
| array | $options |
_handler_welcome(mixed $handler_id, array $args, array $data)
Shows the archive welcome page: A listing of years/months along with total post counts and similar stuff.
The handler computes all necessary data and populates the request array accordingly.
| mixed | $handler_id | The ID of the handler. |
| array | $args | The argument list. |
| array | $data |
_show_welcome(mixed $handler_id, array $data)
Displays the welcome page.
Element sequence:
Context data for all elements:
Context data for year elements:
month_data will contain an associative array containing the following array of data indexed by month number (1-12):
| mixed | $handler_id | The ID of the handler. |
| array | $data |
_handler_list(mixed $handler_id, array $args, array $data)
Shows the archive. Depending on the selected handler various constraints are added to the QB. See the add_*_constraint methods for details.
| mixed | $handler_id | The ID of the handler. |
| array | $args | The argument list. |
| array | $data |
_compute_welcome_first_post() : \DateTime
Loads the first posting time from the DB. This is the base for all operations on the resultset.
This is done under sudo if possible, to avoid problems arising if the first posting is hidden. This keeps up performance, as an execute_unchecked() can be made in this case. If sudo cannot be acquired, the system falls back to execute().
The time of the first posting or null on failure.
_compute_welcome_posting_count(\DateTime $start, \DateTime $end) : integer
Computes the number of postings in a given timeframe.
| \DateTime | $start | Start of the timeframe (inclusive) |
| \DateTime | $end | End of the timeframe (exclusive) |
Posting count
_set_startend_from_year(integer $year)
Computes the start/end dates to only query a given year. It will do validation before processing, throwing 404 in case of incorrectly formatted dates.
This is used by the archive-year handler, which expects the year to be in $args[0].
| integer | $year | The year to query. |
_set_startend_from_month(integer $year, integer $month)
Computes the start/end dates to only query a given month. It will do validation before processing, throwing 404 in case of incorrectly formatted dates.
This is used by the archive-month handler, which expects the year to be in $args[0] and the month to be in $args[1].
| integer | $year | The year to query. |
| integer | $month | The month to query. |