From d943b5a33bfd3c2e82fc3de6fb3571ce25b7a68a Mon Sep 17 00:00:00 2001
From: Alexander Purr <purr@ub.uni-leipzig.de>
Date: Thu, 23 Dec 2021 15:59:26 +0100
Subject: [PATCH] refs #21064 [fid] code style fid/FormModel
---
.../fid/src/FormModel/PasswordChangeModel.php | 59 ++++++++++++++-----
.../fid/src/FormModel/PasswordResetModel.php | 47 +++++++++++----
module/fid/src/FormModel/UserDeleteModel.php | 58 +++++++++++++-----
.../fid/src/FormModel/UsernameChangeModel.php | 59 ++++++++++++++-----
4 files changed, 167 insertions(+), 56 deletions(-)
diff --git a/module/fid/src/FormModel/PasswordChangeModel.php b/module/fid/src/FormModel/PasswordChangeModel.php
index e31add1894f..00bfd9ea139 100644
--- a/module/fid/src/FormModel/PasswordChangeModel.php
+++ b/module/fid/src/FormModel/PasswordChangeModel.php
@@ -1,7 +1,11 @@
<?php
/**
+ * Password change form model
+ *
* Copyright (C) 2019 Leipzig University Library
*
+ * PHP Version 7
+ *
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation.
@@ -15,30 +19,39 @@
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
- * @author Robert Lange <lange@ub.uni-leipzig.de>
- * @author Sebastian Kehr <kehr@ub.uni-leipzig.de>
- * @license http://opensource.org/licenses/gpl-2.0.php GNU GPLv2
+ * @category VuFind
+ * @package Form_Model
+ * @author Robert Lange <lange@ub.uni-leipzig.de>
+ * @author Sebastian Kehr <kehr@ub.uni-leipzig.de>
+ * @license http://opensource.org/licenses/gpl-2.0.php GNU GPLv2
+ * @link https://vufind.org/wiki/development Wiki
*/
namespace fid\FormModel;
+/**
+ * Password change form model
+ *
+ * @category VuFind
+ * @package Form_Model
+ * @author Robert Lange <lange@ub.uni-leipzig.de>
+ * @author Sebastian Kehr <kehr@ub.uni-leipzig.de>
+ * @license http://opensource.org/licenses/gpl-2.0.php GNU GPLv2
+ * @link https://vufind.org/wiki/development Wiki
+ */
class PasswordChangeModel
{
- /**
- * @var string
- */
+ /* @var string */
protected $password;
- /**
- * @var string
- */
+ /* @var string */
protected $passwordConfirmation;
- /**
- * @var string
- */
+ /* @var string */
protected $submit;
/**
+ * Get password
+ *
* @return string
*/
public function getPassword(): string
@@ -47,7 +60,11 @@ class PasswordChangeModel
}
/**
- * @param string $password
+ * Set password
+ *
+ * @param string $password Password
+ *
+ * @return void
*/
public function setPassword(string $password): void
{
@@ -55,6 +72,8 @@ class PasswordChangeModel
}
/**
+ * Get password confirmation
+ *
* @return string
*/
public function getPasswordConfirmation(): string
@@ -63,7 +82,11 @@ class PasswordChangeModel
}
/**
- * @param string $passwordConfirmation
+ * Set password confirmation
+ *
+ * @param string $passwordConfirmation Password confirmation
+ *
+ * @return void
*/
public function setPasswordConfirmation(string $passwordConfirmation): void
{
@@ -71,6 +94,8 @@ class PasswordChangeModel
}
/**
+ * Get submit
+ *
* @return string
*/
public function getSubmit(): string
@@ -79,7 +104,11 @@ class PasswordChangeModel
}
/**
- * @param string $submit
+ * Set submit
+ *
+ * @param string $submit Submit
+ *
+ * @return void
*/
public function setSubmit(string $submit): void
{
diff --git a/module/fid/src/FormModel/PasswordResetModel.php b/module/fid/src/FormModel/PasswordResetModel.php
index d65083b599e..1f0a835ca51 100644
--- a/module/fid/src/FormModel/PasswordResetModel.php
+++ b/module/fid/src/FormModel/PasswordResetModel.php
@@ -1,7 +1,11 @@
<?php
/**
+ * Password reset form model
+ *
* Copyright (C) 2019 Leipzig University Library
*
+ * PHP Version 7
+ *
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation.
@@ -15,25 +19,36 @@
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
- * @author Robert Lange <lange@ub.uni-leipzig.de>
- * @author Sebastian Kehr <kehr@ub.uni-leipzig.de>
- * @license http://opensource.org/licenses/gpl-2.0.php GNU GPLv2
+ * @category VuFind
+ * @package Form_Model
+ * @author Robert Lange <lange@ub.uni-leipzig.de>
+ * @author Sebastian Kehr <kehr@ub.uni-leipzig.de>
+ * @license http://opensource.org/licenses/gpl-2.0.php GNU GPLv2
+ * @link https://vufind.org/wiki/development Wiki
*/
namespace fid\FormModel;
+/**
+ * Password reset form model
+ *
+ * @category VuFind
+ * @package Form_Model
+ * @author Robert Lange <lange@ub.uni-leipzig.de>
+ * @author Sebastian Kehr <kehr@ub.uni-leipzig.de>
+ * @license http://opensource.org/licenses/gpl-2.0.php GNU GPLv2
+ * @link https://vufind.org/wiki/development Wiki
+ */
class PasswordResetModel
{
- /**
- * @var string
- */
+ /* @var string */
protected $username;
- /**
- * @var string
- */
+ /* @var string */
protected $submit;
/**
+ * Get Username
+ *
* @return string
*/
public function getUsername(): string
@@ -42,7 +57,11 @@ class PasswordResetModel
}
/**
- * @param string $username
+ * Set Username
+ *
+ * @param string $username Username
+ *
+ * @return void
*/
public function setUsername(string $username): void
{
@@ -50,6 +69,8 @@ class PasswordResetModel
}
/**
+ * Get submit
+ *
* @return string
*/
public function getSubmit(): string
@@ -58,7 +79,11 @@ class PasswordResetModel
}
/**
- * @param string $submit
+ * Set submit
+ *
+ * @param string $submit Submit
+ *
+ * @return void
*/
public function setSubmit(string $submit): void
{
diff --git a/module/fid/src/FormModel/UserDeleteModel.php b/module/fid/src/FormModel/UserDeleteModel.php
index e66ca692bf6..091ad1b2421 100644
--- a/module/fid/src/FormModel/UserDeleteModel.php
+++ b/module/fid/src/FormModel/UserDeleteModel.php
@@ -1,6 +1,10 @@
<?php
/**
- * Copyright (C) 2020 Leipzig University Library
+ * User delete form model
+ *
+ * Copyright (C) 2019 Leipzig University Library
+ *
+ * PHP Version 7
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
@@ -15,29 +19,37 @@
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
- * @author Robert Lange <lange@ub.uni-leipzig.de>
- * @license http://opensource.org/licenses/gpl-2.0.php GNU GPLv2
+ * @category VuFind
+ * @package Form_Model
+ * @author Robert Lange <lange@ub.uni-leipzig.de>
+ * @license http://opensource.org/licenses/gpl-2.0.php GNU GPLv2
+ * @link https://vufind.org/wiki/development Wiki
*/
namespace fid\FormModel;
+/**
+ * User delete form model
+ *
+ * @category VuFind
+ * @package Form_Model
+ * @author Robert Lange <lange@ub.uni-leipzig.de>
+ * @license http://opensource.org/licenses/gpl-2.0.php GNU GPLv2
+ * @link https://vufind.org/wiki/development Wiki
+ */
class UserDeleteModel
{
- /**
- * @var string
- */
+ /* @var string */
protected $id;
- /**
- * @var string
- */
+ /* @var string */
protected $passwordConfirmation;
- /**
- * @var string
- */
+ /* @var string */
protected $submit;
/**
+ * Get password confirmation
+ *
* @return string
*/
public function getPasswordConfirmation(): string
@@ -46,7 +58,11 @@ class UserDeleteModel
}
/**
- * @param string $password
+ * Set password confirmation
+ *
+ * @param string $password Password confirmation
+ *
+ * @return void
*/
public function setPasswordConfirmation(string $password): void
{
@@ -54,6 +70,8 @@ class UserDeleteModel
}
/**
+ * Get submit
+ *
* @return string
*/
public function getSubmit(): string
@@ -62,7 +80,11 @@ class UserDeleteModel
}
/**
- * @param string $submit
+ * Set submit
+ *
+ * @param string $submit Submit
+ *
+ * @return void
*/
public function setSubmit(string $submit): void
{
@@ -70,6 +92,8 @@ class UserDeleteModel
}
/**
+ * Get ID
+ *
* @return string
*/
public function getId(): string
@@ -78,7 +102,11 @@ class UserDeleteModel
}
/**
- * @param string $id
+ * Set ID
+ *
+ * @param string $id ID
+ *
+ * @return void
*/
public function setId(string $id)
{
diff --git a/module/fid/src/FormModel/UsernameChangeModel.php b/module/fid/src/FormModel/UsernameChangeModel.php
index 084f5114199..df99fc81a34 100644
--- a/module/fid/src/FormModel/UsernameChangeModel.php
+++ b/module/fid/src/FormModel/UsernameChangeModel.php
@@ -1,7 +1,11 @@
<?php
/**
+ * Username change form model
+ *
* Copyright (C) 2019 Leipzig University Library
*
+ * PHP Version 7
+ *
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation.
@@ -15,30 +19,39 @@
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
- * @author Gregor Gawol <gawol@ub.uni-leipzig.de>
- * @author Sebastian Kehr <kehr@ub.uni-leipzig.de>
- * @license http://opensource.org/licenses/gpl-2.0.php GNU GPLv2
+ * @category VuFind
+ * @package Form_Model
+ * @author Gregor Gawol <gawol@ub.uni-leipzig.de>
+ * @author Sebastian Kehr <kehr@ub.uni-leipzig.de>
+ * @license http://opensource.org/licenses/gpl-2.0.php GNU GPLv2
+ * @link https://vufind.org/wiki/development Wiki
*/
namespace fid\FormModel;
+/**
+ * Username change form model
+ *
+ * @category VuFind
+ * @package Form_Model
+ * @author Gregor Gawol <gawol@ub.uni-leipzig.de>
+ * @author Sebastian Kehr <kehr@ub.uni-leipzig.de>
+ * @license http://opensource.org/licenses/gpl-2.0.php GNU GPLv2
+ * @link https://vufind.org/wiki/development Wiki
+ */
class UsernameChangeModel
{
- /**
- * @var string
- */
+ /* @var string */
protected $username;
- /**
- * @var string
- */
+ /* @var string */
protected $usernameConfirmation;
- /**
- * @var string
- */
+ /* @var string */
protected $submit;
/**
+ * Get username
+ *
* @return string
*/
public function getUsername(): string
@@ -47,7 +60,11 @@ class UsernameChangeModel
}
/**
- * @param string $username
+ * Set username
+ *
+ * @param string $username Username
+ *
+ * @return void
*/
public function setUsername(string $username): void
{
@@ -55,6 +72,8 @@ class UsernameChangeModel
}
/**
+ * Get username confirmation
+ *
* @return string
*/
public function getUsernameConfirmation(): string
@@ -63,7 +82,11 @@ class UsernameChangeModel
}
/**
- * @param string $usernameConfirmation
+ * Set username confirmation
+ *
+ * @param string $usernameConfirmation Username confirmation
+ *
+ * @return void
*/
public function setUsernameConfirmation(string $usernameConfirmation): void
{
@@ -71,6 +94,8 @@ class UsernameChangeModel
}
/**
+ * Get submit
+ *
* @return string
*/
public function getSubmit(): string
@@ -79,7 +104,11 @@ class UsernameChangeModel
}
/**
- * @param string $submit
+ * Set submit
+ *
+ * @param string $submit Submit value
+ *
+ * @return void
*/
public function setSubmit(string $submit): void
{
--
GitLab