1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 98: 99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: <?php
/**
* MvcCore
*
* This source file is subject to the BSD 3 License
* For the full copyright and license information, please view
* the LICENSE.md file that are distributed with this source code.
*
* @copyright Copyright (c) 2016 Tom Flidr (https://github.com/mvccore)
* @license https://mvccore.github.io/docs/mvccore/5.0.0/LICENCE.md
*/
namespace MvcCore\Ext\Routers\Modules\Route;
trait PropsGettersSetters {
/**
* Required, application module name. Any custom string to define part of
* application under specific domain, routed by this object.
* @required
* @var string|NULL
*/
protected $module = NULL;
/**
* Optional, target controller namespace - used if routed controller defined
* by standard route is not defined absolutely. This namespace is necessary
* to define relatively from standard application controller namespace to
* target controllers directory (namespace).
* @var string|NULL
*/
protected $namespace = NULL;
/**
* Optional, allowed localizations for the routed module if there is used
* any variant of module router with localization.
* @var array
*/
protected $allowedLocalizations = NULL;
/**
* Optional, allowed localizations for the routed module if there is used
* any variant of module router with media (device) definition.
* @var array
*/
protected $mediaVersions = NULL;
/**
* Get application module name. Any custom string to define part of
* application under specific domain, routed by this object.
* @return string|NULL
*/
public function GetModule () {
/** @var $this \MvcCore\Ext\Routers\Modules\Route */
return $this->module;
}
/**
* Set application module name. Any custom string to define part of
* application under specific domain, routed by this object.
* @param string|NULL $module
* @return \MvcCore\Ext\Routers\Modules\Route
*/
public function SetModule ($module) {
/** @var $this \MvcCore\Ext\Routers\Modules\Route */
$this->module = $module;
return $this;
}
/**
* Get target controller namespace - used if routed controller defined by
* standard route is not defined absolutely. This namespace is necessary to
* define relatively from standard application controller namespace to
* target controllers directory (namespace).
* @return string|NULL
*/
public function GetNamespace () {
/** @var $this \MvcCore\Ext\Routers\Modules\Route */
return $this->namespace;
}
/**
* Set target controller namespace - used if routed controller defined by
* standard route is not defined absolutely. This namespace is necessary to
* define relatively from standard application controller namespace to
* target controllers directory (namespace).
* @param string|NULL $namespace
* @return \MvcCore\Ext\Routers\Modules\Route
*/
public function SetNamespace ($namespace) {
/** @var $this \MvcCore\Ext\Routers\Modules\Route */
$this->namespace = $namespace;
return $this;
}
/**
* Get allowed localizations for the routed module if there is used
* any variant of module router with localization.
* @return \string[]
*/
public function GetAllowedLocalizations () {
/** @var $this \MvcCore\Ext\Routers\Modules\Route */
return $this->allowedLocalizations
? array_keys($this->allowedLocalizations)
: [];
}
/**
* Set allowed localizations for the routed module if there is used
* any variant of module router with localization.
* @var \string[] $allowedLocalizations..., International lower case language
* code(s) (+ optionally dash character
* + upper case international locale code(s))
* @return \MvcCore\Ext\Routers\Modules\Route
*/
public function SetAllowedLocalizations (/* ...$allowedLocalizations */) {
/** @var $this \MvcCore\Ext\Routers\Modules\Route */
$allowedLocalizations = func_get_args();
if (count($allowedLocalizations) === 1 && is_array($allowedLocalizations[0]))
$allowedLocalizations = $allowedLocalizations[0];
$this->allowedLocalizations = array_combine($allowedLocalizations, $allowedLocalizations);
return $this;
}
/**
* Get allowed localizations for the routed module if there is used
* any variant of module router with media (device) definition.
* @return array
*/
public function & GetAllowedMediaVersions () {
/** @var $this \MvcCore\Ext\Routers\Modules\Route */
if (!$this->allowedMediaVersions)
$this->allowedMediaVersions = [];
return $this->allowedMediaVersions;
}
/**
* Set allowed localizations for the routed module if there is used
* any variant of module router with media (device) definition.
* @param array $allowedMediaVersionsAndUrlValues
* @return \MvcCore\Ext\Routers\Modules\Route
*/
public function SetAllowedMediaVersions ($allowedMediaVersionsAndUrlValues = []) {
/** @var $this \MvcCore\Ext\Routers\Modules\Route */
$this->allowedMediaVersions = $allowedMediaVersionsAndUrlValues;
return $this;
}
/* NOT USED METHODS IN MODULE DOMAIN ROUTE CLASS: *************************/
/**
* THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
* Use method `GetModule()` instead.
* @return NULL
*/
public function GetName () {
/** @var $this \MvcCore\Ext\Routers\Modules\Route */
$this->trriggerUnusedMethodError(__METHOD__);
return NULL;
}
/**
* THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
* Use method `SetModule($module)` instead.
* @param string $name
* @return \MvcCore\Ext\Routers\Modules\Route
*/
public function SetName ($name) {
/** @var $this \MvcCore\Ext\Routers\Modules\Route */
return $this->trriggerUnusedMethodError(__METHOD__);
}
/**
* THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
* @return NULL
*/
public function GetController () {
/** @var $this \MvcCore\Ext\Routers\Modules\Route */
$this->trriggerUnusedMethodError(__METHOD__);
return NULL;
}
/**
* THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
* @param string $controller
* @return \MvcCore\Ext\Routers\Modules\Route
*/
public function SetController ($controller) {
/** @var $this \MvcCore\Ext\Routers\Modules\Route */
return $this->trriggerUnusedMethodError(__METHOD__);
}
/**
* THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
* @return NULL
*/
public function GetAction () {
/** @var $this \MvcCore\Ext\Routers\Modules\Route */
$this->trriggerUnusedMethodError(__METHOD__);
return NULL;
}
/**
* THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
* @param string $action
* @return \MvcCore\Ext\Routers\Modules\Route
*/
public function SetAction ($action) {
/** @var $this \MvcCore\Ext\Routers\Modules\Route */
return $this->trriggerUnusedMethodError(__METHOD__);
}
/**
* THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
* @return NULL
*/
public function GetControllerAction () {
/** @var $this \MvcCore\Ext\Routers\Modules\Route */
$this->trriggerUnusedMethodError(__METHOD__);
return NULL;
}
/**
* THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
* @param string $controllerAction
* @return \MvcCore\Ext\Routers\Modules\Route
*/
public function SetControllerAction ($controllerAction) {
/** @var $this \MvcCore\Ext\Routers\Modules\Route */
return $this->trriggerUnusedMethodError(__METHOD__);
}
/**
* THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
* @return NULL
*/
public function GetMethod () {
/** @var $this \MvcCore\Ext\Routers\Modules\Route */
$this->trriggerUnusedMethodError(__METHOD__);
return NULL;
}
/**
* THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
* @param string $method
* @return \MvcCore\Ext\Routers\Modules\Route
*/
public function SetMethod ($method = NULL) {
/** @var $this \MvcCore\Ext\Routers\Modules\Route */
return $this->trriggerUnusedMethodError(__METHOD__);
}
/**
* THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
* @return NULL
*/
public function GetRedirect () {
/** @var $this \MvcCore\Ext\Routers\Modules\Route */
$this->trriggerUnusedMethodError(__METHOD__);
return NULL;
}
/**
* THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
* @param string $redirectRouteName
* @return \MvcCore\Ext\Routers\Modules\Route
*/
public function SetRedirect ($redirectRouteName = NULL) {
/** @var $this \MvcCore\Ext\Routers\Modules\Route */
return $this->trriggerUnusedMethodError(__METHOD__);
}
/**
* THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
* @return bool
*/
public function GetAbsolute () {
/** @var $this \MvcCore\Ext\Routers\Modules\Route */
$this->trriggerUnusedMethodError(__METHOD__);
return TRUE;
}
/**
* THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
* @param bool $absolute
* @return \MvcCore\Ext\Routers\Modules\Route
*/
public function SetAbsolute ($absolute = TRUE) {
/** @var $this \MvcCore\Ext\Routers\Modules\Route */
return $this->trriggerUnusedMethodError(__METHOD__);
}
/**
* THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
* @return NULL
*/
public function GetGroupName () {
/** @var $this \MvcCore\Ext\Routers\Modules\Route */
$this->trriggerUnusedMethodError(__METHOD__);
return NULL;
}
/**
* THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
* @param string $groupName
* @return \MvcCore\Ext\Routers\Modules\Route
*/
public function SetGroupName ($groupName) {
/** @var $this \MvcCore\Ext\Routers\Modules\Route */
return $this->trriggerUnusedMethodError(__METHOD__);
}
/**
* Trigger `E_USER_WARNING` user error about not used method in this
* extended module domain route.
* @param string $method
* @return \MvcCore\Ext\Routers\Modules\Route
*/
protected function trriggerUnusedMethodError ($method) {
/** @var $this \MvcCore\Ext\Routers\Modules\Route */
trigger_error("[".get_class()."] The method `{$method}` is not used in this extended class.", E_USER_WARNING);
return $this;
}
}