ConfirmUserDataRenderDecorator Class Reference
[Controller]

A render decorator that forces users to confirm or update their account data. More...

Inheritance diagram for ConfirmUserDataRenderDecorator:

List of all members.

Public Member Functions
	initialize ($page_data)
	Initialize this decorator and the data passed.
Static Public Member Functions
static	add_allowed_route_ids ($route_ids)
	Add allowed route ids.
static	get_allowed_route_ids ()
	Return the allowed route ids.
Protected Member Functions
	confirm_data_if_required ($user, PageData $page_data)
	Check if data must be confirmed, if so do it.
	is_allowed_route ($route_id)
	Returns true, if the current route is allowed.

---

Detailed Description

A render decorator that forces users to confirm or update their account data.

This render decorator

• checks if a user is logged in

• for logged in users checks if the email address is CONFIRMED and the TOS the user acknowledged are the same then the current valid TOS

• If this fails redirects to action "users_confirmdata"

• Except if the current route is one of the allowed ones, that can be set through ConfirmUserDataRenderDecorator::append_allowed_route_id()

Author:

Gerd Riesselmann

Definition at line 20 of file confirmuserdatarenderdecorator.cls.php.

---

Member Function Documentation

static ConfirmUserDataRenderDecorator::add_allowed_route_ids

(

$

route_ids

)

[static]

Add allowed route ids.

Parameters:

array|string

$route_ids

Definition at line 89 of file confirmuserdatarenderdecorator.cls.php.

                                                                 {
                self::$allowed_route_ids = array_merge(self::$allowed_route_ids, Arr::force($route_ids, false));
        }

ConfirmUserDataRenderDecorator::confirm_data_if_required	(	$	user,
		PageData $	page_data
	)			[protected]

Check if data must be confirmed, if so do it.

Parameters:

DAOUsers

$user

Definition at line 43 of file confirmuserdatarenderdecorator.cls.php.

                                                                                {
                if ($user->confirmed_email() == false || $user->confirmed_tos() == false) {
                        if (!$this->is_allowed_route($page_data->router->get_route_id())) {
                                if ($page_data->status) {
                                        $page_data->status->persist();
                                }
                                if (Session::pull('user_confirm_mail_send')) {
                                        Url::create(ActionMapper::get_url('users_confirm_mail'))->redirect(Url::TEMPORARY);
                                }
                                else {
                                        Url::create(ActionMapper::get_url('users_confirm'))->redirect(Url::TEMPORARY);
                                }
                                exit;
                        }
                }
        }

static ConfirmUserDataRenderDecorator::get_allowed_route_ids

(

)

[static]

Return the allowed route ids.

Returns:

array

Definition at line 80 of file confirmuserdatarenderdecorator.cls.php.

                                                       {
                return self::$allowed_route_ids;
        }

ConfirmUserDataRenderDecorator::initialize

(

$

page_data

)

Initialize this decorator and the data passed.

Parameters:

PageData

$page_data

Returns:

void

Reimplemented from RenderDecoratorBase.

Definition at line 29 of file confirmuserdatarenderdecorator.cls.php.

                                               {
                $user = Users::get_current_user();
                if ($user) {
                        $this->confirm_data_if_required($user, $page_data);
                }
                
                parent::initialize($page_data);
        }       

ConfirmUserDataRenderDecorator::is_allowed_route

(

$

route_id

)

[protected]

Returns true, if the current route is allowed.

Parameters:

string

$route_id

Returns:

bool

Definition at line 66 of file confirmuserdatarenderdecorator.cls.php.

                                                       {
                $allowed = self::get_allowed_route_ids();
                $allowed[] = 'UsersController::users_confirm';
                $allowed[] = 'UsersController::users_confirm_mail';
                $allowed[] = 'UsersController::logout';
                $allowed[] = 'ConfirmationsController::confirm';
                return in_array($route_id, $allowed);
        }

---

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

• contributions/usermanagement/controller/base/renderdecorators/confirmuserdatarenderdecorator.cls.php