Search code examples
phpdoc

PHPDoc return type for MySQL Resource

What is convenient name return type for MySQL resource in PHPDoc?

example i have this code

/**
 * Get table data
 * @param type $table
 * @param type $select
 * @param type $condition
 * @return mysql_resource
 */
function getResource($table, $field, $condition) {
    $resource = mysql_query("SELECT $field FROM $table WHERE $condition ");
    return $resource;
}

as you can see @return i write mysql_resource,
is there any convenient name for return mysql resource?

Solution

  • This is typically handled by just "@return resource"... I believe just "resource" matches how var_dump() would show as the object's datatype.