The signup(Request $credentials) function takes a Request object as input, which includes the 'organization_id' input parameter. The function retrieves a volunteer user record from the database based on the 'organization_id' input parameter. If the record exists, the function determines the status message based on the registration status of the volunteer user. If the user is already registered, the status message will be "Organization ID found, user already registered". If the user is not registered, the status message will be "Organization ID found, user not registered". If the record does not exist, the status message will be "Organization ID not found"

The register(Request $request) function takes a Request object as input, which includes the 'organization_id', 'username', 'password', and 'confirm_password' input parameters. The function validates the input parameters and checks for password validity using the validatePassword() function. If the input is valid and the password meets the requirements, the function retrieves a volunteer user record from the database based on the 'organization_id' input parameter. If the user record exists and the user is not registered, it updates the user's registration status, username, and password, and saves the changes to the database. The function then returns a JSON response containing the status message, "Organization ID found, user registered successfully", and an authentication token.

The login(Request $credentials) function takes a Request object as input, which includes the 'organization_id' and 'password' input parameters. The function checks if the volunteer user exists in the database, is registered, and is active. It also verifies if the user has exceeded the maximum number of login attempts. If the user is allowed to log in and the password is correct, the function resets the user's login attempts, generates a new token, and returns a JSON response containing the status message, "Login successful", and the user information. If the password is incorrect, the function adds a failed login attempt to the database and returns a JSON response with the status message "Invalid credentials".

The recoverRequest(Request $request) function takes a Request object as input, which includes the 'organization_id' input parameter. The function retrieves a volunteer user record from the database based on the `organization_id` input parameter, and checks whether the user exists and is registered. If the user exists and is registered, the function checks whether the user has already submitted a recovery request. If the user has not already submitted a recovery request, the function creates a new recovery request and returns a JSON response containing the status message "Recovery request sent successfully!". If the user has already submitted a recovery request, the function returns a JSON response with the status message "User has already submitted a request." If the user does not exist or is not registered, the function returns a JSON response with the relevant error message.

The changePassword(Request $request) function takes a Request object as input, which includes the 'organization_id', 'password', and 'confirm_password' input parameters. The function first validates the input parameters. Then, it retrieves the user ID from the organization ID of the request, and checks the user's recover request status. If the status is false(0), it returns an error response stating that the password recovery request has not been accepted. If the status is null, it returns an error response stating that the user has not submitted a password recovery request. If the status is true(1), the function proceeds with changing the user's password. It updates the password field in the volunteer_user table and returns a JSON response containing the status message, "Password changed successfully!"

The checkRequestStatus(Request $request) function takes a Request object as input, which includes the 'organization_id' input parameter. The function retrieves the volunteer user record from the database based on the 'organization_id', and checks if the user has already submitted a password recovery request. If the user has submitted a request, the function returns a JSON response indicating whether the request has been accepted or not. If the user has not submitted a request, the function returns a JSON response with an error message.

The logout(Request $request) function takes a Request object as input and deletes the user's token from the database, effectively logging the user out of the application. The function then returns a JSON response with the status message "Logged out".

The editProfile function takes a Request object as input, which includes the user profile information to be updated, such as the user's profile picture, username, and bio. The function first checks if the user exists in the database, and if not, returns an error response. If the user exists, the function validates the input data and updates the user's profile picture, username, and bio if provided. The updated profile picture file is saved to the storage and the hash name is stored in the database. Finally, the function returns a success response with the updated profile picture hash name.

The getUserInfo function retrieves user information from the database based on the provided branch_id and user_id (optional) parameters. If no user is found, it returns an error response. If user_id is not provided, it returns an array of user objects, otherwise it returns a single user object. Password, field1, field2, created_at, and updated_at fields are removed from the user object(s), and a 'user_type' field is added, indicating whether the user is an admin or volunteer.

The getTrainingsInfo function retrieves information about a user's trainings based on their user_id. If the user is not found, it returns an error response. The function returns an array of trainings the user has taken, as well as an array of trainings they have not taken. Trainings are sorted by program ID and each training object includes an ID, name, description, and program ID. The function also returns the count of trainings the user has not taken and the count of trainings in each program.

The getEventsOrganized function retrieves a list of events organized by the user with the provided user_id. It returns an error response if the user is not found, or a message indicating no events were found if the user did not organize any events. The response includes the 'status' key with the status message and an array of events organized by the user, sorted by date from newest to oldest. Each event includes the 'id', 'event_date', 'event_title', 'program_id', 'event_type_id', and 'role_name' fields.

The getEventsOrganizedCount function retrieves the total number of events organized by a user based on the provided user_id parameter. If no user is found, it returns an error response. If the user has not organized any events, it returns a response with a message indicating that no events were found.

The getTotalVolunteeringTime function calculates and returns the total amount of time the specified user has volunteered, based on their user_start_date and user_end_date (if provided) fields in the database. It returns a response in JSON format, including a 'status' key with the status message and a 'total_time' key with the total volunteering time in the format of "[years] Y [months] M".

The getCompletedTrainingsCount function retrieves the total count of completed trainings for a given user based on the provided user_id parameter. If no user is found, it returns an error response. It returns the total count of completed trainings as a JSON response.

The getPostsCount function returns the total count of posts for the given user_id.

The getCommentsCount function retrieves the total number of comments made by the user with the provided user_id parameter. If no user is found, it returns an error response.

The getTotalLikesReceived function returns the total number of likes received by the given user_id, which includes the sum of likes on posts and comments.

The getOwnPosts function returns all the posts created by the user with the given user_id.

The getBranchInfo function retrieves the branch information of a given user_id by matching the user's branch_id with the id in the branch table.

The getYearlyGoals function returns the yearly goals for a given branch_id. The goals are grouped based on the program_id.

The getEventInfo function returns information about events in the given branch, grouped by program name. If an event_id is provided, only the information for that event is returned.

The getAnnouncements function returns a list of announcements for a given branch. The function includes information about the announcer's name, profile picture, and the importance level of the announcement.

The getEventPictures function returns the pictures of a specific event. The pictures are ordered by date.

The getTrainingInfo function returns information about a specific training or all trainings. The function returns the training(s) information including the program name.

The createPost() function creates a new post in the database with the specified user ID, post type, and caption.

If the post type is "image", the function requires an uploaded file as "post_media".

The editPost(Request $request) function takes a Request object as input, which includes the post ID and the new caption for the post. The function checks if the post exists in the database based on the post ID. If the post exists, the function updates the post's caption to the new value. If the update is successful, the function returns a JSON response with a "Post updated successfully" message. If the update fails, the function returns a JSON response with a "Post could not be updated" message.

The deletePost(Request $request) function takes a Request object as input, which includes the post ID and the ID of the user who wants to delete the post. The function checks if the post exists in the database based on the post ID. If the post exists, the function checks if the user ID from the request matches the user ID of the post. If the user ID matches, the function deletes the post, as well as all associated likes, comments, and replies from the database. If the delete is successful, the function returns a JSON response with a "Post deleted successfully" message. If the delete fails, the function returns a JSON response with a "Post could not be deleted" message.

The getPosts($user_id = null) function retrieves posts from the database based on the user ID. If a user ID is provided, the function checks if the user exists in the database. If the user does not exist, the function returns an error response. If no user ID is provided, the function retrieves all posts from the database. The retrieved posts are sorted in descending order based on the post date. The function removes unwanted fields from each post and retrieves the name, profile picture, and username of the post owner based on the user ID. If no user is found for a post, the function returns null. The function returns a JSON response containing a status message, and an array of post objects, each containing the post details and the user details.

The getPost() function retrieves a single post from the database based on the post ID provided in the URL parameter. If the post is found, the function returns the post data along with the name of the user who posted the post. If the post is not found, the function returns an error response.

The likePost() function is used to like a post. The function takes in the post ID and user ID as parameters and checks if both the post and the user exist in the database. If either the post or the user is not found, the function returns an error response. If the user has already liked the post, the function returns an error response. If the user has not liked the post yet, a new like instance is created with the post ID, user ID, and the current date, and is saved to the database. If the like is saved successfully, the function increments the post like count and returns a success response. If the like cannot be saved, the function returns an error response. If the post like count cannot be updated, the function returns an error response.

The unlikePost API function unlikes a post by a user. The function takes in two parameters: the post ID and the user ID. If the post and user exist in the database, the function checks if the user has already liked the post. If the user has not liked the post, the function returns an error response. If the user has liked the post, the function deletes the like from the database, decrements the post like count, and returns a success response. If the like could not be deleted or the post like count could not be updated, the function returns an error response.

The commentPost() function is used to create a new comment on a post. The function takes in the post ID, user ID, and comment content as parameters and validates them. If any of the parameters are missing, the function returns an error response. If both the post and the user exist in the database, the function creates a new comment instance with the post ID, user ID, comment content, current date, and default values for the comment like count and reply count. The comment is then saved to the database. If the comment is saved successfully, the function increments the post comment count and returns a success response. If the comment cannot be saved, the function returns an error response. If the post comment count cannot be updated, the function returns an error response.

The replyComment API function is used to reply to a comment. The function takes in the comment ID, user ID, and reply content as parameters and checks if both the comment and the user exist in the database. If either the comment or the user is not found, the function returns an error response. If the user has not replied to the comment yet, a new reply instance is created with the comment ID, user ID, and the current date, and is saved to the database. If the reply is saved successfully, the function increments the comment reply count and returns a success response. If the reply cannot be saved, the function returns an error response. If the comment reply count cannot be updated, the function returns an error response.

The likeComment() function is used to like a comment. The function takes in the comment ID and user ID as parameters and checks if both the comment and the user exist in the database. If either the comment or the user is not found, the function returns an error response. If the user has already liked the comment, the function returns an error response. If the user has not liked the comment yet, a new Comment_like instance is created with the comment ID, user ID, and the current date, and is saved to the database. If the like is saved successfully, the function increments the comment like count and returns a success response. If the like cannot be saved, the function returns an error response. If the comment like count cannot be updated, the function returns an error response.

The unlikeComment() function is used to unlike a comment. The function takes in the comment ID and user ID as parameters and checks if both the comment and the user exist in the database. If either the comment or the user is not found, the function returns an error response. If the user has not already liked the comment, the function returns an error response. If the user has already liked the comment, the corresponding Comment_like instance is deleted from the database. If the like is deleted successfully, the function decrements the comment like count and returns a success response. If the like cannot be deleted, the function returns an error response. If the comment like count cannot be updated, the function returns an error response.

The deleteComment() function is used to delete a comment. The function takes in the comment ID and user ID as parameters and checks if both the comment and the user exist in the database. If either the comment or the user is not found, the function returns an error response. If the user is not the owner of the comment, the function returns an error response. The function deletes the comment and all associated likes and replies from the database. If the comment is deleted successfully, the function decrements the comment count of the post associated with the comment and returns a success response. If the comment cannot be deleted, the function returns an error response. If the post comment count cannot be updated, the function returns an error response.

The deleteReply() function is used to delete a reply. The function takes in the reply ID and user ID as parameters and checks if both the reply and the user exist in the database. If either the reply or the user is not found, the function returns an error response. If the user is not the owner of the reply, the function returns an error response. If the user is the owner of the reply, the corresponding Reply instance is deleted from the database. If the reply is deleted successfully, the function decrements the comment reply count and returns a success response. If the comment reply count cannot be updated, the function returns an error response.

The editComment() function is used to edit a comment. The function takes in the comment ID, user ID, and new comment content as parameters and checks if both the comment and the user exist in the database. If either the comment or the user is not found, the function returns an error response. If the user is not the owner of the comment, the function returns an error response. If the user is the owner of the comment, the corresponding Comment instance is updated with the new content. If the update is successful, the function returns a success response. If the update cannot be performed, the function returns an error response.

The editReply() function is used to edit a reply. The function takes in the reply ID, user ID, and new content as parameters and checks if both the reply and the user exist in the database. If either the reply or the user is not found, the function returns an error response. If the user is not the owner of the reply, the function returns an error response. If the reply is found and the user is the owner, the reply content is updated with the new content and the function returns a success response. If the reply cannot be updated, the function returns an error response.

The getComments() function is used to retrieve all comments associated with a given post. The function takes in a post ID as a parameter and checks if the post exists in the database. If the post is found, the function retrieves all comments associated with the post, removes any unnecessary fields, and retrieves the user who made the comment. If no comments are found, the function returns an error response. Otherwise, the function returns a success response along with the comments.

The getReplies() function is used to retrieve all replies for a given comment. The function takes in the comment ID as a parameter and checks if the comment exists in the database. If the comment is found, the function retrieves all the replies associated with it, removes unwanted fields, and gets user information for each reply. The function then returns a JSON response containing the replies or an error message if no replies were found for the comment.

The getPostLikes() function is used to retrieve the likes associated with a post. The function takes in the post ID as a parameter and checks if the post exists in the database. If the post is found, the likes associated with the post are retrieved and returned. If no likes are found, the function returns an error response.

The getCommentLikes() function is used to get the likes for a specific comment. The function takes in the comment ID as a parameter and checks if the comment exists in the database. If the comment is found, the function retrieves the likes associated with the comment and removes unwanted fields. The function then returns the likes and the total like count. If no likes are found for the comment, the function returns an error response.

The adminLogin function allows an admin user to log in to the system and obtain a token for authentication.

The logout function logs out the authenticated admin user by revoking all their personal access tokens.

The addUser function adds a new user to the system.

The editUser function updates the information of a specific user.

The deleteUser function deletes the specified user from the database.

The getRequests function retrieves all the recover requests made by users in the specified branch, if any.

The acceptRequest function accepts a recover request by updating the request status to accepted.

The declineRequest function declines a recover request based on the provided request ID.

The sendAnnouncement function creates a new announcement.

The deleteAnnouncement function deletes the announcement with the provided ID, but only if the admin user who created the announcement and the admin user who sent the delete request are the same.

The editAnnouncement function edits an existing announcement sent by an admin user.

The addEvent function creates a new event and adds it to the database. It also adds responsible people for the event and increments the goals table for goals that have the same program ID and event type ID as the event

The editEvent function updates an existing event with new information.

The deleteEvent function deletes an existing event.

The addImageToEvent function adds an image to an existing event.

The removeImageFromEvent function removes an image from an existing event.

The setYearlyGoal function sets a yearly goal for a specific program and event type.

The editYearlyGoal function allows you to edit an existing yearly goal by providing its ID and the updated details. The goal will be updated with the new information provided in the request. If the number of completed goals is greater than or equal to the number to complete, the goal status will be marked as completed (1). Otherwise, the goal status will be marked as incomplete (0). The API will also update the goal counter for events in the same year as the goal.

Returns a JSON object with status and message properties, indicating the success or failure of the operation.

The deleteYearlyGoal function deletes an existing yearly goal by providing its ID.

The addTrainingForUser function adds one or more trainings to one or more users by providing the training and user IDs.

The deleteTrainingForUser function removes one or more trainings from one or more users by providing the training and user IDs.

The downloadPictureByUrl($pictureUrl) function takes a URL string as input, which includes the location of the picture to be downloaded. The function checks if the picture exists in the specified location on the server. If the picture exists, the function retrieves the picture, converts it to base64 format, and returns a JSON response containing the base64-encoded content. If the picture does not exist, the function returns a JSON response with a "Image not found" message.