Helper class
Helper class for common functionalities like validations and snack bars This class extends GetxController to leverage GetX's reactive state management. It provides static methods for validating user inputs such as usernames, emails, and passwords, as well as methods for displaying various types of snack bars (success, warning, error, modern).
- Inheritance
Constructors
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasListeners → bool
-
no setterinherited
- initialized → bool
-
Checks whether the controller has already been initialized.
no setterinherited
- isClosed → bool
-
Checks whether the controller has already been closed.
no setterinherited
- listeners → int
-
no setterinherited
-
onDelete
→ InternalFinalCallback<
void> -
Internal callback that starts the cycle of this controller.
finalinherited
-
onStart
→ InternalFinalCallback<
void> -
Called at the exact moment the widget is allocated in memory.
It uses an internal "callable" type, to avoid any @overrides in subclases.
This method should be internal and is required to define the
lifetime cycle of the subclass.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
$configureLifeCycle(
) → void -
inherited
-
addListener(
GetStateUpdate listener) → Disposer -
Register a closure to be called when the object notifies its listeners.
inherited
-
addListenerId(
Object? key, GetStateUpdate listener) → Disposer -
inherited
-
dispose(
) → void -
inherited
-
disposeId(
Object id) → void -
To dispose an
id
from future updates(), this ids are registered byGetBuilder()
or similar, so is a way to unlink the state change with the Widget from the Controller.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
notifyChildrens(
) → void -
inherited
-
onClose(
) → void -
Called before onDelete method. onClose might be used to
dispose resources used by the controller. Like closing events,
or streams before the controller is destroyed.
Or dispose objects that can potentially create some memory leaks,
like TextEditingControllers, AnimationControllers.
Might be useful as well to persist some data on disk.
inherited
-
onInit(
) → void -
Called immediately after the widget is allocated in memory.
You might use this to initialize something for the controller.
inherited
-
onReady(
) → void -
Called 1 frame after onInit(). It is the perfect place to enter
navigation events, like snackbar, dialogs, or a new route, or
async request.
inherited
-
refresh(
) → void -
inherited
-
refreshGroup(
Object id) → void -
inherited
-
removeListener(
VoidCallback listener) → void -
Remove a previously registered closure from the list of closures that the
object notifies.
inherited
-
removeListenerId(
Object id, VoidCallback listener) → void -
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
update(
[List< Object> ? ids, bool condition = true]) → void -
Rebuilds
GetBuilder
each time you callupdate()
; Can take a List ofids
, that will only update the matchingGetBuilder( id: )
,ids
can be reused amongGetBuilders
like group tags. The update will only notify the Widgets, ifcondition
is true.inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
errorSnackBar(
{required String title, dynamic message}) → void - Displays an error snack bar with a title and message. @param title The title of the snack bar. @param message The message to display in the snack bar. @return void
-
isUsernameTaken(
String username) → Future< bool> - Checks if a username is already taken in the Firestore database. @param username The username string to check. @return A Future that resolves to true if the username is taken, false otherwise.
-
modernSnackBar(
{required String title, dynamic message}) → void - Displays a modern snack bar with a title and message. @param title The title of the snack bar. @param message The message to display in the snack bar. @return void
-
repeatPassword(
String value, dynamic controller, BuildContext context) → String? - Validates a password confirmation to ensure it matches the original password. @param value The confirmation password string to validate. @param controller The controller containing the original password. @param context The BuildContext for localization. @return A string error message if validation fails, or null if it passes.
-
successSnackBar(
{required String title, dynamic message}) → void - Displays a success snack bar with a title and message. @param title The title of the snack bar. @param message The message to display in the snack bar. @return void
-
validateEmail(
String? value, BuildContext context) → String? - Validates an email address to ensure it is not empty, has a valid format, and DHBW domain. @param value The email string to validate. @param context The BuildContext for localization. @return A string error message if validation fails, or null if it passes.
-
validateFullName(
String? value, BuildContext context) → String? - Validates a full name to ensure it contains only letters and spaces. @param value The full name string to validate. @param context The BuildContext for localization. @return A string error message if validation fails, or null if it passes.
-
validatePassword(
String? value, BuildContext context) → String? - Validates a password to ensure it meets specific criteria:
-
validateUsername(
String? value, BuildContext context) → String? - Validates a username based on specific criteria:
-
warningSnackBar(
{required String title, dynamic message}) → void - Displays a warning snack bar with a title and message. @param title The title of the snack bar. @param message The message to display in the snack bar. @return void