Класс SitemapIblock

Открытые статические члены
static	__callStatic ($name, $arguments)
	Event handler for multiple IBlock events. Подробнее...
static	prepareUrlToReplace ($url, $siteId=NULL)
	Replace some parts of URL-template, then not correct processing in replaceDetailUrl. Подробнее...

Защищенные статические члены
static	checkElement (&$fields)
	Checks if element is a real element, not a workflow item. Подробнее...
static	actionUpdate ($data, $element)
	Processes actions on IBlock element or section update. Подробнее...
static	actionDelete ($data)
	Processes actions on IBlock element or section delete. Подробнее...
static	actionAdd ($name, $fields)
	Processes actions on IBlock element or section add. Подробнее...

Подробное описание

См. определение в файле sitemapiblock.php строка 212

Методы

__callStatic()

static __callStatic (   $name,   $arguments  )

static

Event handler for multiple IBlock events.

См. определение в файле sitemapiblock.php строка 224

    {
        $name = ToUpper($name);
 
        switch($name)
        {
            case 'ADDELEMENT':
            case 'ADDSECTION':
                if(
                    $arguments[0]["ID"] > 0
                    && $arguments[0]['IBLOCK_ID'] > 0
                    && (
                        !isset($arguments[0]['ACTIVE'])
                        || $arguments[0]['ACTIVE'] == 'Y'
                    )
                )
                {
                    // we recieve array reference here
                    $fields = array();
                    foreach($arguments[0] as $key => $value)
                    {
                        $fields[$key] = $value;
                    }
 
                    if(!isset($fields['EXTERNAL_ID']) && isset($fields['XML_ID']))
                    {
                        $fields['EXTERNAL_ID'] = $fields['XML_ID'];
                    }
 
                    self::actionAdd($name, $fields);
                }
            break;
 
            case 'BEFOREDELETEELEMENT':
            case 'BEFOREDELETESECTION':
            case 'BEFOREUPDATEELEMENT':
            case 'BEFOREUPDATESECTION':
                $ID = $arguments[0];
                if(is_array($ID))
                    $ID = $ID['ID'];
 
                if($ID > 0)
                {
                    $element = $name == 'BEFOREDELETEELEMENT' || $name == 'BEFOREUPDATEELEMENT';
 
                    $dbFields = $element
                        ? \CIBlockElement::getByID($ID)
                        : \CIBlockSection::getByID($ID);
 
                    $fields = $dbFields->getNext();
                    if($fields)
                    {
                        if($element && !self::checkElement($fields))
                        {
                            return;
                        }
 
                        $sitemaps = SitemapIblockTable::getByIblock(
                            $fields,
                            $element ? SitemapIblockTable::TYPE_ELEMENT : SitemapIblockTable::TYPE_SECTION
                        );
                        
                        if (count($sitemaps) > 0)
                        {
//                          URL from $fields may be incorrect, if using #SERVER_NAME# template in iblock URL-template
//                          And we must generate true URL
                            $dbIblock = \CIBlock::GetByID($fields['IBLOCK_ID']);
                            $iblock = $dbIblock->GetNext();
                            $url = $element
                                ? $iblock['~DETAIL_PAGE_URL']
                                : $iblock['~SECTION_PAGE_URL'];
                            $url = self::prepareUrlToReplace($url);
                            $url = \CIBlock::replaceDetailUrl($url, $fields, false, $element ? 'E' : 'S');
                            
                            self::$beforeActions[$name][intval($element)][$ID] = array(
                                'URL' => $url,
                                'FIELDS' => $fields,
                                'SITEMAPS' => $sitemaps,
                            );
                        }
                    }
                }
            break;
 
            case 'DELETEELEMENT':
            case 'DELETESECTION':
            case 'UPDATEELEMENT':
            case 'UPDATESECTION':
 
                $fields = $arguments[0];
                $element = $name == 'DELETEELEMENT' || $name == 'UPDATEELEMENT';
 
                if(
                    is_array($fields)
                    && $fields['ID'] > 0
                    && isset(self::$beforeActions['BEFORE'.$name][intval($element)][$fields['ID']])
                )
                {
                    if($fields['RESULT'] !== false)
                    {
                        if($name == 'DELETEELEMENT' || $name == 'DELETESECTION')
                        {
                            self::actionDelete(self::$beforeActions['BEFORE'.$name][intval($element)][$fields['ID']]);
                        }
                        else
                        {
                            self::actionUpdate(self::$beforeActions['BEFORE'.$name][intval($element)][$fields['ID']], $element);
                        }
                    }
 
                    unset(self::$beforeActions['BEFORE'.$name][intval($element)][$fields['ID']]);
                }
 
            break;
 
        }
    }

actionAdd()

static actionAdd (   $name,   $fields  )

staticprotected

Processes actions on IBlock element or section add.

Аргументы

string	$name	Event handler name.
array	$fields	Element/section fields.

См. определение в файле sitemapiblock.php строка 477

    {
        if($name == 'ADDELEMENT')
        {
            if(!self::checkElement($fields))
            {
                return;
            }
 
            // we don't have the GLOBAL_ACTIVE flag in fields so we should check it manually
            if(is_array($fields['IBLOCK_SECTION']) && count($fields['IBLOCK_SECTION']) > 0)
            {
                $newSections = array();
                $filter = array(
                    'ID' => $fields['IBLOCK_SECTION'],
                    'IBLOCK_ID' => $fields['IBLOCK_ID'],
                    'GLOBAL_ACTIVE' => 'Y'
                );
                
                $dbRes = \CIBlockSection::getList(array(), $filter, false, array('ID', 'IBLOCK_TYPE_ID', 'IBLOCK_CODE'));
                while ($ar = $dbRes->fetch())
                {
                    $newSections[] = $ar['ID'];
                    $iblockTypeId = $ar['IBLOCK_TYPE_ID'] ? $ar['IBLOCK_TYPE_ID'] : null;
                    $iblockCode = $ar['IBLOCK_CODE'] ? $ar['IBLOCK_CODE'] : null;
                }
 
                if(count($newSections) <= 0)
                {
                    // element is added to inactive sections
                    return;
                }
 
                $fields['IBLOCK_SECTION'] = $newSections;
            }
        }
        elseif($name == 'ADDSECTION')
        {
            $dbRes = \CIBlockSection::getList(
                array(),
                array('ID' => $fields['ID'], 'GLOBAL_ACTIVE' => 'Y'),
                false,
                array('ID', 'IBLOCK_TYPE_ID', 'IBLOCK_CODE')
            );
            
            $inactiveBranch = true;
            while ($ar = $dbRes->fetch())
            {
                $iblockTypeId = $ar['IBLOCK_TYPE_ID'] ? $ar['IBLOCK_TYPE_ID'] : null;
                $iblockCode = $ar['IBLOCK_CODE'] ? $ar['IBLOCK_CODE'] : null;
                $inactiveBranch = false;
            }
            
            if ($inactiveBranch)
            {
                // section is added to inactive branch
                return;
            }
        }
        
        $fields['IBLOCK_TYPE_ID'] = $iblockTypeId;
        $fields['IBLOCK_CODE'] = $iblockCode;
        
        $sitemaps = SitemapIblockTable::getByIblock(
            $fields,
            $name == 'ADDSECTION' ? SitemapIblockTable::TYPE_SECTION : SitemapIblockTable::TYPE_ELEMENT
        );
 
        $fields['TIMESTAMP_X'] = ConvertTimeStamp(false, "FULL");
 
        if(isset($fields['IBLOCK_SECTION']) && is_array($fields['IBLOCK_SECTION']) && count($fields['IBLOCK_SECTION']) > 0)
        {
            $fields['IBLOCK_SECTION_ID'] = min($fields['IBLOCK_SECTION']);
        }
 
        if(count($sitemaps) > 0)
        {
            $siteDirs = self::createSiteDirs();
            
            foreach ($sitemaps as $sitemap)
            {
                $fileName = str_replace(
                    array('#IBLOCK_ID#', '#IBLOCK_CODE#', '#IBLOCK_XML_ID#'),
                    array($fields['IBLOCK_ID'], $sitemap['IBLOCK_CODE'], $sitemap['IBLOCK_XML_ID']),
                    $sitemap['SITEMAP_FILE_IBLOCK']
                );
 
                $sitemapFile = new SitemapFile($fileName, $sitemap);
 
//              write changes to temp file to preserve collisions
                $sitemapRuntimeId = $sitemap['SITE_ID'] . '-' . uniqid();
                $sitemapRuntimeId .= isset($fields['ID']) ? '-' . $fields['ID'] . '-' : '';
                $sitemapRuntimeFile = new SitemapRuntime($sitemapRuntimeId, $fileName, $sitemap);
                
                if(self::checkActivity($name == 'ADDELEMENT' ? true : false, $fields))
                {
                    $fields['LANG_DIR'] = $siteDirs[$sitemap['SITE_ID']];
                    
                    $url = $name == 'ADDSECTION' ? $sitemap['SECTION_PAGE_URL'] : $sitemap['DETAIL_PAGE_URL'];
                    $urlType = $name == 'ADDSECTION' ? 'S' : 'E';
//                  remove or replace SERVER_NAME
                    $url = self::prepareUrlToReplace($url, $sitemap['SITE_ID']);
                    $rule = array(
                        'url' => \CIBlock::replaceDetailUrl($url, $fields, false, $urlType),
                        'lastmod' => MakeTimeStamp($fields['TIMESTAMP_X']),
                    );
                    
                    $sitemapRuntimeFile->setOriginalFile($sitemapFile);
                    $sitemapRuntimeFile->appendIblockEntry($rule['url'], $rule['lastmod']);
                }
                
//              after this in original file will be added always changes
                if ($sitemapRuntimeFile->isNotEmpty() && $sitemapRuntimeFile->isCurrentPartNotEmpty())
                    $sitemapRuntimeFile->finish();
                else
                    $sitemapRuntimeFile->delete();
                
                $sitemapIndex = new SitemapIndex($sitemap['SITEMAP_FILE'], $sitemap);
                $sitemapIndex->appendIndexEntry($sitemapFile);
                
                if ($sitemap['ROBOTS'] == 'Y')
                {
                    $robotsFile = new RobotsFile($sitemap['SITE_ID']);
                    $robotsFile->addRule(
                        array(RobotsFile::SITEMAP_RULE, $sitemapIndex->getUrl())
                    );
                }
            }
        }
    }

actionDelete()

static actionDelete (   $data )

staticprotected

Processes actions on IBlock element or section delete.

Аргументы

array

$data

Data got from SitemapIblockTable::getByIblock() + element/section data + prev link data got from event handler.

См. определение в файле sitemapiblock.php строка 452

    {
        $fields = $data['FIELDS'];
        foreach ($data['SITEMAPS'] as $sitemap)
        {
            $fileName = str_replace(
                array('#IBLOCK_ID#', '#IBLOCK_CODE#', '#IBLOCK_XML_ID#'),
                array($fields['IBLOCK_ID'], $sitemap['IBLOCK_CODE'], $sitemap['IBLOCK_XML_ID']),
                $sitemap['SITEMAP_FILE_IBLOCK']
            );
 
            $sitemapFile = new SitemapFile($fileName, $sitemap);
            $sitemapFile->removeEntry($data['URL']);
 
            $sitemapIndex = new SitemapIndex($sitemap['SITEMAP_FILE'], $sitemap);
            $sitemapIndex->appendIndexEntry($sitemapFile);
        }
    }

actionUpdate()

static actionUpdate (   $data,   $element  )

staticprotected

Processes actions on IBlock element or section update.

Аргументы

array	$data	Data got from SitemapIblockTable::getByIblock() + element/section data + prev link data got from event handler.
bool	$element	Element or section.

См. определение в файле sitemapiblock.php строка 376

    {
        $fields = $data['FIELDS'];
        $siteDirs = self::createSiteDirs();
        
        foreach ($data['SITEMAPS'] as $sitemap)
        {
            $fileName = str_replace(
                array('#IBLOCK_ID#', '#IBLOCK_CODE#', '#IBLOCK_XML_ID#'),
                array($fields['IBLOCK_ID'], $sitemap['IBLOCK_CODE'], $sitemap['IBLOCK_XML_ID']),
                $sitemap['SITEMAP_FILE_IBLOCK']
            );
 
            if($element)
                $dbRes = \CIBlockElement::getByID($fields["ID"]);
            else
                $dbRes = \CIBlockSection::getByID($fields["ID"]);
            
            $newFields = $dbRes->fetch();
            
            $sitemapFile = new SitemapFile($fileName, $sitemap);
//          try remove entry from original file, to not create temp files to all parts
//          name may was changed in removeEntry
            $fileName = $sitemapFile->removeEntry($data['URL']);
 
//          write changes to temp file to preserve collisions
            $sitemapRuntimeId = $sitemap['SITE_ID'] . '-' . uniqid();
            $sitemapRuntimeId .= isset($fields['ID']) ? '-' . $fields['ID'] . '-' : '';
            $sitemapRuntimeFile = new SitemapRuntime($sitemapRuntimeId, $fileName, $sitemap);
            
//          check ACTIVITY by active, date or etc, add entry only for active
            if(self::checkActivity($element, $newFields))
            {
                $newFields['LANG_DIR'] = $siteDirs[$sitemap['SITE_ID']];
 
//              use just date(). it is not true, but because we use BEFORE event, we cant use real lastmod date, only previous value
                $date = date('d.m.Y H:i:s');
                
                $url = $element ? $sitemap['DETAIL_PAGE_URL'] : $sitemap['SECTION_PAGE_URL'];
                $urlType = $element ? 'E' : 'S';
//              remove or replace SERVER_NAME
                $url = self::prepareUrlToReplace($url, $sitemap['SITE_ID']);
                $rule = array(
                    'url' => \CIBlock::replaceDetailUrl($url, $newFields, false, $urlType),
                    'lastmod' => MakeTimeStamp($date),
                );
                
                $sitemapRuntimeFile->setOriginalFile($sitemapFile);
                $sitemapRuntimeFile->appendIblockEntry($rule['url'], $rule['lastmod']);
            }
            
//          rename RUNTIME file to original SITEMAPFILE name, or just remove TMP file
//          after this in original file will be added always changes
            if ($sitemapRuntimeFile->isNotEmpty() && $sitemapRuntimeFile->isCurrentPartNotEmpty())
                $sitemapRuntimeFile->finish();
            else
                $sitemapRuntimeFile->delete();
            
            $sitemapIndex = new SitemapIndex($sitemap['SITEMAP_FILE'], $sitemap);
            $sitemapIndex->appendIndexEntry($sitemapFile);
            
            if ($sitemap['ROBOTS'] == 'Y')
            {
                $robotsFile = new RobotsFile($sitemap['SITE_ID']);
                $robotsFile->addRule(
                    array(RobotsFile::SITEMAP_RULE, $sitemapIndex->getUrl())
                );
            }
        }
    }

checkElement()

static checkElement ( &  $fields )

staticprotected

Checks if element is a real element, not a workflow item.

Аргументы

array

$fields

Element fields.

Возвращает

bool

См. определение в файле sitemapiblock.php строка 349

    {
        if($fields['WF'] === 'Y')
        {
            if(
                $fields['WF_PARENT_ELEMENT_ID'] > 0
                && $fields['WF_PARENT_ELEMENT_ID'] != $fields['ID']
                && $fields['WF_STATUS_ID'] == 1
            )
            {
                $fields['ID'] = $fields['WF_PARENT_ELEMENT_ID'];
            }
            else
            {
                return false;
            }
        }
 
        return true;
    }

prepareUrlToReplace()

static prepareUrlToReplace (   $url,   $siteId = NULL  )

static

Replace some parts of URL-template, then not correct processing in replaceDetailUrl.

Аргументы

string	$url	- String of URL-template.
null	$siteId	- In NULL - #SERVER_NAME# will not replaced.

Возвращает

mixed|string

См. определение в файле sitemapiblock.php строка 670

    {
//      REMOVE PROTOCOL - we put them later, based on user settings
        $url = str_replace('http://', '', $url);
        $url = str_replace('https://', '', $url);
 
//      REMOVE SERVER_NAME from start position, because we put server_url later
        if (substr($url, 0, strlen('#SERVER_NAME#')) == '#SERVER_NAME#')
            $url = substr($url, strlen('#SERVER_NAME#'));
 
//      get correct SERVER_URL
        if ($siteId)
        {
            $filter = array('=LID' => $siteId);
            $dbSite = SiteTable::getList(array(
                'filter' => $filter,
                'select' => array('LID', 'DIR', 'SERVER_NAME'),
            ));
            $currentSite = $dbSite->fetch();
            $serverName = $currentSite['SERVER_NAME'];
            $url = str_replace('#SERVER_NAME#', $serverName, $url);
        }
        
        return $url;
    }

---

Объявления и описания членов класса находятся в файле:

• sitemapiblock.php