RewriteRule
extends EntityBase
in package
Class RewriteRule
Tags
Table of Contents
Constants
- REDIRECTION_TYPE_301 : mixed = 301
- REDIRECTION_TYPE_302 : mixed = 302
- REDIRECTION_TYPE_INTERN : mixed = 'intern'
Properties
- $active : bool
- $continueOnMatch : bool
- $id : int
- $localeCodes : array<string|int, mixed>
- List of locale codes ordered by translation fallback order per Cx instance
- $nestingCount : int
- Counts the nesting level of __call()
- $orderNo : int
- Order of the Rewrite rule
- $regularExpression : RegularExpression
- Regex
- $rewriteStatusCode : int
- Rewrite Status Code
- $stringRepresentationBlank : bool
- Whether blank string representations are valid
- $stringRepresentationFields : array<string|int, mixed>
- List of fields that should be available in the string representation
- $stringRepresentationFormat : string
- Sprintf format for the string representation
- $validators : array<string|int, mixed>
- Initialize this array as follows: array( 'columName' => Zend_Validate )
- $virtual : bool
- Defines if an entity is virtual and therefore not persistable.
Methods
- __call() : mixed
- Route methods like getName(), getType(), getDirectory(), etc.
- __get() : mixed
- This is an ugly solution to allow $this->cx to be available in all entity classes Since the entity's constructor is not called when an entity is loaded from DB this cannot be assigned there.
- __toString() : string
- Returns this entity's identifying value
- getActive() : bool
- Get active flag
- getComponentController() : SystemComponent
- Returns the component controller for this component
- getContinueOnMatch() : bool
- getId() : int
- Get id
- getKeyAsString() : string
- Returns this entity's key
- getOrderNo() : int
- Get the order no
- getRegularExpression() : RegularExpression
- Get Regular expression
- getRewriteStatusCode() : int
- Get Rewrite Status Code
- getTranslatedFieldValue() : mixed
- Returns the value of a translatable field using fallback mechanisms
- initializeValidators() : mixed
- Set $this->validators
- isVirtual() : bool
- Returns the virtuality of the entity
- matches() : mixed
- resolve() : mixed
- Resolve
- setActive() : mixed
- Set active flag
- setContinueOnMatch() : mixed
- Set continue on match
- setOrderNo() : mixed
- Set the order no
- setRegularExpression() : mixed
- Set regular expression
- setRewriteStatusCode() : mixed
- Set the rewrite status code
- setVirtual() : mixed
- Set the virtuality of the entity
- validate() : mixed
- getFallbackLocaleCodes() : array<string|int, mixed>
- Returns a list of all locale codes ordered by fallback order
- getStringRepresentationBlank() : bool
- Whether blank string representations are valid
- getStringRepresentationFields() : array<string|int, mixed>
- Returns a list of fields available in the string representation
- getStringRepresentationFormat() : string
- Returns the sprintf() format for the string representation
Constants
REDIRECTION_TYPE_301
public
mixed
REDIRECTION_TYPE_301
= 301
REDIRECTION_TYPE_302
public
mixed
REDIRECTION_TYPE_302
= 302
REDIRECTION_TYPE_INTERN
public
mixed
REDIRECTION_TYPE_INTERN
= 'intern'
Properties
$active
protected
bool
$active
= true
$continueOnMatch
protected
bool
$continueOnMatch
$id
protected
int
$id
$localeCodes
List of locale codes ordered by translation fallback order per Cx instance
protected
static array<string|int, mixed>
$localeCodes
= array()
Array in the form: array(<instanceId> => array(<localeCode>, ...))
Tags
$nestingCount
Counts the nesting level of __call()
protected
static int
$nestingCount
= 0
$orderNo
Order of the Rewrite rule
protected
int
$orderNo
$regularExpression
Regex
protected
RegularExpression
$regularExpression
$rewriteStatusCode
Rewrite Status Code
protected
int
$rewriteStatusCode
$stringRepresentationBlank
Whether blank string representations are valid
protected
bool
$stringRepresentationBlank
= false
Whether blank string representations are valid
Tags
$stringRepresentationFields
List of fields that should be available in the string representation
protected
array<string|int, mixed>
$stringRepresentationFields
= array()
List of field names
Tags
$stringRepresentationFormat
Sprintf format for the string representation
protected
string
$stringRepresentationFormat
= ''
Sprintf format string
Tags
$validators
Initialize this array as follows: array( 'columName' => Zend_Validate )
protected
array<string|int, mixed>
$validators
= array()
$virtual
Defines if an entity is virtual and therefore not persistable.
protected
bool
$virtual
= false
Defaults to FALSE - not virtual.
Methods
__call()
Route methods like getName(), getType(), getDirectory(), etc.
public
__call(string $methodName, array<string|int, mixed> $arguments) : mixed
Parameters
- $methodName : string
-
Name of method to call
- $arguments : array<string|int, mixed>
-
List of arguments for the method to call
Tags
Attributes
- #[ReturnTypeWillChange]
Return values
mixed —Return value of the method to call
__get()
This is an ugly solution to allow $this->cx to be available in all entity classes Since the entity's constructor is not called when an entity is loaded from DB this cannot be assigned there.
public
__get(mixed $name) : mixed
Parameters
- $name : mixed
Attributes
- #[ReturnTypeWillChange]
__toString()
Returns this entity's identifying value
public
__toString() : string
By default this returns the same as getKeyAsString(), but this method might get overridden by subclasses.
Return values
string —Identifying value for this entity
getActive()
Get active flag
public
getActive() : bool
Return values
bool —Whether this rule is active or not
getComponentController()
Returns the component controller for this component
public
getComponentController() : SystemComponent
Return values
SystemComponentgetContinueOnMatch()
public
getContinueOnMatch() : bool
Return values
boolgetId()
Get id
public
getId() : int
Return values
intgetKeyAsString()
Returns this entity's key
public
final getKeyAsString([string $separator = '/' ]) : string
If this entity has a composite key, the fields are separated by $separator.
Parameters
- $separator : string = '/'
-
(optional) Separator for composite key fields, default "/"
Return values
string —Entity key as string
getOrderNo()
Get the order no
public
getOrderNo() : int
Return values
intgetRegularExpression()
Get Regular expression
public
getRegularExpression() : RegularExpression
Return values
RegularExpressiongetRewriteStatusCode()
Get Rewrite Status Code
public
getRewriteStatusCode() : int
Return values
intgetTranslatedFieldValue()
Returns the value of a translatable field using fallback mechanisms
public
getTranslatedFieldValue(string $fieldName) : mixed
If the field is not translatable its value is returned anyway. Tries to return the value in the following locales (if non-empty):
- Current locale
- Default locale
- All other locales
Parameters
- $fieldName : string
-
Name of a translatable field
initializeValidators()
Set $this->validators
public
initializeValidators() : mixed
Validators can be found in lib/FRAMEWORK/Validator.class.php These will be executed if validate() is called
isVirtual()
Returns the virtuality of the entity
public
isVirtual() : bool
Return values
bool —TRUE if the entity is virtual, otherwise FALSE
matches()
public
matches(Url $url) : mixed
Parameters
- $url : Url
resolve()
Resolve
public
resolve(Url $url, mixed &$continue) : mixed
Parameters
- $url : Url
- $continue : mixed
Tags
setActive()
Set active flag
public
setActive(bool $active) : mixed
Parameters
- $active : bool
-
Whether this rule should be active or not
setContinueOnMatch()
Set continue on match
public
setContinueOnMatch(bool $continueOnMatch) : mixed
Parameters
- $continueOnMatch : bool
setOrderNo()
Set the order no
public
setOrderNo(int $orderNo) : mixed
Parameters
- $orderNo : int
setRegularExpression()
Set regular expression
public
setRegularExpression(mixed $regularExpression) : mixed
Parameters
- $regularExpression : mixed
-
\Cx\Lib\Helpers\RegularExpression or string
setRewriteStatusCode()
Set the rewrite status code
public
setRewriteStatusCode(int $rewriteStatusCode) : mixed
Parameters
- $rewriteStatusCode : int
setVirtual()
Set the virtuality of the entity
public
setVirtual(bool $virtual) : mixed
Parameters
- $virtual : bool
-
TRUE to set the entity as virtual or otherwise to FALSE
validate()
public
validate() : mixed
Tags
getFallbackLocaleCodes()
Returns a list of all locale codes ordered by fallback order
protected
getFallbackLocaleCodes() : array<string|int, mixed>
- First entry is the current locale
- Second entry is the default locale (if different from current, it's omitted otherwise)
- Then all other locales follow (in no particular order)
Tags
Return values
array<string|int, mixed> —List of locale codes
getStringRepresentationBlank()
Whether blank string representations are valid
protected
getStringRepresentationBlank() : bool
Return values
bool —Whether blank string representations are valid
getStringRepresentationFields()
Returns a list of fields available in the string representation
protected
getStringRepresentationFields() : array<string|int, mixed>
Return values
array<string|int, mixed> —List of field names
getStringRepresentationFormat()
Returns the sprintf() format for the string representation
protected
getStringRepresentationFormat() : string
Return values
string —sprintf() format string