Changeset 5766 in subversion

Timestamp:

Jan 13, 2012 4:25:11 AM (17 months ago)

Author:

alec

Message:

• CS fixes on method names in rcube_result_*

Location:

branches/devel-framework/roundcubemail/program

Files:

• include/rcube_imap.php (modified) (19 diffs)
• include/rcube_imap_cache.php (modified) (7 diffs)
• include/rcube_result_index.php (modified) (9 diffs)
• include/rcube_result_thread.php (modified) (21 diffs)
• steps/mail/pagenav.inc (modified) (1 diff)

branches/devel-framework/roundcubemail/program/include/rcube_imap.php

@@ -546 +546 @@
         if ($this->search_string && $folder == $this->folder && ($mode == 'ALL' || $mode == 'THREADS') && !$force) {
             if ($mode == 'ALL') {
-                return $this->search_set->countMessages();
+                return $this->search_set->count_messages();
             }
             else {
@@ -569 +569 @@
 
             if ($status) {
-                $msg_count = $res->countMessages();
+                $msg_count = $res->count_messages();
                 $this->set_folder_stats($folder, 'cnt', $msg_count);
                 $this->set_folder_stats($folder, 'maxuid', $msg_count ? $this->id2uid($msg_count, $folder) : 0);
@@ -692 +692 @@
         $index = $this->index($folder, $this->sort_field, $this->sort_order);
 
-        if ($index->isEmpty()) {
+        if ($index->is_empty()) {
             return array();
         }
@@ -820 +820 @@
         $parents = array();
 
-        list ($msg_depth, $msg_children) = $threads->getThreadData();
+        list ($msg_depth, $msg_children) = $threads->get_thread_data();
 
         foreach ($headers as $uid => $header) {
@@ -850 +850 @@
     protected function list_search_messages($folder, $page, $slice=0)
     {
-        if (!strlen($folder) || empty($this->search_set) || $this->search_set->isEmpty()) {
+        if (!strlen($folder) || empty($this->search_set) || $this->search_set->is_empty()) {
             return array();
         }
@@ -869 +869 @@
 
         // return empty array if no messages found
-        if ($index->isEmpty()) {
+        if ($index->is_empty()) {
             return array();
         }
@@ -887 +887 @@
 
                 // return empty array if no messages found
-                if ($index->isEmpty()) {
+                if ($index->is_empty()) {
                     return array();
                 }
@@ -894 +894 @@
 
         if ($got_index) {
-            if ($this->sort_order != $index->getParameters('ORDER')) {
+            if ($this->sort_order != $index->get_parameters('ORDER')) {
                 $index->revert();
             }
@@ -977 +977 @@
         // update search_set if previous data was fetched with disabled threading
         if (!$this->search_threads) {
-            if ($this->search_set->isEmpty()) {
+            if ($this->search_set->is_empty()) {
                 return array();
             }
@@ -1151 +1151 @@
             }
 
-            if ($this->sort_order != $index->getParameters('ORDER')) {
+            if ($this->sort_order != $index->get_parameters('ORDER')) {
                 $index->revert();
             }
@@ -1191 +1191 @@
         else if (!$sort_field) {
             if ($this->options['skip_deleted'] && !empty($this->icache['undeleted_idx'])
-                && $this->icache['undeleted_idx']->getParameters('MAILBOX') == $folder
+                && $this->icache['undeleted_idx']->get_parameters('MAILBOX') == $folder
             ) {
                 $index = $this->icache['undeleted_idx'];
@@ -1213 +1213 @@
             }
 
-            if (empty($index) || $index->isError()) {
+            if (empty($index) || $index->is_error()) {
                 $index = $this->conn->index($folder, "1:*", $sort_field,
                     $this->options['skip_deleted'], false, true);
@@ -1219 +1219 @@
         }
 
-        if ($sort_order != $index->getParameters('ORDER')) {
+        if ($sort_order != $index->get_parameters('ORDER')) {
             $index->revert();
         }
@@ -1265 +1265 @@
     protected function sort_threads($threads)
     {
-        if ($threads->isEmpty()) {
+        if ($threads->is_empty()) {
             return;
         }
@@ -1276 +1276 @@
             $index = $this->index_direct($this->folder, $this->sort_field, $this->sort_order, false);
 
-            if (!$index->isEmpty()) {
+            if (!$index->is_empty()) {
                 $threads->sort($index);
             }
         }
         else {
-            if ($this->sort_order != $threads->getParameters('ORDER')) {
+            if ($this->sort_order != $threads->get_parameters('ORDER')) {
                 $threads->revert();
             }
@@ -1376 +1376 @@
             // Error, try with US-ASCII (RFC5256: SORT/THREAD must support US-ASCII and UTF-8,
             // but I've seen that Courier doesn't support UTF-8)
-            if ($threads->isError() && $charset && $charset != 'US-ASCII') {
+            if ($threads->is_error() && $charset && $charset != 'US-ASCII') {
                 $threads = $this->conn->thread($folder, $this->threading,
                     $this->convert_criteria($criteria, $charset), true, 'US-ASCII');
@@ -1390 +1390 @@
             // Error, try with US-ASCII (RFC5256: SORT/THREAD must support US-ASCII and UTF-8,
             // but I've seen Courier with disabled UTF-8 support)
-            if ($messages->isError() && $charset && $charset != 'US-ASCII') {
+            if ($messages->is_error() && $charset && $charset != 'US-ASCII') {
                 $messages = $this->conn->sort($folder, $sort_field,
                     $this->convert_criteria($criteria, $charset), true, 'US-ASCII');
             }
 
-            if (!$messages->isError()) {
+            if (!$messages->is_error()) {
                 $this->search_sorted = true;
                 return $messages;
@@ -1405 +1405 @@
 
         // Error, try with US-ASCII (some servers may support only US-ASCII)
-        if ($messages->isError() && $charset && $charset != 'US-ASCII') {
+        if ($messages->is_error() && $charset && $charset != 'US-ASCII') {
             $messages = $this->conn->search($folder,
                 $this->convert_criteria($criteria, $charset), true);
@@ -3097 +3097 @@
         // add (E)SEARCH result for ALL UNDELETED query
         if (!empty($this->icache['undeleted_idx'])
-            && $this->icache['undeleted_idx']->getParameters('MAILBOX') == $folder
+            && $this->icache['undeleted_idx']->get_parameters('MAILBOX') == $folder
         ) {
             $data['UNDELETED'] = $this->icache['undeleted_idx'];

branches/devel-framework/roundcubemail/program/include/rcube_imap_cache.php

@@ -136 +136 @@
             else if ($sort_field == 'ANY' || $this->icache[$mailbox]['index']['sort_field'] == $sort_field) {
                 $result = $this->icache[$mailbox]['index']['object'];
-                if ($result->getParameters('ORDER') != $sort_order) {
+                if ($result->get_parameters('ORDER') != $sort_order) {
                     $result->revert();
                 }
@@ -179 +179 @@
                 $data = $index['object'];
                 // revert the order if needed
-                if ($data->getParameters('ORDER') != $sort_order) {
+                if ($data->get_parameters('ORDER') != $sort_order) {
                     $data->revert();
                 }
@@ -758 +758 @@
         // Folder is empty but cache isn't
         if (empty($mbox_data['EXISTS'])) {
-            if (!$object->isEmpty()) {
+            if (!$object->is_empty()) {
                 $this->clear($mailbox);
                 $exists = false;
@@ -765 +765 @@
         }
         // Folder is not empty but cache is
-        else if ($object->isEmpty()) {
+        else if ($object->is_empty()) {
             unset($this->icache[$mailbox][$is_thread ? 'thread' : 'index']);
             return false;
@@ -797 +797 @@
         if ($is_thread) {
             // check messages number...
-            if (!$this->skip_deleted && $mbox_data['EXISTS'] != $object->countMessages()) {
+            if (!$this->skip_deleted && $mbox_data['EXISTS'] != $object->count_messages()) {
                 return false;
             }
@@ -831 +831 @@
                     rcube_imap_generic::compressMessageSet($object->get()));
 
-                if (!$ids->isEmpty()) {
+                if (!$ids->is_empty()) {
                     return false;
                 }
@@ -1009 +1009 @@
 
         $sort_field = $index['sort_field'];
-        $sort_order = $index['object']->getParameters('ORDER');
+        $sort_order = $index['object']->get_parameters('ORDER');
         $exists     = true;
 

branches/devel-framework/roundcubemail/program/include/rcube_result_index.php

@@ -28 +28 @@
 class rcube_result_index
 {
-    private $raw_data;
-    private $mailbox;
-    private $meta = array();
-    private $params = array();
-    private $order = 'ASC';
+    protected $raw_data;
+    protected $mailbox;
+    protected $meta = array();
+    protected $params = array();
+    protected $order = 'ASC';
 
     const SEPARATOR_ELEMENT = ' ';
@@ -127 +127 @@
      * @return bool True if the result is an error, False otherwise
      */
-    public function isError()
+    public function is_error()
     {
         return $this->raw_data === null ? true : false;
@@ -138 +138 @@
      * @return bool True if the result is empty, False otherwise
      */
-    public function isEmpty()
+    public function is_empty()
     {
         return empty($this->raw_data) ? true : false;
@@ -172 +172 @@
      * @return int Number of elements
      */
-    public function countMessages()
+    public function count_messages()
     {
         return $this->count();
@@ -306 +306 @@
                     $idx = 1 + substr_count($this->raw_data, self::SEPARATOR_ELEMENT, 0, $m[0][1]);
                 }
-                // cache position of this element, so we can use it in getElement()
+                // cache position of this element, so we can use it in get_element()
                 $this->meta['pos'][$idx] = (int)$m[0][1];
 
@@ -337 +337 @@
      * @return array List of message IDs
      */
-    public function getCompressed()
+    public function get_compressed()
     {
         if (empty($this->raw_data)) {
@@ -354 +354 @@
      * @return int Element value
      */
-    public function getElement($index)
+    public function get_element($index)
     {
         $count = $this->count();
@@ -415 +415 @@
      * @return array|string Response parameters or parameter value
      */
-    public function getParameters($param=null)
+    public function get_parameters($param=null)
     {
         $params = $this->params;
@@ -434 +434 @@
      * @return int Data length
      */
-    private function length()
+    protected function length()
     {
         if (!isset($this->meta['length'])) {

branches/devel-framework/roundcubemail/program/include/rcube_result_thread.php

@@ -28 +28 @@
 class rcube_result_thread
 {
-    private $raw_data;
-    private $mailbox;
-    private $meta = array();
-    private $order = 'ASC';
+    protected $raw_data;
+    protected $mailbox;
+    protected $meta = array();
+    protected $order = 'ASC';
 
     const SEPARATOR_ELEMENT = ' ';
@@ -78 +78 @@
         $data = preg_replace('/\s+/', ' ', $data);
 
-        $this->raw_data = $this->parseThread($data);
+        $this->raw_data = $this->parse_thread($data);
     }
 
@@ -87 +87 @@
      * @return bool True if the result is an error, False otherwise
      */
-    public function isError()
+    public function is_error()
     {
         return $this->raw_data === null ? true : false;
@@ -98 +98 @@
      * @return bool True if the result is empty, False otherwise
      */
-    public function isEmpty()
+    public function is_empty()
     {
         return empty($this->raw_data) ? true : false;
@@ -133 +133 @@
      * @return int Number of elements
      */
-    public function countMessages()
+    public function count_messages()
     {
         if ($this->meta['messages'] !== null)
@@ -301 +301 @@
                         + substr_count($this->raw_data, self::SEPARATOR_ITEM, 0, $m[0][1]+1);
                 }
-                // cache position of this element, so we can use it in getElement()
+                // cache position of this element, so we can use it in get_element()
                 $this->meta['pos'][$idx] = (int)$m[0][1];
 
@@ -337 +337 @@
      * @return array List of message identifiers
      */
-    public function getCompressed()
+    public function get_compressed()
     {
         if (empty($this->raw_data)) {
@@ -354 +354 @@
      * @return int Element value
      */
-    public function getElement($index)
+    public function get_element($index)
     {
         $count = $this->count();
@@ -424 +424 @@
      * @return array|string Response parameters or parameter value
      */
-    public function getParameters($param=null)
+    public function get_parameters($param=null)
     {
         $params = $this->params;
@@ -445 +445 @@
     public function sort($index)
     {
-        $this->sort_order = $index->getParameters('ORDER');
+        $this->sort_order = $index->get_parameters('ORDER');
 
         if (empty($this->raw_data)) {
@@ -452 +452 @@
 
         // when sorting search result it's good to make the index smaller
-        if ($index->count() != $this->countMessages()) {
+        if ($index->count() != $this->count_messages()) {
             $index->intersect($this->get());
         }
@@ -511 +511 @@
      * @return array Data tree
      */
-    public function getTree()
+    public function get_tree()
     {
         $datalen = strlen($this->raw_data);
@@ -523 +523 @@
             $elem  = substr($this->raw_data, $start, $len);
             $items = explode(self::SEPARATOR_ITEM, $elem);
-            $result[array_shift($items)] = $this->buildThread($items);
+            $result[array_shift($items)] = $this->build_thread($items);
             $start = $pos + 1;
         }
@@ -536 +536 @@
      * @return array Thread data
      */
-    public function getThreadData()
-    {
-        $data     = $this->getTree();
+    public function get_thread_data()
+    {
+        $data     = $this->get_tree();
         $depth    = array();
         $children = array();
 
-        $this->buildThreadData($data, $depth, $children);
+        $this->build_thread_data($data, $depth, $children);
 
         return array($depth, $children);
@@ -551 +551 @@
      * Creates 'depth' and 'children' arrays from stored thread 'tree' data.
      */
-    private function buildThreadData($data, &$depth, &$children, $level = 0)
+    protected function build_thread_data($data, &$depth, &$children, $level = 0)
     {
         foreach ((array)$data as $key => $val) {
@@ -557 +557 @@
             $depth[$key] = $level;
             if (!empty($val))
-                $this->buildThreadData($val, $depth, $children, $level + 1);
+                $this->build_thread_data($val, $depth, $children, $level + 1);
         }
     }
@@ -565 +565 @@
      * Converts part of the raw thread into an array
      */
-    private function buildThread($items, $level = 1, &$pos = 0)
+    protected function build_thread($items, $level = 1, &$pos = 0)
     {
         $result = array();
@@ -573 +573 @@
             if ($level == $lv) {
                 $pos++;
-                $result[$id] = $this->buildThread($items, $level+1, $pos);
+                $result[$id] = $this->build_thread($items, $level+1, $pos);
             }
             else {
@@ -588 +588 @@
      * IMAP THREAD response parser
      */
-    private function parseThread($str, $begin = 0, $end = 0, $depth = 0)
+    protected function parse_thread($str, $begin = 0, $end = 0, $depth = 0)
     {
         // Don't be tempted to change $str to pass by reference to speed this up - it will slow it down by about
@@ -626 +626 @@
 
             if ($stop + 1 < $end) {
-                $node .= $this->parseThread($str, $stop + 1, $end, $depth + 1);
+                $node .= $this->parse_thread($str, $stop + 1, $end, $depth + 1);
             }
         } else {
@@ -651 +651 @@
                 }
 
-                $thread = $this->parseThread($str, $start + 1, $off - 1, $depth);
+                $thread = $this->parse_thread($str, $start + 1, $off - 1, $depth);
                 if ($thread) {
                     if (!$depth) {

branches/devel-framework/roundcubemail/program/steps/mail/pagenav.inc

@@ -22 +22 @@
 $uid   = get_input_value('_uid', RCUBE_INPUT_GET);
 $index = $RCMAIL->storage->index(null, $_SESSION['sort_col'], $_SESSION['sort_order']);
-$cnt   = $index->countMessages();
+$cnt   = $index->count_messages();
 
 if ($cnt && ($pos = $index->exists($uid, true)) !== false) {
-    $prev  = $pos ? $index->getElement($pos-1) : 0;
-    $first = $pos ? $index->getElement('FIRST') : 0;
-    $next  = $pos < $cnt-1 ? $index->getElement($pos+1) : 0;
-    $last  = $pos < $cnt-1 ? $index->getElement('LAST') : 0;
+    $prev  = $pos ? $index->get_element($pos-1) : 0;
+    $first = $pos ? $index->get_element('FIRST') : 0;
+    $next  = $pos < $cnt-1 ? $index->get_element($pos+1) : 0;
+    $last  = $pos < $cnt-1 ? $index->get_element('LAST') : 0;
 }