Comments component.
This is a component geared for communities offering a way to add comments on arbitrary pages. It is primarily geared for dl'ed usage. Its regular welcome URL method only shows the configuration interface, commenting the comments topic is prohibited as well.
The component stores the data in its own table, indexed by the object guid they are bound to. There is no threading support, comments are ordered by creation date.
Commenting is currently only allowed for registered users for security reasons. The user's name and E-Mail will be stored along with the created information in the Metadata in case that the user gets deleted.
Install instructions
Just create a topic with this component assigned to it. I recommend dropping it out of your navigation, as the component will by dynamically_loaded always, and the topic itself is only there for configuration purposes.
In your component (or style), add a DL line like this wherever you want the comment feature available:
midcom::get()->dynamic_load('/$path_to_comments_topic/comment/$guid');
$guid is the GUID of the object you're commenting.
$_nap_instance : \midcom_baseclasses_components_navigation
The NAP interface instance from the component, initialized on demand.
configure(mixed $configuration, integer $contextid)
Configures the component for usage. The configuration is merged, and, if necessary, an existing handler object is purged.
| mixed | $configuration | A configuration data list, suitable for merging with a midcom_helper_configuration object. |
| integer | $contextid | The ID of the context we are associated with. |
can_handle(\midcom_db_topic $current_object, \Symfony\Component\HttpFoundation\Request $request, integer $contextid) : boolean
Relays the can_handle call to the component, instantiating a new site class. It will execute can_handle of that class, returning its result to MidCOM.
| \midcom_db_topic | $current_object | The topic in question. |
| \Symfony\Component\HttpFoundation\Request | $request | |
| integer | $contextid | The id of the context we are operating in. |
True, if the component can handle the request, false otherwise.
handle() : \midcom_response|boolean
Relays the handle call to the component.
True, if the component successfully handle the request, false otherwise.
set_object(\midcom_db_topic $object) : boolean
Relays the set_object call to the nap instance. Checks if the NAP instance has already been created beforehand.
| \midcom_db_topic | $object | The midcom_db_topic that should be processed. |
Indicating success.
reindex(\midcom_db_topic $topic) : boolean
Initiate a reindex run for the given component and topic.
| \midcom_db_topic | $topic | The topic that should be reindexed. |
Indicating success.
get_config_for_topic(\midcom_db_topic $topic = null) : \midcom_helper_configuration
Get the full configuration set active for a given topic.
If no topic is passed, the system wide default configuration is returned.
Be aware, that this call does not check if the passed topic is actually handled by this component, as it is theoretically possible for components to drop configuration information on other topics as well.
| \midcom_db_topic | $topic | The topic which should be queried, omit to get the systemwide defaults. |
MidCOM configuration object
trigger_watch(integer $operation, \midcom_core_dbaobject $object)
Delegate all watched operations, in two phases. First, the general _on_watched_operation handler is called, to allow for handling generic operations. After that, the individual watches are called, to allow for more specific processing.
| integer | $operation | The operation that has occurred. |
| \midcom_core_dbaobject | $object | The object on which the operation occurred. The system will do is_a checks against any registered class restriction on the watch. |
_on_watched_operation(integer $operation, \midcom_core_dbaobject $object)
This function is triggered at the end of the request for each watched operation that has been done during the request.
It will be called once per operation and unique object, where object uniqueness is determined by the combination of object class and guid. The object has been refreshed before being passed to this event handler.
| integer | $operation | The operation identifier (one of the MIDCOM_OPERATION constants) which applies. |
| \midcom_core_dbaobject | $object | The object on which the operation has occurred. |
_on_watched_dba_create(\midcom_core_dbaobject $object)
This function is triggered at the end of the request for each watched create operation that has been done during the request.
It will be called once per operation and unique object, where object uniqueness is determined by the combination of object class and guid. The object has been refreshed before being passed to this event handler.
It is called after the generic _on_watched_operation event handler.
| \midcom_core_dbaobject | $object | The object on which the operation has occurred. |
_on_watched_dba_update(\midcom_core_dbaobject $object)
This function is triggered at the end of the request for each watched update operation that has been done during the request.
It will be called once per operation and unique object, where object uniqueness is determined by the combination of object class and guid. The object has been refreshed before being passed to this event handler.
It is called after the generic _on_watched_operation event handler.
| \midcom_core_dbaobject | $object | The object on which the operation has occurred. |
_on_watched_dba_delete(\midcom_core_dbaobject $object)
The delete handler will drop all entries associated with any deleted object so that our DB is clean.
Uses SUDO to ensure privileges.
| \midcom_core_dbaobject | $object | The object on which the operation has occurred. |
_on_watched_dba_import(object $object)
This function is triggered at the end of the request for each watched import operation that has been done during the request.
It is called after the generic _on_watched_operation event handler.
| object | $object | The object on which the operation has occurred. |
_on_reindex(\midcom_db_topic $topic, \midcom_helper_configuration $config, $indexer) : boolean
Reindex the given topic. The complete configuration set is already available in $config. The original index records are already deleted, so you do not need to bother about this.
The default event handler does nothing.
| \midcom_db_topic | $topic | The topic to reindex. |
| \midcom_helper_configuration | $config | The configuration associated with this topic. |
| $indexer |
Indicating success.
get_workflow(string $identifier, array $options = array()) : \midcom\workflow\dialog
| string | $identifier | |
| array | $options |