Merge pull request #4962 from totten/master-angular-ts
[civicrm-core.git] / CRM / Core / BAO / Block.php
index 72043e6528c60111baee7c954c87dd429fe54781..716394ec4ba293e333a0ef915aab0f31b92fbd33 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        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
@@ -57,8 +57,7 @@ class CRM_Core_BAO_Block {
    *   Input parameters to find object.
    *
    * @return array
-   *   of $block objects.
-   * @static
+   *   Array of $block objects.
    */
   public static function &getValues($blockName, $params) {
     if (empty($params)) {
@@ -104,8 +103,7 @@ class CRM_Core_BAO_Block {
    *   Name of the above object.
    *
    * @return array
-   *   of $block objects.
-   * @static
+   *   Array of $block objects.
    */
   public static function retrieveBlock(&$block, $blockName) {
     // we first get the primary location due to the order by clause
@@ -135,9 +133,8 @@ class CRM_Core_BAO_Block {
    * @param array $params
    *   Associated array of submitted fields.
    *
-   * @return boolean
+   * @return bool
    *   true if the block has data, otherwise false
-   * @static
    */
   public static function dataExists($blockFields, &$params) {
     foreach ($blockFields as $field) {
@@ -156,9 +153,8 @@ class CRM_Core_BAO_Block {
    * @param array $params
    *   Associated array of submitted fields.
    *
-   * @return boolean
+   * @return bool
    *   true if the block exits, otherwise false
-   * @static
    */
   public static function blockExists($blockName, &$params) {
     // return if no data present
@@ -183,7 +179,6 @@ class CRM_Core_BAO_Block {
    * @return array
    *   formatted array of block ids
    *
-   * @static
    */
   public static function getBlockIds($blockName, $contactId = NULL, $entityElements = NULL, $updateBlankLocInfo = FALSE) {
     $allBlocks = array();
@@ -226,7 +221,6 @@ class CRM_Core_BAO_Block {
    *
    * @return object
    *   CRM_Core_BAO_Block object on success, null otherwise
-   * @static
    */
   public static function create($blockName, &$params, $entity = NULL, $contactId = NULL) {
     if (!self::blockExists($blockName, $params)) {
@@ -406,7 +400,6 @@ class CRM_Core_BAO_Block {
    *   Associates array.
    *
    * @return void
-   * @static
    */
   public static function blockDelete($blockName, $params) {
     $name = ucfirst($blockName);
@@ -421,9 +414,8 @@ class CRM_Core_BAO_Block {
     $block = new $baoString();
 
     $block->copyValues($params);
-    /*
-     * CRM-11006 add call to pre and post hook for delete action
-     */
+
+    // CRM-11006 add call to pre and post hook for delete action
     CRM_Utils_Hook::pre('delete', $name, $block->id, CRM_Core_DAO::$_nullArray);
     $block->delete();
     CRM_Utils_Hook::post('delete', $name, $block->id, $block);
@@ -447,7 +439,6 @@ class CRM_Core_BAO_Block {
    * @param $class
    *
    * @throws API_Exception
-   * @static
    */
   public static function handlePrimary(&$params, $class) {
     $table = CRM_Core_DAO_AllCoreTables::getTableForClass($class);
@@ -527,7 +518,7 @@ class CRM_Core_BAO_Block {
    * (sort function for sortPrimaryFirst)
    * @param array $location1
    * @param array $location2
-   * @return number
+   * @return int
    */
   public static function primaryComparison($location1, $location2) {
     $l1 = CRM_Utils_Array::value('is_primary', $location1);
@@ -537,4 +528,5 @@ class CRM_Core_BAO_Block {
     }
     return ($l1 < $l2) ? -1 : 1;
   }
+
 }