Documentation

Seo_Controller_Yandex extends Seo_Controller
in package

Seo_Controller_Yandex

Tags
subpackage

Seo

version
7.x
author

Hostmake LLC

copyright

© 2005-2022 ООО "Хостмэйк" (Hostmake LLC), http://www.hostcms.ru

Table of Contents

$instance  : mixed
The singleton instances.
$_baseUrl  : string
Yandex.Webmaster API url
$_oSeo_Site  : Site_Model
Seo site object
$_oSite  : Site_Model
Site object
$_token  : string
Token
$_user_id  : int
Yandex.Webmaster user id
addCurrentSite()  : id|null
Add current site
addSite()  : string
Add site into Yandex.Webmaster
deleteSite()  : true|false
Delete site from Yandex.Webmaster
execute()  : bool
Execute
getColor()  : string
Get color
getExternalLinksHistory()  : array<string|int, mixed>
Get site external links history
getHostId()  : id|null
Get host id
getIcon()  : string
Get icon
getIndexingHistory()  : array<string|int, mixed>
Get site indexing history by robots
getQueries()  : array<string|int, mixed>
Get site popular queries
getRatingName()  : string
Get rating name
getSiteExternalLinks()  : array<string|int, mixed>
Get site external links
getSiteInfo()  : self
Get site information
getSiteList()  : array<string|int, mixed>
Get user sites list
getSitePopularPages()  : array<string|int, mixed>
Get site popular pages
getSitePopularQueries()  : array<string|int, mixed>
Get site popular queries
getSiteStatistic()  : array<string|int, mixed>
Get site statistics
getSqiHistory()  : array<string|int, mixed>
Get site sqi history for last year
getTokenUrl()  : string
Get token url
getUserId()  : id|null
Get user id
instance()  : object
Register an existing instance as a singleton.
setSeoSite()  : self
Set seo site
setSite()  : self
Set site
setToken()  : self
Set token
verification()  : array<string|int, mixed>
Verification
_getDriverName()  : srting
Get full driver name

Properties

$instance

The singleton instances.

public static mixed $instance = array()

$_baseUrl

Yandex.Webmaster API url

protected string $_baseUrl = 'https://api.webmaster.yandex.net/v4/'

$_user_id

Yandex.Webmaster user id

protected int $_user_id = \NULL

Methods

addCurrentSite()

Add current site

public addCurrentSite() : id|null
Return values
id|null

addSite()

Add site into Yandex.Webmaster

public addSite(string $host_url) : string
Parameters
$host_url : string

domain url

Return values
string

deleteSite()

Delete site from Yandex.Webmaster

public deleteSite(string $host_id) : true|false
Parameters
$host_id : string

host_id

Return values
true|false

execute()

Execute

public execute() : bool
Return values
bool

getColor()

Get color

public getColor() : string
Return values
string

getExternalLinksHistory()

Get site external links history

public getExternalLinksHistory(int $host_id) : array<string|int, mixed>
Parameters
$host_id : int

Yandex.Webmaster site id

Return values
array<string|int, mixed>

getHostId()

Get host id

public getHostId() : id|null
Return values
id|null

getIcon()

Get icon

public getIcon() : string
Return values
string

getIndexingHistory()

Get site indexing history by robots

public getIndexingHistory(int $host_id[, array<string|int, mixed> $indexing_indicators = array('SEARCHABLE') ]) : array<string|int, mixed>
Parameters
$host_id : int

Yandex.Webmaster site id

$indexing_indicators : array<string|int, mixed> = array('SEARCHABLE')

indicator list

Return values
array<string|int, mixed>

getQueries()

Get site popular queries

public getQueries(int $host_id[, string $order_by = 'TOTAL_CLICKS' ]) : array<string|int, mixed>
Parameters
$host_id : int

Yandex.Webmaster site id

$order_by : string = 'TOTAL_CLICKS'

queries order indicator

Return values
array<string|int, mixed>

getRatingName()

Get rating name

public getRatingName() : string
Return values
string

Get site external links

public getSiteExternalLinks(int $host_id, int $offset[, int $limit = 100 ]) : array<string|int, mixed>
Parameters
$host_id : int

Yandex.Webmaster site id

$offset : int

offset

$limit : int = 100

limit

Return values
array<string|int, mixed>

getSiteInfo()

Get site information

public getSiteInfo(int $host_id) : self
Parameters
$host_id : int

Yandex.Webmaster site id

Return values
self

getSiteList()

Get user sites list

public getSiteList() : array<string|int, mixed>
Return values
array<string|int, mixed>

getSitePopularPages()

Get site popular pages

public getSitePopularPages(string $host_url) : array<string|int, mixed>
Parameters
$host_url : string

domain url

Return values
array<string|int, mixed>

getSitePopularQueries()

Get site popular queries

public getSitePopularQueries(int $host_id) : array<string|int, mixed>
Parameters
$host_id : int

Yandex.Webmaster site id

Return values
array<string|int, mixed>

getSiteStatistic()

Get site statistics

public getSiteStatistic(int $host_id) : array<string|int, mixed>
Parameters
$host_id : int

Yandex.Webmaster site id

Return values
array<string|int, mixed>

getSqiHistory()

Get site sqi history for last year

public getSqiHistory(int $host_id) : array<string|int, mixed>
Parameters
$host_id : int

Yandex.Webmaster site id

Return values
array<string|int, mixed>

getTokenUrl()

Get token url

public getTokenUrl() : string
Return values
string

getUserId()

Get user id

public getUserId() : id|null
Return values
id|null

instance()

Register an existing instance as a singleton.

public static instance(string $name) : object
Parameters
$name : string

driver's name

Return values
object

setSite()

Set site

public setSite(string $oSite) : self
Parameters
$oSite : string

Site Model

Return values
self

setToken()

Set token

public setToken(string $token) : self
Parameters
$token : string

token

Return values
self

verification()

Verification

public verification(int $host_id) : array<string|int, mixed>
Parameters
$host_id : int

Yandex.Webmaster site id

Return values
array<string|int, mixed>

_getDriverName()

Get full driver name

protected static _getDriverName(string $driver) : srting
Parameters
$driver : string

driver name

Return values
srting

Search results