:py:mod:`oioioi.portals.actions`
================================

.. py:module:: oioioi.portals.actions


Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   oioioi.portals.actions._register_portal_action
   oioioi.portals.actions.register_portal_action
   oioioi.portals.actions.register_node_action
   oioioi.portals.actions.portal_url



Attributes
~~~~~~~~~~

.. autoapisummary::

   oioioi.portals.actions.portal_actions
   oioioi.portals.actions.node_actions
   oioioi.portals.actions.DEFAULT_ACTION_NAME
   oioioi.portals.actions.portal_admin_menu_registry


.. py:data:: portal_actions
   

   

.. py:data:: node_actions
   

   

.. py:data:: DEFAULT_ACTION_NAME
   :annotation: = show_node

   

.. py:data:: portal_admin_menu_registry
   

   

.. py:function:: _register_portal_action(actions, name, condition, menu_text, menu_url_generator, menu_order)


.. py:function:: register_portal_action(name, condition=None, menu_text=None, menu_order=sys.maxsize)

   Decorator for a view, which registers it as a portal action.

   A portal action is a view which operates on a portal. After
   registration, it is accessible at URL
   /users/username/portal/?action=``name``. You can specify a ``condition``
   under which the action can be accessed. The action can also be added to
   the portal admin menu. In order to do that, you have to specify
   ``menu_text``. If ``condition`` is specified, the action will not be
   visible in the admin buttons unless it is satisfied.

   For portal actions, the following ``request`` attributes are set:
   - ``portal`` - :class:`oioioi.portals.models.Portal` for which the
                  action is called, also set in the template context
   - ``action`` - action name

   :param name: action name, shown in the URL
   :param condition: decides if the action is accessible
   :type condition: :class:`oioioi.base.permissions.Condition`
   :param menu_text: text to display in the portal admin menu
   :param menu_order: value determining the order of items in the portal
                      admin menu


.. py:function:: register_node_action(name, condition=None, menu_text=None, menu_order=sys.maxsize)

   Decorator for a view, which registers it as a node action.

   A node action is a view which operates on a portal node. After
   registration, it is accessible at URL
   /users/username/portal/path/to/node?action=``name``.

   For node actions, the following ``request`` attributes are set:
   - ``portal`` - :class:`oioioi.portals.models.Portal` for which the
                  action is called, also set in the template context
   - ``current_node`` - :class:`oioioi.portals.models.Node` for which the
                        action is called, also set in the template context
   - ``action`` - action name

   Parameters are the same as for
   :func:`oioioi.portals.actions.register_portal_action`.


.. py:function:: portal_url(portal=None, node=None, path=None, action=DEFAULT_ACTION_NAME)

   Generates a portal action URL.

   This is an analog of :func:`django.urls.reverse` for portal
   actions. Three parameter sets are possible:
   - ``portal`` - generates URL to a portal action for ``portal`` or to
                  a node action for ``portal`` root
   - ``node`` - generates URL to a node action for ``node``
   - ``portal`` and ``path`` - generates URL to a node action for a node at
                               ``path`` in ``portal``
   Specifying the parameters as named arguments is advised in order to
   avoid confusion.

   Also available as a template tag.

   :param portal: portal for which URL is generated
   :type portal: :class:`oioioi.portals.models.Portal`
   :param node: portal node for which URL is generated
   :type node: :class:`oioioi.portals.models.Node`
   :param path: path to the node for which URL is generated
   :param action: name of the action to which URL is generated