Размещен: /Advertisement/Advertisement.class.php
Описание
Класс модуля "Реклама"
mixed AddBanner()
boolean ClearAdvertisementList()
mixed CopyAdvertisement()
void CopyBannersAndBannersGroupsFromSiteToSite()
идентификатор CopyContextualWords()
mixed CopyGroupAdvertisement()
boolean DelBannerGroup()
boolean DelBannersGroup()
boolean DeleteAdvertisementFile()
boolean DeleteAdvertisementSwfFile()
boolean DeleteBanner()
resourse DeleteContextualWords()
mixed GetAdvertisement()
mixed GetAllAdvertisementForSite()
mixed GetAllBanners()
resource GetAllContextualWords()
mixed GetContextualWords()
int GetCountShowingBanner()
int GetCountShowingBannerAtDay()
int GetTextConformityCoefficient()
mixed InsertBanners()
mixed InsertBannersGroup()
mixed InsertContextualWords()
mixed SelectBanner()
resource SelectBannersFromGroup()
resource SelectBannersGroup()
boolean ShowAdvertisement()
boolean ShowAdvertisementGroup()
boolean ShowBanner()
boolean ShowBannerGroup()
string ShowBannerIsTrue()
AddBanner( array $param );
Описание
Добавление/редактирование баннера
Принимаемые параметры
$param
массив пареметров
Возвращает
идентификатор добавленного/измененного баннера в случае успешного выполнения, false - в противном случае
<?php $Advertisement = new Advertisement(); $param['advertisement_name'] = 'Баннер1'; $param['advertisement_comment'] = ''; $param['advertisement_width'] = ''; $param['advertisement_height'] = ''; $param['advertisement_allcount'] = 1; $param['advertisement_allcount_at_day'] = 1; $param['advertisement_type'] = 1; $newid = $Advertisement->AddBanner($param); // Распечатаем результат echo $newid; ?>
[ Наверх ]
ClearAdvertisementList( [ $count_days = 1], int $count_days=1 );
Описание
Очищение списка показов, произошедших $count_days назад
Принимаемые параметры
$count_days=1
количество дней хранения списка показов. Необязательный параметр, по умолчанию имеет значение 1.
$count_days
Возвращает
<?php $Advertisement = new Advertisement(); $count_days = 1; $result = $Advertisement->ClearAdvertisementList($count_days); if ($result) { echo "Список показов очищен"; } else { echo "Ошибка выполнения очистки"; } // Распечатаем результат echo $result; ?>
[ Наверх ]
CopyAdvertisement( int $advertisement_id, [ $new_site_id = false] );
Описание
Копирование баннера
Принимаемые параметры
$advertisement_id
Идентификатор баннера, который необходимо копировать
$new_site_id
Возвращает
Идентификатор скопированного баннера или false
<?php $Advertisement = new Advertisement(); $advertisement_id = 1; $newid = $Advertisement->CopyGroupAdvertisement($advertisement_id); // Распечатаем результат echo $newid; ?>
[ Наверх ]
CopyBannersAndBannersGroupsFromSiteToSite( int $site_id, int $new_site_id );
Описание
Копирование всех групп баннеров и баннеров, а также их связей с одного сайта на другой
Принимаемые параметры
$site_id
идентификатор сайта, с которого нужно скопировать данные
$new_site_id
идентификатор сайта на который нужно скопировать данные
[ Наверх ]
CopyContextualWords( int $advertisement_contextual_words_id, [array $param = array()] );
Описание
Копирование информации о контекстной фразе
Принимаемые параметры
$advertisement_contextual_words_id
Идентификатор контекстной фразы, информацию о которой необходимо скопировать
$param
Массив дополнительных параметров
Возвращает
новой записи или false
<?php $Advertisement = new Advertisement(); $advertisement_contextual_words_id = 1; $newid = $Advertisement->CopyContextualWords($advertisement_contextual_words_id); // Распечатаем результат echo $newid; ?>
[ Наверх ]
CopyGroupAdvertisement( int $advertisement_group_id, [int $new_site_id = false], [bool $copy_with_association = false] );
Описание
Копирование группы баннеров
Принимаемые параметры
$advertisement_group_id
Идентификатор группы, которую необходимо копировать
$new_site_id
Идентификатор сайта, на который следует перенести скопированную группу, если не передан, берется текущий сайт
$copy_with_association
Флаг, указывающий, копировать ли ассоциации баннеров вместе с группами
Возвращает
Идентификатор скопированной группы или false
<?php $Advertisement = new Advertisement(); $advertisement_group_id = 3; $newid = $Advertisement->CopyGroupAdvertisement($advertisement_group_id); // Распечатаем результат echo $newid; ?>
[ Наверх ]
DelBannerGroup( int $advertisement_group_id, int $advertisement_id );
Описание
Исключение баннера из группы
Принимаемые параметры
$advertisement_group_id
идентификатор группы баннеров
$advertisement_id
идентификатор баннера
Возвращает
<?php $Advertisement = new Advertisement(); $advertisement_group_id = 3; $advertisement_id = 4; $result = $Advertisement->DelBannerGroup($advertisement_group_id, $advertisement_id); // Распечатаем результат if ($result) { echo 'Баннер исключен из группы'; } else { echo 'Ошибка'; } ?>
[ Наверх ]
DelBannersGroup( int $advertisement_group_id );
Описание
Удаление группы баннеров
Принимаемые параметры
$advertisement_group_id
идентификатор группы баннеров
Возвращает
<?php $Advertisement = new Advertisement(); $advertisement_group_id = 1; $result = $Advertisement->DelBannersGroup($advertisement_group_id); if ($result) { echo "Удаление выполнено успешно"; } else { echo "Ошибка удаления"; } ?>
[ Наверх ]
DeleteAdvertisementFile( int $advertisement_id );
Описание
Удаление загруженного файл для элемента
Принимаемые параметры
$advertisement_id
идентификатор элемента
Возвращает
<?php $Advertisement = new Advertisement(); $advertisement_id = 4; $result = $Advertisement->DeleteAdvertisementFile($advertisement_id); if ($result) { echo "Удаление выполнено успешно"; } else { echo "Ошибка удаления"; } ?>
[ Наверх ]
DeleteAdvertisementSwfFile( int $advertisement_id );
Описание
Удаление загруженного swf-файл для элемента
Принимаемые параметры
$advertisement_id
идентификатор элемента
Возвращает
<?php $Advertisement = new Advertisement(); $advertisement_id = 4; $result = $Advertisement->DeleteAdvertisementSwfFile($advertisement_id); if ($result) { echo "Удаление выполнено успешно"; } else { echo "Ошибка удаления"; } ?>
[ Наверх ]
DeleteBanner( int $advertisement_id );
Описание
Удаление баннера
Принимаемые параметры
$advertisement_id
идентификатор баннера
Возвращает
<?php $Advertisement = new Advertisement(); $advertisement_id = 5; $result = $Advertisement->DeleteBanner($advertisement_id); // Распечатаем результат if ($result) { echo 'Баннер удален'; } else { echo 'Ошибка удаления баннера'; } ?>
[ Наверх ]
DeleteContextualWords( int $advertisement_contextual_words_id );
Описание
Удаление информации о контекстной фразе
Принимаемые параметры
$advertisement_contextual_words_id
Идентификатор удаляемой фразы
Возвращает
<?php $Advertisement = new Advertisement(); $advertisement_contextual_words_id = 1; $resource = $Advertisement->DeleteContextualWords($advertisement_contextual_words_id); // Распечатаем результат echo $resource; ?>
[ Наверх ]
GetAdvertisement( int $advertisement_id );
Описание
Получение данных об элементе (баннере, всплывающем окне и т.п.)
Принимаемые параметры
$advertisement_id
идентификатор
Возвращает
массив с данными или false, если элемент с указанным идентификатором не найден
<?php $Advertisement = new Advertisement(); $advertisement_id = 4; $row = $Advertisement->GetAdvertisement($advertisement_id); // Распечатаем результат print_r($row); ?>
[ Наверх ]
GetAllAdvertisementForSite( int $site_id );
Описание
Получаем список всех групп баннеров заданного сайта
Принимаемые параметры
$site_id
идентификатор сайта
Возвращает
resource, либо False
[ Наверх ]
GetAllBanners( [int $site_id = false] );
Описание
Получение информации обо всех баннерах сайта или обо всех баннерах
Принимаемые параметры
$site_id
Идентификатор сайта
Возвращает
resource или false
<?php $Advertisement = new Advertisement(); $site_id = CURRENT_SITE; $resource = $Advertisement->GetAllBanners($site_id); // Распечатаем результат while($row = mysql_fetch_assoc($resource)) { print_r($row); } ?>
[ Наверх ]
GetAllContextualWords( [int $advertisement_id = false] );
Описание
Получение информации о контекстных фразах для баннера
Принимаемые параметры
$advertisement_id
Идентификатор баннера
Возвращает
<?php $Advertisement = new Advertisement(); $advertisement_id = 1; $resource = $Advertisement->GetAllContextualWords($advertisement_id); // Распечатаем результат while($row = mysql_fetch_assoc($resource)) { print_r($row); } ?>
[ Наверх ]
GetContextualWords( int $advertisement_contextual_words_id );
Описание
Получение информации о контекстной фразе
Принимаемые параметры
$advertisement_contextual_words_id
Идентификатор контекстной фразы
Возвращает
массив с информацией о контекcтной фразе или false
<?php $Advertisement = new Advertisement(); $advertisement_contextual_words_id = 1; $row = $Advertisement->GetContextualWords($advertisement_contextual_words_id); // Распечатаем результат print_r ($row); ?>
[ Наверх ]
GetCountShowingBanner( int $advertisement_id );
Описание
Получение количества показов баннера
Принимаемые параметры
$advertisement_id
идентификатор баннера
Возвращает
количество показов или false
<?php $Advertisement = new Advertisement(); $advertisement_id = 1; $result = $Advertisement->GetCountShowingBanner($advertisement_id); // Распечатаем результат echo $result; ?>
[ Наверх ]
GetCountShowingBannerAtDay( string $date, int $advertisement_id );
Описание
Получение количества показов баннера за конкретный день
Принимаемые параметры
$date
дата
$advertisement_id
идентификатор баннера
Возвращает
количество показов или false
<?php $Advertisement = new Advertisement(); $date = date('Y-m-d H:i:s'); $advertisement_id = 1; $result = $Advertisement->GetCountShowingBannerAtDay($date, $advertisement_id); // Распечатаем результат echo $result; ?>
[ Наверх ]
GetTextConformityCoefficient( array $mas1, array $mas2, int $count1, int $count2, [string $method = 'max'] );
Описание
Получение коэффициента схожести текста
Принимаемые параметры
$mas1
массив слов первого текста
$mas2
массив слов второго текста
$count1
количество элементов в первом тексте
$count2
количество элементов во втором тексте
$method
метод расчета схожести - min или max, по умолчанию 'max'. Необязательный параметр
[ Наверх ]
InsertBanners( int $advertisement_group_id, int $advertisement_id, int $banner_value );
Описание
Добавление баннера в группу/редактирование приоритета показа баннера в группе
Принимаемые параметры
$advertisement_group_id
идентификатор группы баннеров
$advertisement_id
идентификатор баннера
$banner_value
значение приоретета показа
Возвращает
идентификатор добавленного/измененного баннера или false
<?php $Advertisement = new Advertisement(); $advertisement_group_id = 3; $advertisement_id = 5; $banner_value = 1; $advertisement_id = $Advertisement->InsertBanners($advertisement_group_id, $advertisement_id, $banner_value); // Распечатаем результат echo $advertisement_id; ?>
[ Наверх ]
InsertBannersGroup( int $advertisement_group_id, string $advertisement_group_name, string $advertisement_group_comment, [int $users_id = false], [int $site_id = false] );
Описание
Добавление/редактирование информации о группе баннеров
Принимаемые параметры
$advertisement_group_id
идентификатор группы баннеров
$advertisement_group_name
имя группы баннеров
$advertisement_group_comment
комментарий к группе баннеров
$users_id
идентификатор пользователя, если false - берется текущий пользователь
$site_id
идентификатор сайта, если false - берется текущий сайт
Возвращает
идентификатор успешно добавленной/редактированной группы или false
<?php $Advertisement = new Advertisement(); $advertisement_group_id = 0; $advertisement_group_name = 'Группа баннеров'; $advertisement_group_comment = ''; $newid = $Advertisement->InsertBannersGroup($advertisement_group_id, $advertisement_group_name, $advertisement_group_comment); // Распечатаем результат echo $newid; ?>
[ Наверх ]
InsertContextualWords( array $param );
Описание
Добавление/обновление информации о контекстной фразе
Принимаемые параметры
$param
Массив значений
Возвращает
Идентификатор обновленной/добавленной записи или false
<?php $Advertisement = new Advertisement(); $param['advertisement_contextual_words_id'] = 0; $param['users_id'] = CURRENT_SITE; $param['advertisement_id'] = 1; $param['advertisement_contextual_words_value'] = 'Контекстная фраза2'; $newid = $Advertisement->InsertContextualWords($param); // Распечатаем результат echo $newid; ?>
[ Наверх ]
SelectBanner( int $advertisement_group_id, [array $param = array()] );
Описание
Определение баннера, доступного для показа
Принимаемые параметры
$advertisement_group_id
идентификатор группы баннеров
$param
массив дополнительных параметров
Возвращает
идентификатор баннера, доступного к показу или false
[ Наверх ]
SelectBannersFromGroup( $advertisement_group_id $advertisement_group_id );
Описание
Получение информации о баннерах группы
Принимаемые параметры
$advertisement_group_id
идентификатор группы баннеров
Возвращает
результат выполнения запроса на выборку
<?php $Advertisement = new Advertisement(); $advertisement_group_id = 1; $resource = $Advertisement->SelectBannersFromGroup($advertisement_group_id); // Распечатаем результат while($row = mysql_fetch_assoc($resource)) { print_r($row); } ?>
[ Наверх ]
SelectBannersGroup( int $advertisement_group_id, [int $site_id = false] );
Описание
Получение информации о конкретной группе баннеров или обо всех группах баннеров
Принимаемые параметры
$advertisement_group_id
идентификатор группы баннеров (-1 или false - выбрать все)
$site_id
идентификатор сайта, если не передан - используется текущий сайт
Возвращает
результат выполнения запроса на выборку
<?php $Advertisement = new Advertisement(); $advertisement_group_id = 1; $resource = $Advertisement->SelectBannersGroup($advertisement_group_id); // Распечатаем результат $row = mysql_fetch_assoc($resource)) print_r($row); ?>
[ Наверх ]
ShowAdvertisement( int $advertisement_id, string $xsl_name );
Описание
Показ баннера с использованием XML
Принимаемые параметры
$advertisement_id
идентификатор баннера
$xsl_name
имя XSL-шаблона
Возвращает
<?php $Advertisement = new Advertisement(); $advertisement_id = 1; $xsl_name = 'ОтображениеБаннера'; $Advertisement->ShowAdvertisement($advertisement_id, $xsl_name); ?>
[ Наверх ]
ShowAdvertisementGroup( int $advertisement_group_id, string $xsl_name, [array $param = array()] );
Описание
Показ баннера из указанной группы в соответствии с приоритетом. Для вывода баннера используется XSL-шаблон.
Принимаемые параметры
$advertisement_group_id
идентификатор группы баннеров
$xsl_name
имя XSL-шаблона
$param
массив дополнительных параметров
see
ShowBannerGroup() <code> <?php $Advertisement = new Advertisement(); $advertisement_group_id = 3; $xsl_name = 'ОтображениеБаннера'; $Advertisement->ShowAdvertisementGroup($advertisement_group_id, $xsl_name); ?> </code> <br />Пример контекстного показа баннера в зависимости от текста страницы. Остальные примеры см. в руководстве по интеграции. <code> <?php ob_start(); // здесь показ контента, в зависимости от которого необходимо выводить баннер // Записываем текст в параметр и выводим в поток $param['contextual_words'] = ob_get_clean(); $param['show_only_context'] = true; $Advertisement = new Advertisement(); $advertisement_group_id = 3; $xsl_name = 'ОтображениеБаннера'; $Advertisement->ShowAdvertisementGroup($advertisement_group_id, $xsl_name, $param); ?> </code>
[ Наверх ]
ShowBanner( int $advertisement_id, [int $count_days = 1] );
Описание
Показ баннера
Принимаемые параметры
$advertisement_id
идентификатор баннера
$count_days
количество дней хранения списка показов. Необязательный параметр, по умолчанию имеет значение 1
Возвращает
<?php $Advertisement = new Advertisement(); $advertisement_id = 1; $result = $Advertisement->ShowBanner($advertisement_id); ?>
[ Наверх ]
ShowBannerGroup( int $advertisement_group_id, [array $param = array()] );
Описание
Показ баннера из указанной группы в соответствии с приоритетом
Принимаемые параметры
$advertisement_group_id
идентификатор группы баннеров
$param
массив дополнительных параметров
see
ShowAdvertisementGroup() <code> <?php $Advertisement = new Advertisement(); $advertisement_group_id = 3; $Advertisement->ShowBannerGroup($advertisement_group_id); ?> </code>
[ Наверх ]
ShowBannerIsTrue( int $list_id, [int $count_days = 1] );
Описание
Переход по ссылке баннера и наращивание счётчика, если с этого показа мы ещё не переходили
Принимаемые параметры
$list_id
идентификатор записи показа
$count_days
количество дней хранения списка показов. Необязательный параметр, по умолчанию имеет значение 1
Возвращает
ссылка с баннера или false
[ Наверх ]