How to explain PHPDoc attributes of `@property-read` and `@property-write`?

✔ Recommended Answer

Here's a good explanation on magic properties.

Basically, @property-write is interpreted - as the name suggests - as a write-only property. The code completion in Eclipse, for example, makes use of this. If your magic property foo is declared "write-only", it wouldn't show up in code completion, when you type $a = $this->f.

Source: stackoverflow.com

Answered By: Linus Kleen

Method #2

In PHP, @property-read and @property-write are two types of PHPDoc attributes that are used to document properties of a class.

  • @property-read is used to document properties that can be read (i.e. accessed) by the external code but cannot be written to. It is used to declare a getter method for the property. This attribute is typically used to indicate that the property is read-only and should not be modified directly.

Here is an example of using @property-read in PHPDoc:

vbnet
/**
 * MyClass Class
 *
 * @property-read int $id The ID of the MyClass instance.
 */
class MyClass
{
    /**
     * Get the ID of the MyClass instance.
     *
     * @return int
     */
    public function getId()
    {
        // implementation
    }
}

In this example, the @property-read attribute is used to declare that the id property of the MyClass class can only be read and not written. The getId() method is the getter method for the id property, which returns the value of the property.

  • @property-write is used to document properties that can be written to (i.e. modified) by the external code but cannot be read. It is used to declare a setter method for the property. This attribute is typically used to indicate that the property is write-only and should not be accessed directly.

Here is an example of using @property-write in PHPDoc:

php
/**
 * MyClass Class
 *
 * @property-write int $id The ID of the MyClass instance.
 */
class MyClass
{
    /**
     * Set the ID of the MyClass instance.
     *
     * @param int $id
     */
    public function setId($id)
    {
        // implementation
    }
}

In this example, the @property-write attribute is used to declare that the id property of the MyClass class can only be written to and not read. The setId($id) method is the setter method for the id property, which sets the value of the property.

In summary, @property-read and @property-write are PHPDoc attributes used to document properties of a class that can be read and written respectively. They are used to declare getter and setter methods for properties to ensure proper encapsulation and to document the accessibility of the properties.

Comments

Post a Comment

Most Popular

PhpStorm, return value is expected to be 'A', 'object' returned

Image
✔ Recommended Answer Has to be because object can be ANY class instance, even B etc. You can annotate the create() method with generics PHPDoc to tell that the return type will be the same as the input parameter class string. It gives more context info to the IDE. /** * @template T * * @param string $class * @return T */ private function create(string $class) : object { return new $class(); } P.S. Instead of create('B'); better use create(B::class) . This way the IDE can track the usages of that class for refactoring/search purposes etc. Source: stackoverflow.com Answered By: LazyOne Method #2 This error message suggests that your code is expecting a value of type 'A' to be returned, but instead, the code is returning an object. This error can occur in PhpStorm, or any other PHP development environment. To resolve this error, you should check the function or method that is returning the object and ensure that it is returning
Read more

Remove Unicode Zero Width Space PHP

✔ Recommended Answer This: $newBody = str_replace("​", "", $newBody); presumes the text is HTML entity encoded. This: $newBody = str_replace("\xE2\x80\x8C", "", $newBody); should work if the offending characters are not encoded, but matches the wrong character (0xe2808c). To match the same character as #8203; you need 0xe2808b: $newBody = str_replace("\xE2\x80\x8B", "", $newBody); Source: stackoverflow.com Answered By: Jef Method #2 To remove Unicode zero width space (ZWSP) from a string in PHP, you can use the str_replace() function to replace the ZWSP character with an empty string. Here's an example: php $str = "Hello​ World" ; // Contains ZWSP after "Hello" // Replace ZWSP with an empty string $str = str_replace ( "\u{200B}" , "" , $str ); echo $str ; // Outputs "Hello World" without ZWSP In this example, the str_replace() functi
Read more

Laravel file upload returns forbidden 403, file permission is 700 not 755

✔ Recommended Answer The issue you are facing could be due to incorrect file permissions for the storage folder. Here are some steps to fix the problem: SSH into your cPanel server. Change the permission of the storage folder to 755: chmod -R 755 storage/ This command will change the permission of the storage folder and all its contents to 755, which should give the web server permission to read and write to the folder. Check the ownership of the storage folder. Ensure that the owner of the folder is the same as the user running the web server (typically www-data on Apache): ls -l This command will list the files and folders in the current directory along with their ownership and permission details. Make sure that the owner of the storage folder is the same as the user running the web server. If the ownership is incorrect, you can change it using the following command: chown -R www-data:www-data storage/ This command will change the ownership of the storage folder and all its conten
Read more