There is a [PHP Standards Recommendation (PSR)][1] currently in draft [(PSR-5) that proposes][2] **@return $this** is used in order to indicate that the same instance is returned.

&gt; $this, the element to which this type applies is the same exact instance as the current class in the given context. As such this type is a stricter version of static as, in addition, the returned instance must not only be of the same class but also the same instance.
&gt;
&gt;This type is often used as return value for methods implementing the Fluent Interface design pattern.

This notation is currently used by popular IDEs such as PhpStorm and Netbeans.


  [1]: http://www.php-fig.org/psr/
  [2]: https://github.com/php-fig/fig-standards/blob/master/proposed/phpdoc.md#appendix-a-types

`@return Current_Class_Name` will definitely work and is what I prefer.

`@return self` may work ok with some programs too.

`@return this` is bad because this is not a typename.


This question is quite old, but I just want to share to everyone!

*AT LEAST* for the ones that uses **NetBeans 8.1**.. this notation makes **code autocompletion to nicely work** at IDE:

    /**
	 * Method that returns $this instance (using late state binding)
	 * @return static
	 */
	 public function iWillReturnMyself ( ) {
	 	 return $this;
	 }

I say *AT LEAST* for NetBeans8.1 users, but *may work* on older versions and/or others IDEs too =]

    /**
     * set something
     *
     * @return self
     */
    public function setSomething(){
                // ...
        return $this;
    }

You can use &quot;self&quot; type as @param or @return..

PHPDoc recommends &#39;self&#39; to refer to self in object..

Source: http://www.phpdoc.org/docs/latest/references/phpdoc/types.html

As has been requested in &quot;[ipv6-capable inet_aton and inet_ntoa functions needed](http://bugs.mysql.com/bug.php?id=34037)&quot;, there is currently no MySQL function for storing IPv6 addresses. What would be the recommended data type/function for storing/inserting? (I don&#39;t intend to store them as a string). I also don&#39;t want to separate the IPv6 address into 2 INT&#39;s.

Storing IPv6 Addresses in MySQL

Suppose I want to write a generic function `void f&lt;T&gt;()`, which does one thing if `T` is a POD type and another thing if `T` is non-POD (or any other arbitrary predicate).

One way to achieve this would be to use a tag-dispatch pattern like the standard library does with iterator categories:

    template &lt;bool&gt; struct podness {};
    typedef podness&lt;true&gt; pod_tag;
    typedef podness&lt;false&gt; non_pod_tag;

    template &lt;typename T&gt; void f2(T, pod_tag) { /* POD */ }
    template &lt;typename T&gt; void f2(T, non_pod_tag) { /* non-POD */ }

    template &lt;typename T&gt;
    void f(T x)
    {
        // Dispatch to f2 based on tag.
        f2(x, podness&lt;std::is_pod&lt;T&gt;::value&gt;());
    }

An alternative would be to use static member function of partially specialised types:

    template &lt;typename T, bool&gt; struct f2;

    template &lt;typename T&gt;
    struct f2&lt;T, true&gt; { static void f(T) { /* POD */ } };
  
    template &lt;typename T&gt;
    struct f2&lt;T, false&gt; { static void f(T) { /* non-POD */ } };

    template &lt;typename T&gt;
    void f(T x)
    {
        // Select the correct partially specialised type.
        f2&lt;T, std::is_pod&lt;T&gt;::value&gt;::f(x);
    }

What are the pros and cons of using one method over the other? Which would you recommend?


Tag dispatch versus static methods on partially specialised classes

I have a method that return the current object, how do I document this?

    /**
     * set something
     *
     * @return this
     */
	public function setSomething(){
                // ...
		return $this;
	}

Or should I do `@return self` or `@return Current_Class_Name`?

---

Reason why this question is not &quot;primarily opinion-based&quot; (and should be reopened): conformance to standards and IDE type hinting support.

Should I use @return self, this or the current class?

I have a method that return the current object, how do I document this?
<pre><code class="hljs language-php">/**
 * set something
 *
 * @return this
 */
public function setSomething(){
 // ...
	return $this;
}
</code></pre>
Or should I do <code>@return self</code> or <code>@return Current_Class_Name</code>?
<hr>
Reason why this question is not "primarily opinion-based" (and should be reopened): conformance to standards and IDE type hinting support.

I came across this code...

    if(isset($string[255])) {
        // too long
    }

isset() is between 6 and 40 faster than 

    if(strlen($string) &gt; 255) {
        // too long
    }

The only drawback to the isset() is that the code is unclear - we cannot tell right away what is being done (see pekka&#39;s answer). We can wrap isset() within a function i.e. strlt($string,255) but we then loose the speed benefits of isset().

**How can we use the faster isset() function while retaining readability of the code?** 

EDIT : test to show the speed http://codepad.org/ztYF0bE3

    strlen() over 1000000 iterations 7.5193998813629
    isset() over 1000000 iterations 0.29940009117126

EDIT2 : here&#39;s why isset() is faster

    $string = &#39;abcdefg&#39;;
    var_dump($string[2]);
    Output: string(1) “c”

    $string = &#39;abcdefg&#39;;
    if (isset($string[7])){
         echo $string[7].&#39; found!&#39;;
      }else{
         echo &#39;No character found at position 7!&#39;;
    }

This is faster than using strlen() because, “… calling a function is more expensive than using a language construct.” http://www.phpreferencebook.com/tips/use-isset-instead-of-strlen/

EDIT3 : I was always taught to be interested in mirco-optimisation. Probably because I was taught at a time when resources on computers were tiny. I&#39;m open to the idea that it may not be important, there are some good arguments against it in the answers.
I&#39;ve started a new question exploring this... https://stackoverflow.com/questions/6983208/is-micro-optimisation-important-when-coding

isset() vs strlen() - a fast/clear string length calculation

Im using PHP to build the URL of the current page. Sometimes, URLs in the form of 

    www.mydomian.com/myurl.html?unwantedthngs

are requested. I want to remove the `?` and everything that follows it (querystring), such that the resulting URL becomes:

    www.mydomain.com/myurl.html

My current code is this:

    &lt;?php
    function curPageURL() {
        $pageURL = &#39;http&#39;;
        if ($_SERVER[&quot;HTTPS&quot;] == &quot;on&quot;) {
            $pageURL .= &quot;s&quot;;
        }
        $pageURL .= &quot;://&quot;;
        if ($_SERVER[&quot;SERVER_PORT&quot;] != &quot;80&quot;) {
            $pageURL .= $_SERVER[&quot;SERVER_NAME&quot;] . &quot;:&quot; .
                $_SERVER[&quot;SERVER_PORT&quot;] . $_SERVER[&quot;REQUEST_URI&quot;];
        } else {
            $pageURL .= $_SERVER[&quot;SERVER_NAME&quot;] . $_SERVER[&quot;REQUEST_URI&quot;];
        }
        return $pageURL;
    }
    ?&gt;



How to remove the querystring and get only the url?

I&#39;m developing a simple php upload script, and users can upload only ZIP and RAR files.

What MIME types I should use to check `$_FILES[x][type]`? (a complete list please)

.rar, .zip files MIME Type

I need to search a multidimensional array for a specific value in any of the indexed subarrays.

In other words, I need to check a single column of the multidimensional array for a value.  If the value exists anywhere in the multidimensional array, I would like to return `true` otherwise `false`

    $my_array = array(    
        0 =&gt;  array(  
            &quot;name&quot;   =&gt; &quot;john&quot;,  
            &quot;id&quot;    =&gt;  4  
        ),  
        1   =&gt;  array(  
            &quot;name&quot; =&gt;  &quot;mark&quot;,  
            &quot;id&quot; =&gt; 152  
        ), 
        2   =&gt;  array(  
            &quot;name&quot; =&gt;  &quot;Eduard&quot;,  
            &quot;id&quot; =&gt; 152  
        )
    );

I would like to know the fastest and most efficient way to check if the array `$my_array` contains a value with the key &quot;id&quot;.  For example, if `id =&gt; 152` anywhere in the multidimensional array, I would like `true`.

Check if a specific value exists at a specific key in any subarray of a multidimensional array

How to extract text from the PDF document *using PHP*?

(I can&#39;t use other tools, I don&#39;t have root access)

I&#39;ve found some functions working for plain text, but they don&#39;t handle well Unicode characters:

http://www.hashbangcode.com/blog/zend-lucene-and-pdf-documents-part-2-pdf-data-extraction-437.html

How to extract text from the PDF document?

How do I make multi-line comments? Most languages have block comment symbols like:

    /*

    */





How do I create multiline comments in Python?

Using JavaDoc, how can I reference the value of a final static field in the class?

I want the `???` in this example replaced by the value of the field `STATIC_FIELD`.

    /**
     * This is a simple class with only one static field with the value ???.
     */
    public class Simple {

        /**
         * We can reference the value with {@value} here, 
         * but how do we reference it in the class JavaDoc?
         */
        public static final String STATIC_FIELD = &quot;simple static field&quot;;

    }


How can I reference the value of a final static field in the class?

I&#39;m programming in C++ using Visual Studio 2010 Ultimate. I want to document some functions and I want the documentation to show up in Intellisense.

According to [MSDN][msdn], I just need to put the comment before the declaration or after it on the same line. So I tried this:

    // This is a test.
    void foo();
    void bar() { foo(); }

When moving my mouse over `foo()`, the comment doesn&#39;t appear in the tooltip. I also tried:

 - `///`
 - [`&lt;summary&gt;&lt;/summary&gt;`][xml] tags
 - Building with [`/doc`][doc] (by setting the &quot;Generate XML documentation files&quot; option in the project settings)

I&#39;ve had no luck so far. Does anyone know a way to make this work?

  [msdn]: http://msdn.microsoft.com/en-us/library/s0we08bk.aspx
  [doc]: http://msdn.microsoft.com/en-us/library/ms173501%28v=VS.90%29.aspx
  [xml]: http://msdn.microsoft.com/en-us/library/ms177226.aspx

How to write C++ comments that show up in Intellisense?

Where should should project documentation (requirements, etc.) be stored in a typical maven project.

None of the directories listed in [Introduction to the Standard Directory Layout][1] page is an obvious candidate.


  [1]: http://maven.apache.org/guides/introduction/introduction-to-the-standard-directory-layout.html

Where should project documentation be stored in a typical maven project

**How to document methods with parameters using Python&#39;s documentation strings?**

**EDIT:** 
[PEP 257][1] gives this example:

    def complex(real=0.0, imag=0.0):
        &quot;&quot;&quot;Form a complex number.

        Keyword arguments:
        real -- the real part (default 0.0)
        imag -- the imaginary part (default 0.0)
   
        &quot;&quot;&quot;
        if imag == 0.0 and real == 0.0: return complex_zero
        ...

Is this the convention used by most Python developers ?

    Keyword arguments:
    &lt;parameter name&gt; -- Definition (default value if any)

I was expecting something a little bit more formal such as 

    def complex(real=0.0, imag=0.0):
        &quot;&quot;&quot;Form a complex number.

        @param: real The real part (default 0.0)
        @param: imag The imaginary part (default 0.0)
   
        &quot;&quot;&quot;
        if imag == 0.0 and real == 0.0: return complex_zero
        ...



**Environment**: Python 2.7.1


  [1]: http://www.python.org/dev/peps/pep-0257/

How to document a method with parameter(s)?

I&#39;m struggling to write readable and easy to understand documentation that describes the multi-tree structure for Array options that are passed to a function.

Here is an example array structure.

    $arr = [
       &#39;fields&#39; =&gt; [
           &#39;title&#39; =&gt; [
               &#39;name&#39;     =&gt; &#39;Document.title&#39;,
               &#39;format&#39;   =&gt; &#39;string&#39;,
               &#39;readonly&#39; =&gt; true
           ]
       ]
    ];

There are many possible options for the above array, but this is used as a parameter to a function that understands that structure.

    function doSomething(array $arr) { ... }

I&#39;d like to document how the array should be structured in PHPDoc, but I&#39;m not sure what the correct approach is.

Here is what I have now.

	/**
	 * Holds configuration settings for each field in a model.
	 * Defining the field options
	 *
	 * array[&#39;fields&#39;] array Defines the feilds to be shown by scaffolding.
	 * array[&#39;fields&#39;][fieldName] array Defines the options for a field, or just enables the field if array is not applied.
	 * array[&#39;fields&#39;][fieldName][&#39;name&#39;] string Overrides the field name (default is the array key)
	 * array[&#39;fields&#39;][fieldName][&#39;model&#39;] string (optional) Overrides the model if the field is a belongsTo assoicated value.
	 * array[&#39;fields&#39;][fieldName][&#39;width&#39;] string Defines the width of the field for paginate views. Examples are &quot;100px&quot; or &quot;auto&quot;
	 * array[&#39;fields&#39;][fieldName][&#39;align&#39;] string Alignment types for paginate views (left, right, center)
	 * array[&#39;fields&#39;][fieldName][&#39;format&#39;] string Formatting options for paginate fields. Options include (&#39;currency&#39;,&#39;nice&#39;,&#39;niceShort&#39;,&#39;timeAgoInWords&#39; or a valid Date() format)
	 * array[&#39;fields&#39;][fieldName][&#39;title&#39;] string Changes the field name shown in views.
	 * array[&#39;fields&#39;][fieldName][&#39;desc&#39;] string The description shown in edit/create views.
	 * array[&#39;fields&#39;][fieldName][&#39;readonly&#39;] boolean True prevents users from changing the value in edit/create forms.
	 * array[&#39;fields&#39;][fieldName][&#39;type&#39;] string Defines the input type used by the Form helper (example &#39;password&#39;)
	 * array[&#39;fields&#39;][fieldName][&#39;options&#39;] array Defines a list of string options for drop down lists.
	 * array[&#39;fields&#39;][fieldName][&#39;editor&#39;] boolean If set to True will show a WYSIWYG editor for this field.
	 * array[&#39;fields&#39;][fieldName][&#39;default&#39;] string The default value for create forms.
	 *
	 * @param array $arr (See above)
	 * @return Object A new editor object.
	 **/

My problem is that when the HTML document is generated, it&#39;s not formatted very nicely. Additionally, I&#39;m not sure the above is clearly explains the array structure.

Is there an alternative approach?

Best way to document Array options in PHPDoc?

Is there a program or workflow to convert `.doc` or `.docx` files to Markdown or similar text? 

PS: Ideally, I would welcome the option that a specific font (e.g. `consolas`) in the MS Word document will be rendered to `text-code: ```....``` `.

Content Type	Original Author	Original Content on Stackoverflow
Question	lucaswxp	View Question on Stackoverflow
Solution 1 - Php	g .	View Answer on Stackoverflow
Solution 2 - Php	RiaD	View Answer on Stackoverflow
Solution 3 - Php	Diego Calero	View Answer on Stackoverflow
Solution 4 - Php	MURATSPLAT	View Answer on Stackoverflow

Should I use @return self, this or the current class?

Php Problem Overview

Php Solutions

Solution 1 - Php

Solution 2 - Php

Solution 3 - Php

Solution 4 - Php

Tag dispatch versus static methods on partially specialised classes

Storing IPv6 Addresses in MySQL

Attributions