Icon cleanup
[civicrm-core.git] / CRM / Core / BAO / Navigation.php
index 8382350686a47ed06b7a83de158066b5915407c7..ec1b4ddefada470dfc9b3053a745cd8fc913c064 100644 (file)
@@ -23,7 +23,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
@@ -38,14 +38,14 @@ class CRM_Core_BAO_Navigation extends CRM_Core_DAO_Navigation {
   const CACHE_KEY_STRLEN = 8;
 
   /**
-   * Class constructor
+   * Class constructor.
    */
   public function __construct() {
     parent::__construct();
   }
 
   /**
-   * Update the is_active flag in the db
+   * Update the is_active flag in the db.
    *
    * @param int $id
    *   Id of the database record.
@@ -55,7 +55,6 @@ class CRM_Core_BAO_Navigation extends CRM_Core_DAO_Navigation {
    * @return Object
    *   DAO object on sucess, NULL otherwise
    *
-   * @static
    */
   public static function setIsActive($id, $is_active) {
     return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_Navigation', $id, 'is_active', $is_active);
@@ -64,7 +63,6 @@ class CRM_Core_BAO_Navigation extends CRM_Core_DAO_Navigation {
   /**
    * Get existing / build navigation for CiviCRM Admin Menu
    *
-   * @static
    * @return array
    *   associated array
    */
@@ -86,11 +84,10 @@ class CRM_Core_BAO_Navigation extends CRM_Core_DAO_Navigation {
   /**
    * Add/update navigation record
    *
-   * @param array associated array of submitted values
+   * @param $params associated array of submitted values
    *
    * @return object
    *   navigation object
-   * @static
    */
   public static function add(&$params) {
     $navigation = new CRM_Core_DAO_Navigation();
@@ -126,7 +123,7 @@ class CRM_Core_BAO_Navigation extends CRM_Core_DAO_Navigation {
   }
 
   /**
-   * Fetch object based on array of properties
+   * Fetch object based on array of properties.
    *
    * @param array $params
    *   (reference ) an assoc array of name/value pairs.
@@ -135,7 +132,6 @@ class CRM_Core_BAO_Navigation extends CRM_Core_DAO_Navigation {
    *
    * @return CRM_Core_BAO_Navigation|null
    *   object on success, NULL otherwise
-   * @static
    */
   public static function retrieve(&$params, &$defaults) {
     $navigation = new CRM_Core_DAO_Navigation();
@@ -151,7 +147,7 @@ class CRM_Core_BAO_Navigation extends CRM_Core_DAO_Navigation {
   }
 
   /**
-   * Calculate navigation weight
+   * Calculate navigation weight.
    *
    * @param int $parentID
    *   Parent_id of a menu.
@@ -160,7 +156,6 @@ class CRM_Core_BAO_Navigation extends CRM_Core_DAO_Navigation {
    *
    * @return int
    *   $weight string
-   * @static
    */
   public static function calculateWeight($parentID = NULL, $menuID = NULL) {
     $domainID = CRM_Core_Config::domainID();
@@ -182,11 +177,10 @@ class CRM_Core_BAO_Navigation extends CRM_Core_DAO_Navigation {
   }
 
   /**
-   * Get formatted menu list
+   * Get formatted menu list.
    *
    * @return array
    *   returns associated array
-   * @static
    */
   public static function getNavigationList() {
     $cacheKeyString = "navigationList";
@@ -269,7 +263,7 @@ FROM civicrm_navigation WHERE domain_id = $domainID {$whereClause} ORDER BY pare
   }
 
   /**
-   * Build navigation tree
+   * Build navigation tree.
    *
    * @param array $navigationTree
    *   Nested array of menus.
@@ -280,7 +274,6 @@ FROM civicrm_navigation WHERE domain_id = $domainID {$whereClause} ORDER BY pare
    *
    * @return array
    *   nested array of menus
-   * @static
    */
   public static function buildNavigationTree(&$navigationTree, $parentID, $navigationMenu = TRUE) {
     $whereClause = " parent_id IS NULL";
@@ -319,7 +312,7 @@ ORDER BY parent_id, weight";
           'parentID' => $navigation->parent_id,
           'navID' => $navigation->id,
           'active' => $navigation->is_active,
-        )
+        ),
       );
       self::buildNavigationTree($navigationTree[$navigation->id]['child'], $navigation->id, $navigationMenu);
     }
@@ -328,7 +321,7 @@ ORDER BY parent_id, weight";
   }
 
   /**
-   * Build menu
+   * Build menu.
    *
    * @param bool $json
    *   By default output is html.
@@ -337,7 +330,6 @@ ORDER BY parent_id, weight";
    *
    * @return string
    *   html or json string
-   * @static
    */
   public static function buildNavigation($json = FALSE, $navigationMenu = TRUE) {
     $navigations = array();
@@ -395,7 +387,7 @@ ORDER BY parent_id, weight";
   }
 
   /**
-   * Recursively check child menus
+   * Recursively check child menus.
    *
    * @param array $value
    * @param string $navigationString
@@ -472,7 +464,7 @@ ORDER BY parent_id, weight";
   }
 
   /**
-   * Get Menu name
+   * Get Menu name.
    *
    * @param $value
    * @param array $skipMenuItems
@@ -501,7 +493,7 @@ ORDER BY parent_id, weight";
     //we need to check core view/edit or supported acls.
     if (in_array($menuName, array(
       'Search...',
-      'Contacts'
+      'Contacts',
     ))) {
       if (!CRM_Core_Permission::giveMeAllACLs()) {
         $skipMenuItems[] = $navID;
@@ -586,14 +578,13 @@ ORDER BY parent_id, weight";
   }
 
   /**
-   * Create navigation for CiviCRM Admin Menu
+   * Create navigation for CiviCRM Admin Menu.
    *
    * @param int $contactID
    *   Contact id.
    *
    * @return string
    *   returns navigation html
-   * @static
    */
   public static function createNavigation($contactID) {
     $config = CRM_Core_Config::singleton();
@@ -608,7 +599,7 @@ ORDER BY parent_id, weight";
       // get home menu from db
       $homeParams = array('name' => 'Home');
       $homeNav = array();
-      $homeIcon = '<img src="' . $config->userFrameworkResourceURL . 'i/logo16px.png" style="vertical-align:middle;" />';
+      $homeIcon = '<span class="crm-logo-sm" ></span>';
       self::retrieve($homeParams, $homeNav);
       if ($homeNav) {
         list($path, $q) = explode('?', $homeNav['url']);
@@ -652,7 +643,7 @@ ORDER BY parent_id, weight";
   }
 
   /**
-   * Reset navigation for all contacts or a specified contact
+   * Reset navigation for all contacts or a specified contact.
    *
    * @param int $contactID
    *   Reset only entries belonging to that contact ID.
@@ -689,13 +680,12 @@ ORDER BY parent_id, weight";
   }
 
   /**
-   * Process navigation
+   * Process navigation.
    *
    * @param array $params
    *   Associated array, $_GET.
    *
    * @return void
-   * @static
    */
   public static function processNavigation(&$params) {
     $nodeID = (int) str_replace("node_", "", $params['id']);
@@ -724,7 +714,7 @@ ORDER BY parent_id, weight";
   }
 
   /**
-   * Process move action
+   * Process move action.
    *
    * @param $nodeID
    *   Node that is being moved.
@@ -734,7 +724,6 @@ ORDER BY parent_id, weight";
    *   New position of the nod, it starts with 0 - n.
    *
    * @return void
-   * @static
    */
   public static function processMove($nodeID, $referenceID, $position) {
     // based on the new position we need to get the weight of the node after moved node
@@ -790,7 +779,7 @@ ORDER BY parent_id, weight";
   }
 
   /**
-   *  Function to process rename action for tree
+   *  Function to process rename action for tree.
    *
    * @param int $nodeID
    * @param $label
@@ -800,7 +789,7 @@ ORDER BY parent_id, weight";
   }
 
   /**
-   * Process delete action for tree
+   * Process delete action for tree.
    *
    * @param int $nodeID
    */
@@ -810,14 +799,13 @@ ORDER BY parent_id, weight";
   }
 
   /**
-   * Get the info on navigation item
+   * Get the info on navigation item.
    *
    * @param int $navigationID
    *   Navigation id.
    *
    * @return array
    *   associated array
-   * @static
    */
   public static function getNavigationInfo($navigationID) {
     $query = "SELECT parent_id, weight FROM civicrm_navigation WHERE id = %1";
@@ -831,12 +819,11 @@ ORDER BY parent_id, weight";
   }
 
   /**
-   * Update menu
+   * Update menu.
    *
    * @param array $params
    * @param array $newParams
    *   New value of params.
-   * @static
    */
   public static function processUpdate($params, $newParams) {
     $dao = new CRM_Core_DAO_Navigation();
@@ -865,4 +852,5 @@ ORDER BY parent_id, weight";
     }
     return $key;
   }
+
 }