i-lateral / silverstripe-users

code/control/Users_Account_Controller.php

<?php

/**
 * Controller that is used to allow users to manage their accounts via
 * the front end of the site.
 * 
 * @package Users
 * @author  i-lateral <info@ilateral.co.uk>
 */
class Users_Account_Controller extends Controller implements PermissionProvider
{

    /**
     * URL That you can access this from
     *
     * @config
     */
    private static $url_segment = "users/account";

Consider using a different property name as you override a private property of the parent class.

    /**
     * Allowed sub-URL's on this controller
     * 
     * @var    array
     * @config
     */
    private static $allowed_actions = array(

Consider using a different property name as you override a private property of the parent class.

        "edit",
        "changepassword",
        "EditAccountForm",
        "ChangePasswordForm",
    );

    /**
     * User account associated with this controller
     *
     * @var Member
     */
    protected $member;

    /**
     * Getter for member
     *
     * @return Member
     */
    public function getMember()
    {
        return $this->member;
    }

    /**
     * Setter for member
     *
     * @param Member $member A member to associate
     * 
     * @return self
     */
    public function setMember(Member $member)
    {
        $this->member = $member;
        return $this;
    }

    /**
     * Determine if current user requires verification (based on their
     * account and Users verification setting).
     *
     * @return boolean
     */
    public function RequireVerification()
    {
        if (!$this->member->isVerified() && Users::config()->require_verification) {

The if-else statement can be simplified to return !$this->member->isVerified() && \Users::config()->require_verification;.

            return true;
        } else {
            return false;
        }
    }

    /**
     * Perorm setup when this controller is initialised
     *
     * @return void
     */
    public function init()
    {
        parent::init();

        // Check we are logged in as a user who can access front end management
        if (!Permission::check("USERS_MANAGE_ACCOUNT")) {
            Security::permissionFailure();
        }

        // Set our member object
        $member = Member::currentUser();

        if ($member instanceof Member) {
            $this->member = $member;
        }
    }

    /**
     * Get the link to this controller
     * 
     * @param string $action The URL endpoint for this controller

Should the type for parameter $action not be string|null?

     * 
     * @return string
     */
    public function Link($action = null)
    {
        return Controller::join_links(
            $this->config()->url_segment,
            $action
        );
    }

    /**
     * Get an absolute link to this controller
     *
     * @param string $action The URL endpoint for this controller

Should the type for parameter $action not be string|null?

     * 
     * @return string

Should the return type not be false|string?

     */
    public function AbsoluteLink($action = null)
    {
        return Director::absoluteURL($this->Link($action));
    }

    /**
     * Get a relative (to the root url of the site) link to this
     * controller
     *
     * @param string $action The URL endpoint for this controller 

Should the type for parameter $action not be string|null?

     * 
     * @return string
     */
    public function RelativeLink($action = null)
    {
        return Controller::join_links(
            $this->Link($action)
        );
    }

    /**
     * If content controller exists, return it's menu function
     *
     * @param int $level Menu level to return.
     * 
     * @return ArrayList
     */
    public function getMenu($level = 1)

This method seems to be duplicated in your project.

    {
        if (class_exists(ContentController::class)) {
            $controller = Injector::inst()->get(ContentController::class);
            return $controller->getMenu($level);
        }
    }

    /**
     * Shortcut for getMenu
     * 
     * @param int $level Menu level to return.
     * 
     * @return ArrayList
     */
    public function Menu($level)

The parameter $level is not used and could be removed.

    {
        return $this->getMenu();
    }

    /**
     * Display the currently outstanding orders for the current user
     * 
     * @return HTMLText
     */
    public function index()
    {
        // Setup default profile summary sections
        $sections = ArrayList::create();

        $sections->push(
            ArrayData::create(
                array(
                "Title" => "",
                "Content" => $this->renderWith(
                    "UsersProfileSummary",
                    array("CurrentUser" => Member::currentUser())
                )
                )
            )
        );

        // Allow users to add extra content sections to the
        // summary
        $this->extend("updateIndexSections", $sections);

        $this->customise(
            array(
            "Title" => _t('Users.ProfileSummary', 'Profile Summary'),
            "MetaTitle" => _t('Users.ProfileSummary', 'Profile Summary'),
            "Content" => $this->renderWith(
                "UsersAccountSections",
                array("Sections" => $sections)
            )
            )
        );

        $this->extend("onBeforeIndex");

        return $this->renderWith(
            array(
            "UserAccount",
            "Page"
            )
        );
    }

    public function edit()
    {
        $member = Member::currentUser();
        $form = $this->EditAccountForm();

        if ($member instanceof Member) {
            $form->loadDataFrom($member);
        }

        $this->customise(
            array(
            "Title" => _t("Users.EditAccountDetails", "Edit account details"),
            "MetaTitle" => _t("Users.EditAccountDetails", "Edit account details"),
            "Form"  => $form
            )
        );

        $this->extend("onBeforeEdit");

        return $this->renderWith(
            array(
            "UserAccount_edit",
            "UserAccount",
            "Page"
            )
        );
    }

    public function changepassword()
    {
        // Set the back URL for this form
        $back_url = Controller::join_links(
            $this->Link("changepassword"),
            "?s=1"
        );
        
        Session::set("BackURL", $back_url);
        
        $form = $this->ChangePasswordForm();
        
        // Is password changed, set a session message.
        $password_set = $this->request->getVar("s");
        if($password_set && $password_set == 1) {
            $form->sessionMessage(
                _t("Users.PasswordChangedSuccessfully", "Password Changed Successfully"),
                "good"
            );
        }

        $this->customise(
            array(
            "Title" => _t("Security.ChangeYourPassword", "Change your password"),
            "MetaTitle" => _t("Security.ChangeYourPassword", "Change your password"),
            "Form"  => $form
            )
        );

        $this->extend("onBeforeChangePassword");

        return $this->renderWith(
            array(
            "UserAccount_changepassword",
            "UserAccount",
            "Page"
            )
        );
    }

    /**
     * Factory for generating a profile form. The form can be expanded using an
     * extension class and calling the updateEditProfileForm method.
     *
     * @return Form
     */
    public function EditAccountForm()
    {
        $form = Users_EditAccountForm::create($this, "EditAccountForm");

        $this->extend("updateEditAccountForm", $form);

        return $form;
    }

    /**
     * Factory for generating a change password form. The form can be expanded
     * using an extension class and calling the updateChangePasswordForm method.
     *
     * @return Form
     */
    public function ChangePasswordForm()
    {
        $form = ChangePasswordForm::create($this, "ChangePasswordForm");

        $form
            ->Actions()
            ->find("name", "action_doChangePassword")
            ->addExtraClass("btn")
            ->addExtraClass("btn-green");

        $cancel_btn = LiteralField::create(
            "CancelLink",
            '<a href="' . $this->Link() . '" class="btn btn-red">'. _t("Users.CANCEL", "Cancel") .'</a>'
        );

        $form
            ->Actions()
            ->insertBefore($cancel_btn, "action_doChangePassword");

'action_doChangePassword' is of type string, but the function expects a object<FormField>.

        $this->extend("updateChangePasswordForm", $form);

        return $form;
    }

    /**
     * Return a list of nav items for managing a users profile. You can add new
     * items to this menu using the "updateAccountMenu" extension
     *
     * @return ArrayList
     */
    public function getAccountMenu()
    {
        $menu = ArrayList::create();
        
        $curr_action = $this->request->param("Action");

        $menu->add(
            ArrayData::create(
                array(
                "ID"    => 0,
                "Title" => _t('Users.PROFILESUMMARY', "Profile Summary"),
                "Link"  => $this->Link(),
                "LinkingMode" => (!$curr_action) ? "current" : "link"
                )
            )
        );

        $menu->add(
            ArrayData::create(
                array(
                "ID"    => 10,
                "Title" => _t('Users.EDITDETAILS', "Edit account details"),
                "Link"  => $this->Link("edit"),
                "LinkingMode" => ($curr_action == "edit") ? "current" : "link"
                )
            )
        );

        $menu->add(
            ArrayData::create(
                array(
                "ID"    => 30,
                "Title" => _t('Users.CHANGEPASSWORD', "Change password"),
                "Link"  => $this->Link("changepassword"),
                "LinkingMode" => ($curr_action == "changepassword") ? "current" : "link"
                )
            )
        );

        $this->extend("updateAccountMenu", $menu);

        return $menu->sort("ID", "ASC");
    }

    public function providePermissions()
    {
        return array(
            "USERS_MANAGE_ACCOUNT" => array(
                'name' => 'Manage user account',
                'help' => 'Allow user to manage their account details',
                'category' => 'Frontend Users',
                'sort' => 100
            ),
            "USERS_VERIFIED" => array(
                'name' => 'Verified user',
                'help' => 'Users have verified their account',
                'category' => 'Frontend Users',
                'sort' => 100
            ),
        );
    }
}