1:  2:  3:  4:  5:  6:  7:  8:  9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 

<?php

/**
 * MvcCore
 *
 * This source file is subject to the BSD 3 License
 * For the full copyright and license information, please view
 * the LICENSE.md file that are distributed with this source code.
 *
 * @copyright   Copyright (c) 2016 Tom Flidr (https://github.com/mvccore)
 * @license     https://mvccore.github.io/docs/mvccore/5.0.0/LICENCE.md
 */

namespace MvcCore\Ext\Auths\Basics\Form;

/**
 * Trait for class `\MvcCore\Ext\Auths\Basics\SignOutForm`. Trait contains:
 * - Protected property `$user` to display user full name in sign out form.
 * - `Init()` method to initialize all necessary sign in form fields.
 * - `Submit()` method to handle sign-in form submit request (`POST` by default).
 * - `Render()` method to render sign out form without template by default.
 */
trait SignOut {

    /**
     * Initialize sign out button and user into
     * template for any custom template rendering.
     * @param bool $submit
     * @return \MvcCore\Ext\Auths\Basics\SignOutForm
     */
    public function Init ($submit = FALSE) {
        /** @var $this \MvcCore\Ext\Auths\Basics\SignOutForm */
        parent::Init($submit);

        $this
            ->initAuthFormPropsAndHiddenControls()
            ->AddField(new \MvcCore\Ext\Forms\Fields\SubmitButton([
                'name'          => 'send',
                'value'         => 'Log Out',
                'cssClasses'    => ['button'],
            ]));

        $this->user = $this->auth->GetUser();

        return $this;
    }

    /**
     * Sign out submit - if everything is OK, unset user unique name from session
     * for next requests to have not authenticated user anymore.
     * @param array $rawRequestParams
     * @return array
     */
    public function Submit (array & $rawRequestParams = []) {
        /** @var $this \MvcCore\Ext\Auths\Basics\SignOutForm */
        parent::Submit($rawRequestParams);
        $data = & $this->values;
        if ($this->result === \MvcCore\Ext\Form::RESULT_SUCCESS) {
            $userClass = $this->auth->GetUserClass();
            $userClass::LogOut();
        }
        $this
            ->SetSuccessUrl(isset($data['successUrl']) ? $data['successUrl'] : '')
            ->SetErrorUrl(isset($data['errorUrl']) ? $data['errorUrl'] : '');
        return [$this->result, $this->values, $this->errors];
    }

    /**
     * Render form without custom template, without any errors, with
     * user full name, sign out button and all necessary hidden fields.
     * @return string
     */
    public function & Render ($controllerDashedName = NULL, $actionDashedName = NULL) {
        /** @var $this \MvcCore\Ext\Auths\Basics\SignOutForm */
        $this->PreDispatch();
        $result = $this->RenderBegin();
        if ($this->user)
            $result .= '<span>'.$this->user->GetFullName().'</span>';
        foreach ($this->fields as $field)
            $result .= $field->Render();
        $result .= $this->RenderEnd();
        return $result;
    }
}