From 1c4258ab0c5dcdc72855465d3464a2a61a0fe22e Mon Sep 17 00:00:00 2001 From: helpfulrobot Date: Fri, 1 Jan 2016 05:16:45 +1300 Subject: [PATCH] Converted to PSR-2 --- code/Users.php | 22 +++--- code/control/Users_Account_Controller.php | 60 ++++++++++------- code/control/Users_Register_Controller.php | 78 +++++++++++++--------- code/extensions/Ext_Users_Controller.php | 7 +- code/extensions/Ext_Users_Group.php | 15 +++-- code/extensions/Ext_Users_Member.php | 9 ++- code/forms/Users_EditAccountForm.php | 23 ++++--- 7 files changed, 128 insertions(+), 86 deletions(-) diff --git a/code/Users.php b/code/Users.php index 953f8a2..5f7091a 100644 --- a/code/Users.php +++ b/code/Users.php @@ -8,7 +8,8 @@ * @author i-lateral (http://www.i-lateral.com) * @package users */ -class Users extends Object { +class Users extends Object +{ /** * Stipulate if a user requires verification. NOTE this does not @@ -63,7 +64,8 @@ class Users extends Object { * * @param string Group code that will be used */ - public static function addNewUserGroup($code) { + public static function addNewUserGroup($code) + { self::$new_user_groups[] = $code; } @@ -73,9 +75,11 @@ public static function addNewUserGroup($code) { * * @param string Group code that will be used */ - public static function removeNewUserGroup($code) { - if(isset(self::$new_user_groups[$code])) + public static function removeNewUserGroup($code) + { + if (isset(self::$new_user_groups[$code])) { unset(self::$new_user_groups[$code]); + } } /** @@ -95,7 +99,8 @@ public static function removeNewUserGroup($code) { * * @param string Group code that will be used */ - public static function addVerificationGroup($code) { + public static function addVerificationGroup($code) + { self::$verification_groups[] = $code; } @@ -105,9 +110,10 @@ public static function addVerificationGroup($code) { * * @param string Group code that will be used */ - public static function removeVerificationGroup($code) { - if(isset(self::$verification_groups[$code])) + public static function removeVerificationGroup($code) + { + if (isset(self::$verification_groups[$code])) { unset(self::$verification_groups[$code]); + } } - } diff --git a/code/control/Users_Account_Controller.php b/code/control/Users_Account_Controller.php index 5ba3ea3..aa61fb4 100755 --- a/code/control/Users_Account_Controller.php +++ b/code/control/Users_Account_Controller.php @@ -5,7 +5,8 @@ * the front end of the site. * */ -class Users_Account_Controller extends Controller implements PermissionProvider { +class Users_Account_Controller extends Controller implements PermissionProvider +{ protected $member; @@ -29,24 +30,30 @@ class Users_Account_Controller extends Controller implements PermissionProvider * * @return Boolean */ - public function RequireVerification() { - if(!$this->member->isVerified() && Users::config()->require_verification) + public function RequireVerification() + { + if (!$this->member->isVerified() && Users::config()->require_verification) { return true; - else + } else { return false; + } } - public function init() { + 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(); + if (!Permission::check("USERS_MANAGE_ACCOUNT")) { + Security::permissionFailure(); + } // Set our member object $this->member = Member::currentUser(); } - public function Link($action = null) { + public function Link($action = null) + { return Controller::join_links( BASE_URL, $this->config()->url_segment, @@ -58,7 +65,8 @@ public function Link($action = null) { * Display the currently outstanding orders for the current user * */ - public function index() { + public function index() + { $member = Member::currentUser(); $this->customise(array( @@ -74,7 +82,8 @@ public function index() { )); } - public function edit() { + public function edit() + { $member = Member::currentUser(); $this->customise(array( @@ -91,9 +100,10 @@ public function edit() { )); } - public function changepassword() { + public function changepassword() + { // Set the back URL for this form - Session::set("BackURL",$this->Link("changepassword")); + Session::set("BackURL", $this->Link("changepassword")); $this->customise(array( "ClassName" => "AccountPage", @@ -115,7 +125,8 @@ public function changepassword() { * * @return Form */ - public function EditAccountForm() { + public function EditAccountForm() + { $form = Users_EditAccountForm::create($this, "EditAccountForm"); $this->extend("updateEditAccountForm", $form); @@ -129,12 +140,13 @@ public function EditAccountForm() { * * @return Form */ - public function ChangePasswordForm() { - $form = ChangePasswordForm::create($this,"ChangePasswordForm"); + public function ChangePasswordForm() + { + $form = ChangePasswordForm::create($this, "ChangePasswordForm"); $form ->Actions() - ->find("name","action_doChangePassword") + ->find("name", "action_doChangePassword") ->addExtraClass("btn") ->addExtraClass("btn-green"); @@ -145,7 +157,7 @@ public function ChangePasswordForm() { $form ->Actions() - ->insertBefore($cancel_btn,"action_doChangePassword"); + ->insertBefore($cancel_btn, "action_doChangePassword"); $this->extend("updateChangePasswordForm", $form); @@ -158,38 +170,40 @@ public function ChangePasswordForm() { * * @return ArrayList */ - public function getAccountMenu() { + public function getAccountMenu() + { $menu = new ArrayList(); $curr_action = $this->request->param("Action"); $menu->add(new ArrayData(array( "ID" => 0, - "Title" => _t('Users.PROFILESUMMARY',"Profile Summary"), + "Title" => _t('Users.PROFILESUMMARY', "Profile Summary"), "Link" => $this->Link(), "LinkingMode" => (!$curr_action) ? "current" : "link" ))); $menu->add(new ArrayData(array( "ID" => 10, - "Title" => _t('Users.EDITDETAILS',"Edit account details"), + "Title" => _t('Users.EDITDETAILS', "Edit account details"), "Link" => $this->Link("edit"), "LinkingMode" => ($curr_action == "edit") ? "current" : "link" ))); $menu->add(new ArrayData(array( "ID" => 30, - "Title" => _t('Users.CHANGEPASSWORD',"Change password"), + "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"); + return $menu->sort("ID", "ASC"); } - public function providePermissions() { + public function providePermissions() + { return array( "USERS_MANAGE_ACCOUNT" => array( 'name' => 'Manage user account', @@ -205,6 +219,4 @@ public function providePermissions() { ), ); } - - } diff --git a/code/control/Users_Register_Controller.php b/code/control/Users_Register_Controller.php index 0c59532..8bc5677 100755 --- a/code/control/Users_Register_Controller.php +++ b/code/control/Users_Register_Controller.php @@ -11,7 +11,8 @@ * $verification_groups config variable * */ -class Users_Register_Controller extends Controller { +class Users_Register_Controller extends Controller +{ /** * URL That you can access this from @@ -39,13 +40,15 @@ class Users_Register_Controller extends Controller { * @param $member Member object to send email to * @return boolean */ - protected function send_verification_email(Member $member) { - if($member) { + protected function send_verification_email(Member $member) + { + if ($member) { $subject = _t("Users.PleaseVerify", "Please verify your account"); - if(Users::config()->send_email_from) + if (Users::config()->send_email_from) { $from = Users::config()->send_email_from; - else + } else { $from = Email::config()->admin_email; + } $body = $this->renderWith( 'UsersAccountVerification', @@ -69,7 +72,8 @@ protected function send_verification_email(Member $member) { return false; } - public function Link($action = null) { + public function Link($action = null) + { return Controller::join_links( BASE_URL, $this->config()->url_segment, @@ -77,7 +81,8 @@ public function Link($action = null) { ); } - public function index(SS_HTTPRequest $request) { + public function index(SS_HTTPRequest $request) + { $this->customise(array( 'Title' => "Register", 'ClassName' => 'RegisterPage', @@ -100,18 +105,21 @@ public function index(SS_HTTPRequest $request) { * emails are enabled and account is not already verified) * */ - public function sendverification() { + public function sendverification() + { $sent = false; - if(Member::currentUserID()) + if (Member::currentUserID()) { $member = Member::currentUser(); - else + } else { $member = Member::get()->byID($this->request->param("ID")); + } - if($member && !$member->isVerified() && Users::config()->send_verification_email) + if ($member && !$member->isVerified() && Users::config()->send_verification_email) { $sent = $this->send_verification_email($member); - else + } else { $sent = false; + } $this->customise(array( "ClassName" => "RegisterPage", @@ -131,7 +139,8 @@ public function sendverification() { * ID) provided * */ - public function verify() { + public function verify() + { $member = Member::get()->byID($this->request->param("ID")); $code = $this->request->param("OtherID"); $verify = false; @@ -140,12 +149,12 @@ public function verify() { // Add a verified users group (only used if we turn on // verification) $verify_groups = Group::get() - ->filter("Code",Users::config()->verification_groups); + ->filter("Code", Users::config()->verification_groups); $this->extend("onBeforeVerify", $member); - if(($member && $code) && $code == $member->VerificationCode) { - foreach($verify_groups as $group) { + if (($member && $code) && $code == $member->VerificationCode) { + foreach ($verify_groups as $group) { $group->Members()->add($member); $verify = true; } @@ -170,11 +179,13 @@ public function verify() { * * @return Form */ - public function RegisterForm() { + public function RegisterForm() + { // If back URL set, push to session - if(isset($_REQUEST['BackURL'])) - Session::set('BackURL',$_REQUEST['BackURL']); + if (isset($_REQUEST['BackURL'])) { + Session::set('BackURL', $_REQUEST['BackURL']); + } // Setup form fields $fields = FieldList::create( @@ -186,7 +197,7 @@ public function RegisterForm() { // Setup form actions $actions = new FieldList( - FormAction::create("doRegister","Register") + FormAction::create("doRegister", "Register") ->addExtraClass("btn") ->addExtraClass("btn-green") ); @@ -207,7 +218,7 @@ public function RegisterForm() { $session_data = Session::get("Form.{$form->FormName()}.data"); - if($session_data && is_array($session_data)) { + if ($session_data && is_array($session_data)) { $form->loadDataFrom($session_data); Session::clear("Form.{$form->FormName()}.data"); } @@ -228,16 +239,19 @@ public function RegisterForm() { * @param array $data User submitted data * @param Form $form Registration form */ - function doRegister($data, $form) { + public function doRegister($data, $form) + { $filter = array(); - if(isset($data['Email'])) $filter['Email'] = $data['Email']; + if (isset($data['Email'])) { + $filter['Email'] = $data['Email']; + } $this->extend("updateMemberFilter", $filter); // Check if a user already exists - if($member = Member::get()->filter($filter)->first()) { - if($member) { + if ($member = Member::get()->filter($filter)->first()) { + if ($member) { $form->addErrorMessage( "Blurb", "Sorry, an account already exists with those details.", @@ -262,29 +276,31 @@ function doRegister($data, $form) { $this->extend("updateNewMember", $member, $data); // Add member to any groups that have been specified - if(count(Users::config()->new_user_groups)) { + if (count(Users::config()->new_user_groups)) { $groups = Group::get()->filter(array( "Code" => Users::config()->new_user_groups )); - foreach($groups as $group) { + foreach ($groups as $group) { $group->Members()->add($member); $group->write(); } } // Send a verification email, if needed - if(Users::config()->send_verification_email) + if (Users::config()->send_verification_email) { $sent = $this->send_verification_email($member); - else + } else { $sent = false; + } // Login (if enabled) - if(Users::config()->login_after_register) + if (Users::config()->login_after_register) { $member->LogIn(isset($data['Remember'])); + } // If a back URL is used in session. - if(Session::get("BackURL")) { + if (Session::get("BackURL")) { $redirect_url = Session::get("BackURL"); } else { $redirect_url = Controller::join_links( diff --git a/code/extensions/Ext_Users_Controller.php b/code/extensions/Ext_Users_Controller.php index f52146d..ac7c6de 100755 --- a/code/extensions/Ext_Users_Controller.php +++ b/code/extensions/Ext_Users_Controller.php @@ -5,15 +5,16 @@ * * @package users */ -class Ext_Users_Controller extends Extension { +class Ext_Users_Controller extends Extension +{ /** * Render current user account nav * * @return string */ - public function getUserAccountNav() { + public function getUserAccountNav() + { return $this->owner->renderWith("Users_AccountNav"); } - } diff --git a/code/extensions/Ext_Users_Group.php b/code/extensions/Ext_Users_Group.php index cfca8d4..c121b60 100755 --- a/code/extensions/Ext_Users_Group.php +++ b/code/extensions/Ext_Users_Group.php @@ -3,14 +3,16 @@ /** * Overwrite group object so we can setup some more default groups */ -class Ext_Users_Group extends DataExtension { - public function requireDefaultRecords() { +class Ext_Users_Group extends DataExtension +{ + public function requireDefaultRecords() + { parent::requireDefaultRecords(); // Add default author group if no other group exists - $frontend_group = Group::get()->filter("Code","users-frontend"); + $frontend_group = Group::get()->filter("Code", "users-frontend"); - if(!$frontend_group->exists()) { + if (!$frontend_group->exists()) { $frontend_group = new Group(); $frontend_group->Code = 'users-frontend'; $frontend_group->Title = "Frontend Users"; @@ -23,9 +25,9 @@ public function requireDefaultRecords() { // Add a verified users group (only used if we turn on // verification) - $verify_group = Group::get()->filter("Code","users-verified"); + $verify_group = Group::get()->filter("Code", "users-verified"); - if(!$verify_group->exists()) { + if (!$verify_group->exists()) { $verify_group = new Group(); $verify_group->Code = 'users-verified'; $verify_group->Title = "Verified Users"; @@ -37,4 +39,3 @@ public function requireDefaultRecords() { } } } - diff --git a/code/extensions/Ext_Users_Member.php b/code/extensions/Ext_Users_Member.php index 1ec2799..c48356f 100755 --- a/code/extensions/Ext_Users_Member.php +++ b/code/extensions/Ext_Users_Member.php @@ -1,17 +1,20 @@ "Varchar(40)" ); private static $has_many = array(); - public function isVerified() { + public function isVerified() + { return Permission::checkMember($this->owner, "USERS_VERIFIED"); } - public function updateCMSFields(FieldList $fields) { + public function updateCMSFields(FieldList $fields) + { return $fields; } } diff --git a/code/forms/Users_EditAccountForm.php b/code/forms/Users_EditAccountForm.php index 56cadeb..75e2065 100755 --- a/code/forms/Users_EditAccountForm.php +++ b/code/forms/Users_EditAccountForm.php @@ -1,14 +1,16 @@ add(HiddenField::create("ID")); - $fields->add(TextField::create("FirstName", _t('Member.FIRSTNAME',"First Name"))); - $fields->add(TextField::create("Surname", _t('Member.SURNAME',"Surname"))); - $fields->add(EmailField::create("Email", _t("Member.EMAIL","Email"))); + $fields->add(TextField::create("FirstName", _t('Member.FIRSTNAME', "First Name"))); + $fields->add(TextField::create("Surname", _t('Member.SURNAME', "Surname"))); + $fields->add(EmailField::create("Email", _t("Member.EMAIL", "Email"))); $this->extend("updateFormFields", $fields); @@ -19,7 +21,7 @@ public function __construct($controller, $name = "Users_EditAccountForm") { "cancelLink", ''. _t("Users.CANCEL", "Cancel") .'' ), - FormAction::create("doUpdate",_t("CMSMain.SAVE", "Save")) + FormAction::create("doUpdate", _t("CMSMain.SAVE", "Save")) ->addExtraClass("btn") ->addExtraClass("btn-green") ); @@ -43,23 +45,24 @@ public function __construct($controller, $name = "Users_EditAccountForm") { * @param array $data User submitted data * @param Form $form The used form */ - function doUpdate($data) { + public function doUpdate($data) + { $filter = array(); $member = Member::get()->byID($data["ID"]); // Check that a mamber isn't trying to mess up another users profile - if(Member::currentUserID() && $member->canEdit(Member::currentUser())) { + if (Member::currentUserID() && $member->canEdit(Member::currentUser())) { // Save member $this->saveInto($member); $member->write(); $this->sessionMessage( - _t("Users.DETAILSUPDATED","Account details updated"), + _t("Users.DETAILSUPDATED", "Account details updated"), "success" ); } else { $this->sessionMessage( - _t("Users.CANNOTEDIT","You cannot edit this account"), + _t("Users.CANNOTEDIT", "You cannot edit this account"), "warning" ); }