\App\LibraryRobotsTextLibrary

functions to generate robots.txt data

Summary

Methods
Properties
Constants
__construct()
generateRobots()
getBaseUrl()
No public properties found
DEFAULT_ALLOW_RULES
DEFAULT_DISALLOW_RULES
RULE_SEPARATOR
No protected methods found
No protected properties found
N/A
addCountryRules()
addDefaultAllowRules()
addDefaultDisAllowRules()
addAllow()
addDisAllow()
addUserAgent()
addSiteMap()
addRule()
$rules
$portalUrls
$baseUrl
N/A

Constants

DEFAULT_ALLOW_RULES

DEFAULT_ALLOW_RULES = ['*/api/*', '*/_next/*', '*/static/*']
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
 : 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
array

Constant to hold list of default Allow rules for any portal

DEFAULT_DISALLOW_RULES

DEFAULT_DISALLOW_RULES = ['*/freedesign/*']
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
 : 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
array

Constant to hold list of default Disallow rules for any portal

RULE_SEPARATOR

RULE_SEPARATOR = ': '
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
 : 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string

Constant for rule directory separator

Properties

$rules

$rules
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
 : 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
array

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Type

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 array

$portalUrls

$portalUrls
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
 : 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
array

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Type

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 array

$baseUrl

$baseUrl
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
 : 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Type

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 string

Methods

__construct()

__construct() 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
: mixed

RobotsTextLibrary constructor.

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Returns

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 mixed —

generateRobots()

generateRobots(
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
array  $portalCountryLanguages, 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string  $portalName) 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
: array

Return array of rules for robots.txt.

Parameters

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 array $portalCountryLanguages
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 string $portalName
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Returns

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 array —

getBaseUrl()

getBaseUrl(
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string  $portalName) 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
: string

return base url of the given portal

Parameters

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 string $portalName
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Returns

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 string —

addCountryRules()

addCountryRules(
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
array  $portalCountryLanguages) 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
: void

Add a country specific rules to the robots.

Parameters

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 array $portalCountryLanguages
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

addDefaultAllowRules()

addDefaultAllowRules() 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
: void

Add default rules to be allowed in the robots.

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

addDefaultDisAllowRules()

addDefaultDisAllowRules() 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
: void

Add list of default disallow rules in the robots.

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

addAllow()

addAllow(
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string  $directory) 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
: void

Add directory to an Allow rule.

Parameters

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 string $directory
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

addDisAllow()

addDisAllow(
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string  $directory) 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
: void

Add directory to an Disallow rule.

Parameters

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 string $directory
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

addUserAgent()

addUserAgent(
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string  $userAgent) 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
: void

Add an User-agent rule to the rules.

Parameters

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 string $userAgent
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

addSiteMap()

addSiteMap() 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
: void

Add list of sitemap urls to the rules array.

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

addRule()

addRule(
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string  $rule) 
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
: void

Add new rule to the rules array

Parameters

Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 string $rule
Deprecated: Please use getType in phar:///usr/local/bin/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50