Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

update for Issue #2064 - take 2 #2077

Merged
merged 1 commit into from

2 participants

Andrew Podner Andrey Andreev
Andrew Podner

This should clean up issue 2064 throughout the system folder.

changed docblocks which return $this or only call a method that returns $this to @return CI_DB_class_name

(looks like 832 in form_validation.php was some whitespace that got clipped)

Andrey Andreev narfbg merged commit fc7024e into from
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Dec 17, 2012
  1. Andrew Podner

    update for Issue #2064 (changed docblocks which return $this or only …

    AndrewPodner authored
    …call a method that returns $this to @return CI_DB_class_name)
This page is out of date. Refresh to see the latest.
16 system/core/Output.php
View
@@ -143,7 +143,7 @@ public function get_output()
* Sets the output string.
*
* @param string $output Output data
- * @return object $this
+ * @return CI_Output
*/
public function set_output($output)
{
@@ -159,7 +159,7 @@ public function set_output($output)
* Appends data onto the output string.
*
* @param string $output Data to append
- * @return object $this
+ * @return CI_Output
*/
public function append_output($output)
{
@@ -187,7 +187,7 @@ public function append_output($output)
*
* @param string $header Header
* @param bool $replace Whether to replace the old header value, if already set
- * @return object $this
+ * @return CI_Output
*/
public function set_header($header, $replace = TRUE)
{
@@ -211,7 +211,7 @@ public function set_header($header, $replace = TRUE)
*
* @param string $mime_type Extension of the file we're outputting
* @param string $charset Character set (default: NULL)
- * @return object $this
+ * @return CI_Output
*/
public function set_content_type($mime_type, $charset = NULL)
{
@@ -308,7 +308,7 @@ public function get_header($header)
*
* @param int $code Status code (default: 200)
* @param string $text Optional message
- * @return object $this
+ * @return CI_Output
*/
public function set_status_header($code = 200, $text = '')
{
@@ -322,7 +322,7 @@ public function set_status_header($code = 200, $text = '')
* Enable/disable Profiler
*
* @param bool $val TRUE to enable or FALSE to disable
- * @return object $this
+ * @return CI_Output
*/
public function enable_profiler($val = TRUE)
{
@@ -339,7 +339,7 @@ public function enable_profiler($val = TRUE)
* Profiler section display.
*
* @param array $sections Profiler sections
- * @return object $this
+ * @return CI_Output
*/
public function set_profiler_sections($sections)
{
@@ -363,7 +363,7 @@ public function set_profiler_sections($sections)
* Set Cache
*
* @param int $time Cache expiration time in seconds
- * @return object $this
+ * @return CI_Output
*/
public function cache($time)
{
4 system/core/Security.php
View
@@ -151,7 +151,7 @@ public function __construct()
/**
* CSRF Verify
*
- * @return object
+ * @return CI_Security
*/
public function csrf_verify()
{
@@ -202,7 +202,7 @@ public function csrf_verify()
* CSRF Set Cookie
*
* @codeCoverageIgnore
- * @return object
+ * @return CI_Security
*/
public function csrf_set_cookie()
{
4 system/database/DB_forge.php
View
@@ -229,7 +229,7 @@ public function drop_database($db_name)
*
* @param string $key
* @param bool $primary
- * @return object
+ * @return CI_DB_forge
*/
public function add_key($key = '', $primary = FALSE)
{
@@ -266,7 +266,7 @@ public function add_key($key = '', $primary = FALSE)
* Add Field
*
* @param array $field
- * @return object
+ * @return CI_DB_forge
*/
public function add_field($field = '')
{
68 system/database/DB_query_builder.php
View
@@ -254,7 +254,7 @@
*
* @param string
* @param mixed
- * @return object
+ * @return CI_DB_query_builder
*/
public function select($select = '*', $escape = NULL)
{
@@ -296,7 +296,7 @@ public function select($select = '*', $escape = NULL)
*
* @param string the field
* @param string an alias
- * @return object
+ * @return CI_DB_query_builder
*/
public function select_max($select = '', $alias = '')
{
@@ -312,7 +312,7 @@ public function select_max($select = '', $alias = '')
*
* @param string the field
* @param string an alias
- * @return object
+ * @return CI_DB_query_builder
*/
public function select_min($select = '', $alias = '')
{
@@ -328,7 +328,7 @@ public function select_min($select = '', $alias = '')
*
* @param string the field
* @param string an alias
- * @return object
+ * @return CI_DB_query_builder
*/
public function select_avg($select = '', $alias = '')
{
@@ -344,7 +344,7 @@ public function select_avg($select = '', $alias = '')
*
* @param string the field
* @param string an alias
- * @return object
+ * @return CI_DB_query_builder
*/
public function select_sum($select = '', $alias = '')
{
@@ -364,7 +364,7 @@ public function select_sum($select = '', $alias = '')
* @param string $select Field name
* @param string $alias
* @param string $type
- * @return object
+ * @return CI_DB_query_builder
*/
protected function _max_min_avg_sum($select = '', $alias = '', $type = 'MAX')
{
@@ -426,7 +426,7 @@ protected function _create_alias_from_table($item)
* Sets a flag which tells the query string compiler to add DISTINCT
*
* @param bool $val
- * @return object
+ * @return CI_DB_query_builder
*/
public function distinct($val = TRUE)
{
@@ -442,7 +442,7 @@ public function distinct($val = TRUE)
* Generates the FROM portion of the query
*
* @param mixed $from can be a string or array
- * @return object
+ * @return CI_DB_query_builder
*/
public function from($from)
{
@@ -496,7 +496,7 @@ public function from($from)
* @param string the join condition
* @param string the type of join
* @param string whether not to try to escape identifiers
- * @return object
+ * @return CI_DB_query_builder
*/
public function join($table, $cond, $type = '', $escape = NULL)
{
@@ -584,7 +584,7 @@ public function join($table, $cond, $type = '', $escape = NULL)
* @param mixed
* @param mixed
* @param bool
- * @return object
+ * @return CI_DB_query_builder
*/
public function where($key, $value = NULL, $escape = NULL)
{
@@ -602,7 +602,7 @@ public function where($key, $value = NULL, $escape = NULL)
* @param mixed
* @param mixed
* @param bool
- * @return object
+ * @return CI_DB_query_builder
*/
public function or_where($key, $value = NULL, $escape = NULL)
{
@@ -624,7 +624,7 @@ public function or_where($key, $value = NULL, $escape = NULL)
* @param mixed $value
* @param string $type
* @param bool $escape
- * @return object
+ * @return CI_DB_query_builder
*/
protected function _wh($qb_key, $key, $value = NULL, $type = 'AND ', $escape = NULL)
{
@@ -685,7 +685,7 @@ protected function _wh($qb_key, $key, $value = NULL, $type = 'AND ', $escape = N
* @param string $key The field to search
* @param array $values The values searched on
* @param bool $escape
- * @return object
+ * @return CI_DB_query_builder
*/
public function where_in($key = NULL, $values = NULL, $escape = NULL)
{
@@ -703,7 +703,7 @@ public function where_in($key = NULL, $values = NULL, $escape = NULL)
* @param string $key The field to search
* @param array $values The values searched on
* @param bool $escape
- * @return object
+ * @return CI_DB_query_builder
*/
public function or_where_in($key = NULL, $values = NULL, $escape = NULL)
{
@@ -721,7 +721,7 @@ public function or_where_in($key = NULL, $values = NULL, $escape = NULL)
* @param string $key The field to search
* @param array $values The values searched on
* @param bool $escape
- * @return object
+ * @return CI_DB_query_builder
*/
public function where_not_in($key = NULL, $values = NULL, $escape = NULL)
{
@@ -739,7 +739,7 @@ public function where_not_in($key = NULL, $values = NULL, $escape = NULL)
* @param string $key The field to search
* @param array $values The values searched on
* @param bool $escape
- * @return object
+ * @return CI_DB_query_builder
*/
public function or_where_not_in($key = NULL, $values = NULL, $escape = NULL)
{
@@ -761,7 +761,7 @@ public function or_where_not_in($key = NULL, $values = NULL, $escape = NULL)
* @param bool $not If the statement would be IN or NOT IN
* @param string $type
* @param bool $escape
- * @return object
+ * @return CI_DB_query_builder
*/
protected function _where_in($key = NULL, $values = NULL, $not = FALSE, $type = 'AND ', $escape = NULL)
{
@@ -813,7 +813,7 @@ protected function _where_in($key = NULL, $values = NULL, $not = FALSE, $type =
* @param string $match
* @param string $side
* @param bool $escape
- * @return object
+ * @return CI_DB_query_builder
*/
public function like($field, $match = '', $side = 'both', $escape = NULL)
{
@@ -832,7 +832,7 @@ public function like($field, $match = '', $side = 'both', $escape = NULL)
* @param string $match
* @param string $side
* @param bool $escape
- * @return object
+ * @return CI_DB_query_builder
*/
public function not_like($field, $match = '', $side = 'both', $escape = NULL)
{
@@ -851,7 +851,7 @@ public function not_like($field, $match = '', $side = 'both', $escape = NULL)
* @param string $match
* @param string $side
* @param bool $escape
- * @return object
+ * @return CI_DB_query_builder
*/
public function or_like($field, $match = '', $side = 'both', $escape = NULL)
{
@@ -870,7 +870,7 @@ public function or_like($field, $match = '', $side = 'both', $escape = NULL)
* @param string $match
* @param string $side
* @param bool $escape
- * @return object
+ * @return CI_DB_query_builder
*/
public function or_not_like($field, $match = '', $side = 'both', $escape = NULL)
{
@@ -893,7 +893,7 @@ public function or_not_like($field, $match = '', $side = 'both', $escape = NULL)
* @param string $side
* @param string $not
* @param bool $escape
- * @return object
+ * @return CI_DB_query_builder
*/
protected function _like($field, $match = '', $type = 'AND ', $side = 'both', $not = '', $escape = NULL)
{
@@ -952,7 +952,7 @@ protected function _like($field, $match = '', $type = 'AND ', $side = 'both', $n
*
* @param string $not (Internal use only)
* @param string $type (Internal use only)
- * @return object
+ * @return CI_DB_query_builder
*/
public function group_start($not = '', $type = 'AND ')
{
@@ -979,7 +979,7 @@ public function group_start($not = '', $type = 'AND ')
/**
* Starts a query group, but ORs the group
*
- * @return object
+ * @return CI_DB_query_builder
*/
public function or_group_start()
{
@@ -991,7 +991,7 @@ public function or_group_start()
/**
* Starts a query group, but NOTs the group
*
- * @return object
+ * @return CI_DB_query_builder
*/
public function not_group_start()
{
@@ -1003,7 +1003,7 @@ public function not_group_start()
/**
* Starts a query group, but OR NOTs the group
*
- * @return object
+ * @return CI_DB_query_builder
*/
public function or_not_group_start()
{
@@ -1015,7 +1015,7 @@ public function or_not_group_start()
/**
* Ends a query group
*
- * @return object
+ * @return CI_DB_query_builder
*/
public function group_end()
{
@@ -1065,7 +1065,7 @@ protected function _group_get_type($type)
*
* @param string $by
* @param bool $escape
- * @return object
+ * @return CI_DB_query_builder
*/
public function group_by($by, $escape = NULL)
{
@@ -1140,7 +1140,7 @@ public function or_having($key, $value = NULL, $escape = NULL)
* @param string $orderby
* @param string $direction ASC or DESC
* @param bool $escape
- * @return object
+ * @return CI_DB_query_builder
*/
public function order_by($orderby, $direction = '', $escape = NULL)
{
@@ -1198,7 +1198,7 @@ public function order_by($orderby, $direction = '', $escape = NULL)
*
* @param int $value LIMIT value
* @param int $offset OFFSET value
- * @return object
+ * @return CI_DB_query_builder
*/
public function limit($value, $offset = FALSE)
{
@@ -1214,7 +1214,7 @@ public function limit($value, $offset = FALSE)
* Sets the OFFSET value
*
* @param int $offset OFFSET value
- * @return object
+ * @return CI_DB_query_builder
*/
public function offset($offset)
{
@@ -1247,7 +1247,7 @@ protected function _limit($sql)
* @param mixed
* @param string
* @param bool
- * @return object
+ * @return CI_DB_query_builder
*/
public function set($key, $value = '', $escape = NULL)
{
@@ -1469,7 +1469,7 @@ protected function _insert_batch($table, $keys, $values)
* @param mixed
* @param string
* @param bool
- * @return object
+ * @return CI_DB_query_builder
*/
public function set_insert_batch($key, $value = '', $escape = NULL)
{
@@ -1860,7 +1860,7 @@ public function update_batch($table = '', $set = NULL, $index = NULL)
* @param array
* @param string
* @param bool
- * @return object
+ * @return CI_DB_query_builder
*/
public function set_update_batch($key, $index = '', $escape = NULL)
{
34 system/libraries/Email.php
View
@@ -406,7 +406,7 @@ public function __construct($config = array())
* Initialize preferences
*
* @param array
- * @return void
+ * @return CI_Email
*/
public function initialize($config = array())
{
@@ -440,7 +440,7 @@ public function initialize($config = array())
* Initialize the Email Data
*
* @param bool
- * @return object
+ * @return CI_Email
*/
public function clear($clear_attachments = FALSE)
{
@@ -474,7 +474,7 @@ public function clear($clear_attachments = FALSE)
* @param string $from
* @param string $name
* @param string $return_path = NULL Return-Path
- * @return object
+ * @return CI_Email
*/
public function from($from, $name = '', $return_path = NULL)
{
@@ -522,7 +522,7 @@ public function from($from, $name = '', $return_path = NULL)
*
* @param string
* @param string
- * @return object
+ * @return CI_Email
*/
public function reply_to($replyto, $name = '')
{
@@ -558,7 +558,7 @@ public function reply_to($replyto, $name = '')
* Set Recipients
*
* @param string
- * @return object
+ * @return CI_Email
*/
public function to($to)
{
@@ -586,7 +586,7 @@ public function to($to)
* Set CC
*
* @param string
- * @return object
+ * @return CI_Email
*/
public function cc($cc)
{
@@ -614,7 +614,7 @@ public function cc($cc)
*
* @param string
* @param string
- * @return object
+ * @return CI_Email
*/
public function bcc($bcc, $limit = '')
{
@@ -649,7 +649,7 @@ public function bcc($bcc, $limit = '')
* Set Email Subject
*
* @param string
- * @return object
+ * @return CI_Email
*/
public function subject($subject)
{
@@ -664,7 +664,7 @@ public function subject($subject)
* Set Body
*
* @param string
- * @return object
+ * @return CI_Email
*/
public function message($body)
{
@@ -693,7 +693,7 @@ public function message($body)
* @param string $disposition = 'attachment'
* @param string $newname = NULL
* @param string $mime = ''
- * @return object
+ * @return CI_Email
*/
public function attach($filename, $disposition = '', $newname = NULL, $mime = '')
{
@@ -746,7 +746,7 @@ protected function _str_to_array($email)
* Set Multipart Value
*
* @param string
- * @return object
+ * @return CI_Email
*/
public function set_alt_message($str = '')
{
@@ -760,7 +760,7 @@ public function set_alt_message($str = '')
* Set Mailtype
*
* @param string
- * @return object
+ * @return CI_Email
*/
public function set_mailtype($type = 'text')
{
@@ -774,7 +774,7 @@ public function set_mailtype($type = 'text')
* Set Wordwrap
*
* @param bool
- * @return object
+ * @return CI_Email
*/
public function set_wordwrap($wordwrap = TRUE)
{
@@ -788,7 +788,7 @@ public function set_wordwrap($wordwrap = TRUE)
* Set Protocol
*
* @param string
- * @return object
+ * @return CI_Email
*/
public function set_protocol($protocol = 'mail')
{
@@ -802,7 +802,7 @@ public function set_protocol($protocol = 'mail')
* Set Priority
*
* @param int
- * @return object
+ * @return CI_Email
*/
public function set_priority($n = 3)
{
@@ -816,7 +816,7 @@ public function set_priority($n = 3)
* Set Newline Character
*
* @param string
- * @return object
+ * @return CI_Email
*/
public function set_newline($newline = "\n")
{
@@ -830,7 +830,7 @@ public function set_newline($newline = "\n")
* Set CRLF
*
* @param string
- * @return object
+ * @return CI_Email
*/
public function set_crlf($crlf = "\n")
{
6 system/libraries/Encrypt.php
View
@@ -122,7 +122,7 @@ public function get_key($key = '')
* Set the encryption key
*
* @param string
- * @return object
+ * @return CI_Encrypt
*/
public function set_key($key = '')
{
@@ -419,7 +419,7 @@ protected function _remove_cipher_noise($data, $key)
* Set the Mcrypt Cipher
*
* @param int
- * @return object
+ * @return CI_Encrypt
*/
public function set_cipher($cipher)
{
@@ -433,7 +433,7 @@ public function set_cipher($cipher)
* Set the Mcrypt Mode
*
* @param int
- * @return object
+ * @return CI_Encrypt
*/
public function set_mode($mode)
{
8 system/libraries/Form_validation.php
View
@@ -149,7 +149,7 @@ public function __construct($rules = array())
* @param mixed $field
* @param string $label
* @param mixed $rules
- * @return object
+ * @return CI_Form_validation
*/
public function set_rules($field, $label = '', $rules = '')
{
@@ -266,7 +266,7 @@ public function set_data($data = '')
*
* @param array
* @param string
- * @return object
+ * @return CI_Form_validation
*/
public function set_message($lang, $val = '')
{
@@ -288,7 +288,7 @@ public function set_message($lang, $val = '')
*
* @param string
* @param string
- * @return object
+ * @return CI_Form_validation
*/
public function set_error_delimiters($prefix = '<p>', $suffix = '</p>')
{
@@ -829,7 +829,7 @@ protected function _build_error_msg($line, $field = '', $param = '')
{
return sprintf($line, $field, $param);
}
-
+
return str_replace(array('{field}', '{param}'), array($field, $param), $line);
}
2  system/libraries/Zip.php
View
@@ -438,7 +438,7 @@ public function download($filename = 'backup.zip')
* Lets you clear current zip data. Useful if you need to create
* multiple zips with different data.
*
- * @return object
+ * @return CI_Zip
*/
public function clear_data()
{
Something went wrong with that request. Please try again.