ratings_components.php

См. документацию.

<?php
 
IncludeModuleLangFile($_SERVER["DOCUMENT_ROOT"].BX_ROOT."/modules/blog/general/ratings_components.php");
 
class CAllRatingsComponentsBlog
{
    // return configs of component-rating
    public static function OnGetRatingConfigs()
    {
        $arConfigs = array(
            "MODULE_ID" => "BLOG",
            "MODULE_NAME" => GetMessage("BLOG_MODULE_NAME"),
        );
        $arConfigs["COMPONENT"]["USER"]["VOTE"][] = array(
            "ID"    => 'POST',
            "REFRESH_TIME"  => '3600',
            "CLASS" => 'CRatingsComponentsBlog',
            "CALC_METHOD"   => 'CalcPost',
            "NAME"  => GetMessage('BLOG_RATING_USER_VOTE_POST_NAME'),
            "DESC"  => GetMessage('BLOG_RATING_USER_VOTE_POST_DESC'),
            "FIELDS" => array(
                array(
                    "ID" => 'COEFFICIENT',
                    "DEFAULT" => '0.5',
                ),
                array(
                    "ID" => 'LIMIT',
                    "NAME" => GetMessage('BLOG_RATING_USER_VOTE_POST_LIMIT_NAME'),
                    "DEFAULT" => '30',
                ),
            )
        );
        $arConfigs["COMPONENT"]["USER"]["VOTE"][] = array(
            "ID"    => 'COMMENT',
            "REFRESH_TIME"  => '3600',
            "CLASS" => 'CRatingsComponentsBlog',
            "CALC_METHOD"   => 'CalcComment',       
            "NAME" => GetMessage('BLOG_RATING_USER_VOTE_COMMENT_NAME'),
            "DESC" => GetMessage('BLOG_RATING_USER_VOTE_COMMENT_DESC'),
            "FIELDS" => array(
                array(
                    "ID" => 'COEFFICIENT',
                    "DEFAULT" => '0.1',
                ),
                array(
                    "ID" => 'LIMIT',
                    "NAME" => GetMessage('BLOG_RATING_USER_VOTE_COMMENT_LIMIT_NAME'),
                    "DEFAULT" => '30',
                ),
            )
        );
        $arConfigs["COMPONENT"]["USER"]["RATING"][] = array(
            "ID"    => 'ACTIVITY',
            "REFRESH_TIME"  => '7200',
            "CLASS" => 'CRatingsComponentsBlog',
            "CALC_METHOD"   => 'CalcActivity',                      
            "NAME" => GetMessage('BLOG_RATING_USER_RATING_ACTIVITY_NAME'),
            "DESC" => GetMessage('BLOG_RATING_USER_RATING_ACTIVITY_DESC'),
            "FORMULA" => 'P<sub>1</sub> * K<sub>P1</sub> + P<sub>7</sub> * K<sub>P7</sub> + P<sub>30</sub> * K<sub>P30</sub> + P<sub>all</sub> * K<sub>Pall</sub> + C<sub>1</sub> * K<sub>C1</sub> + C<sub>7</sub> * K<sub>C7</sub> + C<sub>30</sub> * K<sub>C30</sub> + C<sub>all</sub> * K<sub>Call</sub>',
            "FORMULA_DESC" => GetMessage('BLOG_RATING_USER_RATING_ACTIVITY_FORMULA_DESC'),
            "FIELDS" => array(
                array(
                    "ID" => 'TODAY_POST_COEF',
                    "NAME" => GetMessage('BLOG_RATING_USER_RATING_ACTIVITY_FIELDS_TODAY_POST_COEF'),
                    "DEFAULT" => '0.4',
                ),
                array(
                    "ID" => 'WEEK_POST_COEF',
                    "NAME" => GetMessage('BLOG_RATING_USER_RATING_ACTIVITY_FIELDS_WEEK_POST_COEF'),
                    "DEFAULT" => '0.2',
                ),
                array(
                    "ID" => 'MONTH_POST_COEF',
                    "NAME" => GetMessage('BLOG_RATING_USER_RATING_ACTIVITY_FIELDS_MONTH_POST_COEF'),
                    "DEFAULT" => '0.1',
                ),
                array(
                    "ID" => 'ALL_POST_COEF',
                    "NAME" => GetMessage('BLOG_RATING_USER_RATING_ACTIVITY_FIELDS_ALL_POST_COEF'),
                    "DEFAULT" => '0',
                ),
                array(
                    "ID" => 'TODAY_COMMENT_COEF',
                    "NAME" => GetMessage('BLOG_RATING_USER_RATING_ACTIVITY_FIELDS_TODAY_COMMENT_COEF'),
                    "DEFAULT" => '0.2',
                ),
                array(
                    "ID" => 'WEEK_COMMENT_COEF',
                    "NAME" => GetMessage('BLOG_RATING_USER_RATING_ACTIVITY_FIELDS_WEEK_COMMENT_COEF'),
                    "DEFAULT" => '0.1',
                ),
                array(
                    "ID" => 'MONTH_COMMENT_COEF',
                    "NAME" => GetMessage('BLOG_RATING_USER_RATING_ACTIVITY_FIELDS_MONTH_COMMENT_COEF'),
                    "DEFAULT" => '0.05',
                ),
                array(
                    "ID" => 'ALL_COMMENT_COEF',
                    "NAME" => GetMessage('BLOG_RATING_USER_RATING_ACTIVITY_FIELDS_ALL_COMMENT_COEF'),
                    "DEFAULT" => '0',
                ),
            )
        );
        
        return $arConfigs;
    }
            
    // return support object
    public static function OnGetRatingObject()
    {
        $arRatingConfigs = CRatingsComponentsBlog::OnGetRatingConfigs();
        foreach ($arRatingConfigs["COMPONENT"] as $SupportType => $value)
            $arSupportType[] = $SupportType;
            
        return $arSupportType;
    }
    
    // check the value of the component-rating which relate to the module
    public static function OnAfterAddRating($ID, $arFields)
    {
        $arFields['CONFIGS']['BLOG'] = CRatingsComponentsBlog::__CheckFields($arFields['ENTITY_ID'], $arFields['CONFIGS']['BLOG']);
        
        return $arFields;
    }
    
    // check the value of the component-rating which relate to the module
    public static function OnAfterUpdateRating($ID, $arFields)
    {
        $arFields['CONFIGS']['BLOG'] = CRatingsComponentsBlog::__CheckFields($arFields['ENTITY_ID'], $arFields['CONFIGS']['BLOG']);
        
        return $arFields;
    }
    
    // Utilities
    
    // check input values, if value does not validate, set the default value
    public static function __CheckFields($entityId, $arConfigs)
    {
        $arDefaultConfig = CRatingsComponentsBlog::__AssembleConfigDefault($entityId);
        if ($entityId == "USER") {
            if (isset($arConfigs['VOTE']['POST'])) {
                if (!preg_match('/^\d{1,7}\.?\d{0,4}$/', $arConfigs['VOTE']['POST']['COEFFICIENT']))
                    $arConfigs['VOTE']['POST']['COEFFICIENT'] = $arDefaultConfig['VOTE']['POST']['COEFFICIENT']['DEFAULT'];
 
                if (!preg_match('/^\d{1,5}$/', $arConfigs['VOTE']['POST']['LIMIT']))
                    $arConfigs['VOTE']['POST']['LIMIT'] = $arDefaultConfig['VOTE']['POST']['LIMIT']['DEFAULT'];
            }
                    
            if (isset($arConfigs['VOTE']['COMMENT'])) {
                if (!preg_match('/^\d{1,7}\.?\d{0,4}$/', $arConfigs['VOTE']['COMMENT']['COEFFICIENT']))
                    $arConfigs['VOTE']['COMMENT']['COEFFICIENT'] = $arDefaultConfig['VOTE']['COMMENT']['COEFFICIENT']['DEFAULT'];
 
                if (!preg_match('/^\d{1,5}$/', $arConfigs['VOTE']['COMMENT']['LIMIT']))
                    $arConfigs['VOTE']['COMMENT']['LIMIT'] = $arDefaultConfig['VOTE']['COMMENT']['LIMIT']['DEFAULT'];
            }
                
            if (isset($arConfigs['RATING']['ACTIVITY']))
            {
                if (!preg_match('/^\d{1,7}\.?\d{0,4}$/', $arConfigs['RATING']['ACTIVITY']['TODAY_POST_COEF']))
                    $arConfigs['RATING']['ACTIVITY']['TODAY_POST_COEF'] = $arDefaultConfig['RATING']['ACTIVITY']['TODAY_POST_COEF']['DEFAULT'];
                    
                if (!preg_match('/^\d{1,7}\.?\d{0,4}$/', $arConfigs['RATING']['ACTIVITY']['WEEK_POST_COEF']))
                    $arConfigs['RATING']['ACTIVITY']['WEEK_POST_COEF'] = $arDefaultConfig['RATING']['ACTIVITY']['WEEK_POST_COEF']['DEFAULT'];
                    
                if (!preg_match('/^\d{1,7}\.?\d{0,4}$/', $arConfigs['RATING']['ACTIVITY']['MONTH_POST_COEF']))
                    $arConfigs['RATING']['ACTIVITY']['MONTH_POST_COEF'] = $arDefaultConfig['RATING']['ACTIVITY']['MONTH_POST_COEF']['DEFAULT'];
 
                if (!preg_match('/^\d{1,7}\.?\d{0,4}$/', $arConfigs['RATING']['ACTIVITY']['ALL_POST_COEF']))
                    $arConfigs['RATING']['ACTIVITY']['ALL_POST_COEF'] = $arDefaultConfig['RATING']['ACTIVITY']['ALL_POST_COEF']['DEFAULT'];
                    
                if (!preg_match('/^\d{1,7}\.?\d{0,4}$/', $arConfigs['RATING']['ACTIVITY']['TODAY_COMMENT_COEF']))
                    $arConfigs['RATING']['ACTIVITY']['TODAY_COMMENT_COEF'] = $arDefaultConfig['RATING']['ACTIVITY']['TODAY_POST_COEF']['DEFAULT'];
                    
                if (!preg_match('/^\d{1,7}\.?\d{0,4}$/', $arConfigs['RATING']['ACTIVITY']['WEEK_COMMENT_COEF']))
                    $arConfigs['RATING']['ACTIVITY']['WEEK_COMMENT_COEF'] = $arDefaultConfig['RATING']['ACTIVITY']['WEEK_COMMENT_COEF']['DEFAULT'];
                    
                if (!preg_match('/^\d{1,7}\.?\d{0,4}$/', $arConfigs['RATING']['ACTIVITY']['MONTH_COMMENT_COEF']))
                    $arConfigs['RATING']['ACTIVITY']['MONTH_COMMENT_COEF'] = $arDefaultConfig['RATING']['ACTIVITY']['MONTH_COMMENT_COEF']['DEFAULT'];
 
                if (!preg_match('/^\d{1,7}\.?\d{0,4}$/', $arConfigs['RATING']['ACTIVITY']['ALL_COMMENT_COEF']))
                    $arConfigs['RATING']['ACTIVITY']['ALL_COMMENT_COEF'] = $arDefaultConfig['RATING']['ACTIVITY']['ALL_COMMENT_COEF']['DEFAULT'];
            }
        }
        
        return $arConfigs;
    }
    
    // collect the default and regular expressions for the fields component-rating
    public static function __AssembleConfigDefault($objectType = null)
    {
        $arConfigs = array();
        $arRatingConfigs = CRatingsComponentsBlog::OnGetRatingConfigs();
        if (is_null($objectType)) 
        {
            foreach ($arRatingConfigs["COMPONENT"] as $OBJ_TYPE => $TYPE_VALUE)
                foreach ($TYPE_VALUE as $RAT_TYPE => $RAT_VALUE)
                    foreach ($RAT_VALUE as $VALUE_CONFIG)
                        foreach ($VALUE_CONFIG['FIELDS'] as $VALUE_FIELDS) 
                           $arConfigs[$OBJ_TYPE][$RAT_TYPE][$VALUE_CONFIG['ID']][$VALUE_FIELDS['ID']]['DEFAULT'] = $VALUE_FIELDS['DEFAULT'];
        }
        else 
        {
            foreach ($arRatingConfigs["COMPONENT"][$objectType] as $RAT_TYPE => $RAT_VALUE)
                foreach ($RAT_VALUE as $VALUE_CONFIG)
                    foreach ($VALUE_CONFIG['FIELDS'] as $VALUE_FIELDS) 
                        $arConfigs[$RAT_TYPE][$VALUE_CONFIG['ID']][$VALUE_FIELDS['ID']]['DEFAULT'] = $VALUE_FIELDS['DEFAULT'];
 
        }
        
        return $arConfigs;
    }   
    
    public static function OnGetRatingContentOwner($arParams)
    {
        if ($arParams['ENTITY_TYPE_ID'] == 'BLOG_POST')
        {
            $arPost = CBlogPost::GetByID(intval($arParams['ENTITY_ID']));
            return $arPost['AUTHOR_ID'];
        }
        elseif ($arParams['ENTITY_TYPE_ID'] == 'BLOG_COMMENT')
        {
            $arComment = CBlogComment::GetByID(intval($arParams['ENTITY_ID']));
            return $arComment['AUTHOR_ID'];
        } 
        return false;
    }
}