{"id":481,"date":"2021-12-21T22:21:00","date_gmt":"2021-12-21T22:21:00","guid":{"rendered":"https:\/\/rishikantsri.in\/blog\/?p=481"},"modified":"2023-10-25T10:11:07","modified_gmt":"2023-10-25T10:11:07","slug":"481-2","status":"publish","type":"post","link":"https:\/\/rishikantsri.in\/blog\/481-2\/","title":{"rendered":"Code Revie : image"},"content":{"rendered":"\n

Code, to be reviewed ,is <\/p>\n\n\n\n

PHP<\/span><\/span><\/path><\/path><\/svg><\/span>
if<\/span> ($request<\/span>-><\/span>file<\/span>(<\/span>'image'<\/span>)<\/span>) {<\/span><\/span>\n            $data <\/span>=<\/span> <\/span>CustomerDetails<\/span>::<\/span>where<\/span>(<\/span>'user_id'<\/span>,<\/span>$id<\/span>)<\/span>-><\/span>first<\/span>()<\/span>;<\/span><\/span>\n<\/span>\n            $file <\/span>=<\/span> $request<\/span>-><\/span>file<\/span>(<\/span>'image'<\/span>)<\/span>;<\/span><\/span>\n            <\/span>@<\/span>unlink<\/span>(<\/span>public_path<\/span>(<\/span>'upload\/customer_images\/'<\/span> <\/span>.<\/span> $data<\/span>-><\/span>image<\/span>))<\/span>;<\/span><\/span>\n            $filename <\/span>=<\/span> date<\/span>(<\/span>'YmdHi'<\/span>)<\/span> <\/span>.<\/span> $file<\/span>-><\/span>getClientOriginalName<\/span>()<\/span>;<\/span><\/span>\n            $file<\/span>-><\/span>move<\/span>(<\/span>public_path<\/span>(<\/span>'upload\/customer_images'<\/span>),<\/span> $filename<\/span>)<\/span>;<\/span><\/span>\n            $data[<\/span>'image'<\/span>] <\/span>=<\/span> $filename;<\/span><\/span>\n            $data<\/span>-><\/span>save<\/span>()<\/span>;<\/span><\/span>\n        }<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
The provided Laravel 8 code appears to handle file uploads for a customer’s image. Let’s break down the code step by step:<\/p>\n\n\n\n
    \n
  1. If Condition:<\/strong><\/li>\n<\/ol>\n\n\n\n
    PHP<\/span><\/span><\/path><\/path><\/svg><\/span>
       <\/span>if<\/span> ($request<\/span>-><\/span>file<\/span>(<\/span>'image'<\/span>)<\/span>) {<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
    This line checks if there is a file named “image” in the incoming HTTP request. It’s typically used to determine if a file has been uploaded through a form.<\/p>\n\n\n\n
      \n
    1. Query to Retrieve Customer Details:<\/strong><\/li>\n<\/ol>\n\n\n\n
      PHP<\/span><\/span><\/path><\/path><\/svg><\/span>
         $data <\/span>=<\/span> <\/span>CustomerDetails<\/span>::<\/span>where<\/span>(<\/span>'user_id'<\/span>,<\/span> $id<\/span>)<\/span>-><\/span>first<\/span>()<\/span>;<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
      This line retrieves customer details from the database. It looks for a record in the “CustomerDetails” table where the ‘user_id’ column matches the value of the variable $id<\/code>. It then retrieves the first matching record and stores it in the $data<\/code> variable.<\/p>\n\n\n\n
        \n
      1. Delete Existing Image:<\/strong><\/li>\n<\/ol>\n\n\n\n
        PHP<\/span><\/span><\/path><\/path><\/svg><\/span>
           <\/span>@<\/span>unlink<\/span>(<\/span>public_path<\/span>(<\/span>'upload\/customer_images\/'<\/span> <\/span>.<\/span> $data<\/span>-><\/span>image<\/span>))<\/span>;<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
        This line deletes the existing image associated with the customer. It uses the unlink<\/code> function to delete the file from the server’s file system. The file’s path is constructed using the public_path<\/code> helper function and the existing image’s filename, which is stored in the $data<\/code> variable under the ‘image_path’ field.<\/p>\n\n\n\n
          \n
        1. Generate New Filename:<\/strong><\/li>\n<\/ol>\n\n\n\n
          PHP<\/span><\/span><\/path><\/path><\/svg><\/span>
             $filename <\/span>=<\/span> date<\/span>(<\/span>'YmdHi'<\/span>)<\/span> <\/span>.<\/span> $file<\/span>-><\/span>getClientOriginalName<\/span>()<\/span>;<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
          Here, a new filename is generated for the uploaded image. It combines the current date and time in a specific format with the original name of the uploaded file. This is done to ensure that each uploaded image has a unique filename.<\/p>\n\n\n\n
            \n
          1. Move and Store the Uploaded File:<\/strong><\/li>\n<\/ol>\n\n\n\n
            PHP<\/span><\/span><\/path><\/path><\/svg><\/span>
               $file<\/span>-><\/span>move<\/span>(<\/span>public_path<\/span>(<\/span>'upload\/customer_images'<\/span>),<\/span> $filename<\/span>)<\/span>;<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
            This line moves and stores the uploaded file. It uses the move<\/code> method to move the uploaded file to a specific directory on the server. The destination directory is determined using the public_path<\/code> helper function, and the filename is set to the value generated in the previous step.<\/p>\n\n\n\n
              \n
            1. Update the Database with the New Image Path:<\/strong><\/li>\n<\/ol>\n\n\n\n
              PHP<\/span><\/span><\/path><\/path><\/svg><\/span>
                 $data[<\/span>'image'<\/span>] <\/span>=<\/span> $filename;<\/span><\/span>\n   $data<\/span>-><\/span>save<\/span>()<\/span>;<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
              After storing the file, this code updates the ‘image_path’ field in the customer’s details stored in the $data<\/code> variable with the new filename. It then saves the updated details back to the database.<\/p>\n\n\n\n
              To handle file uploads in Laravel using best practices, we can follow these steps:<\/p>\n\n\n\n
                \n
              1. Validation:<\/strong> Start by validating the uploaded file to ensure it meets your requirements in terms of file type, size, and other constraints. Laravel provides a powerful validation system that you can leverage.<\/li>\n\n\n\n
              2. Use Storage Disks:<\/strong> Laravel provides a “Storage” facade that allows you to work with various filesystems. Instead of saving files directly to the public_path<\/code>, you can use storage disks to handle file storage. This allows you to easily switch between different storage options, such as local disk, Amazon S3, or others, without changing your code.<\/li>\n\n\n\n
              3. Generate Unique Filenames:<\/strong> To ensure that uploaded files have unique filenames, you can use Laravel’s built-in methods. The store<\/code> method of the UploadedFile<\/code> class can be used to automatically generate unique filenames and store the file in the specified storage disk.<\/li>\n<\/ol>\n\n\n\n
                Here’s an example of how you can rewrite your code following these best practices:<\/p>\n\n\n\n
                PHP<\/span><\/span><\/path><\/path><\/svg><\/span>
                use<\/span> <\/span>Illuminate<\/span>\\<\/span>Support<\/span>\\<\/span>Facades<\/span>\\<\/span>Storage<\/span>;<\/span><\/span>\n<\/span>\npublic<\/span> <\/span>function<\/span> uploadImage(<\/span>Request<\/span> $request<\/span>,<\/span> $id)<\/span><\/span>\n{<\/span><\/span>\n    $request<\/span>-><\/span>validate<\/span>(<\/span>[<\/span><\/span>\n        <\/span>'image_path'<\/span> <\/span>=><\/span> <\/span>'required|image|mimes:jpeg,png,jpg,gif|max:2048'<\/span>,<\/span> <\/span>\/\/ Adjust the validation rules as needed<\/span><\/span>\n    ]<\/span>)<\/span>;<\/span><\/span>\n<\/span>\n    $customer <\/span>=<\/span> <\/span>CustomerDetails<\/span>::<\/span>where<\/span>(<\/span>'user_id'<\/span>,<\/span> $id<\/span>)<\/span>-><\/span>first<\/span>()<\/span>;<\/span><\/span>\n<\/span>\n    <\/span>if<\/span> (<\/span>!<\/span>$customer) {<\/span><\/span>\n        <\/span>\/\/ Handle the case where the customer does not exist<\/span><\/span>\n        <\/span>return<\/span> redirect<\/span>()<\/span>-><\/span>back<\/span>()<\/span>-><\/span>with<\/span>(<\/span>'error'<\/span>,<\/span> <\/span>'Customer not found.'<\/span>)<\/span>;<\/span><\/span>\n    }<\/span><\/span>\n<\/span>\n    <\/span>if<\/span> ($request<\/span>-><\/span>file<\/span>(<\/span>'image'<\/span>)<\/span>) {<\/span><\/span>\n        $uploadedFile <\/span>=<\/span> $request<\/span>-><\/span>file<\/span>(<\/span>'image'<\/span>)<\/span>;<\/span><\/span>\n        $newFileName <\/span>=<\/span> $uploadedFile<\/span>-><\/span>hashName<\/span>()<\/span>; <\/span>\/\/ Generates a unique filename<\/span><\/span>\n<\/span>\n        <\/span>\/\/ Store the file on the configured disk (e.g., 'public' disk)<\/span><\/span>\n        $storedPath <\/span>=<\/span> $uploadedFile<\/span>-><\/span>store<\/span>(<\/span>'upload\/customer_images'<\/span>,<\/span> <\/span>'public'<\/span>)<\/span>;<\/span><\/span>\n<\/span>\n        <\/span>\/\/ Update the customer's image path in the database<\/span><\/span>\n        $customer<\/span>-><\/span>image <\/span>=<\/span> $storedPath;<\/span><\/span>\n        $customer<\/span>-><\/span>save<\/span>()<\/span>;<\/span><\/span>\n<\/span>\n        <\/span>return<\/span> redirect<\/span>()<\/span>-><\/span>back<\/span>()<\/span>-><\/span>with<\/span>(<\/span>'success'<\/span>,<\/span> <\/span>'Image uploaded successfully.'<\/span>)<\/span>;<\/span><\/span>\n    }<\/span><\/span>\n<\/span>\n    <\/span>return<\/span> redirect<\/span>()<\/span>-><\/span>back<\/span>()<\/span>-><\/span>with<\/span>(<\/span>'error'<\/span>,<\/span> <\/span>'No file was uploaded.'<\/span>)<\/span>;<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
                In this code:<\/p>\n\n\n\n
                  \n
                • We start by validating the uploaded file using Laravel’s validation rules.<\/li>\n\n\n\n
                • We retrieve the customer details and check if the customer exists.<\/li>\n\n\n\n
                • We use the hashName<\/code> method to generate a unique filename for the uploaded file.<\/li>\n\n\n\n
                • We use the store<\/code> method to store the file on the ‘public’ disk within the ‘upload\/customer_images’ directory.<\/li>\n\n\n\n
                • We update the customer’s image path in the database and return a success message.<\/li>\n<\/ul>\n\n\n\n
                  Please make sure to customize the validation rules, error handling, and storage disk configuration to match your specific application’s requirements.<\/p>\n","protected":false},"excerpt":{"rendered":"
                  Code, to be reviewed ,is The provided Laravel 8 code appears to handle file uploads for a customer’s image. Let’s break down the code step by step: This line checks if there is a file named “image” in the incoming HTTP request. It’s typically used to determine if a file has been uploaded through a […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1,59,11],"tags":[60,3,8,4],"_links":{"self":[{"href":"https:\/\/rishikantsri.in\/blog\/wp-json\/wp\/v2\/posts\/481"}],"collection":[{"href":"https:\/\/rishikantsri.in\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/rishikantsri.in\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/rishikantsri.in\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/rishikantsri.in\/blog\/wp-json\/wp\/v2\/comments?post=481"}],"version-history":[{"count":3,"href":"https:\/\/rishikantsri.in\/blog\/wp-json\/wp\/v2\/posts\/481\/revisions"}],"predecessor-version":[{"id":491,"href":"https:\/\/rishikantsri.in\/blog\/wp-json\/wp\/v2\/posts\/481\/revisions\/491"}],"wp:attachment":[{"href":"https:\/\/rishikantsri.in\/blog\/wp-json\/wp\/v2\/media?parent=481"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/rishikantsri.in\/blog\/wp-json\/wp\/v2\/categories?post=481"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/rishikantsri.in\/blog\/wp-json\/wp\/v2\/tags?post=481"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}