Limitations reference

Intro

Limitations are the building blocks of the permission system in "Platfor= m stack", they provide the limitations you can apply to a given access righ= t to limit the right to certain conditions.

Limitations consists of two parts:

Limitation (Value)
LimitationType

Certain limitations are also "RoleLimitations", meaning they can be used= to limit the rights of a Role assignment, this is currently Subtree<= /code> and Section limitation.


The Limitation represent the value, while LimitationT=
ype deals with the business logic surrounding how it actually works =
and is enforced.
LimitationTypes have two modes of operation in regards =
to permission logic (see eZ\Publish\SPI\Limitation\Type i=
nterface for more info):




Method
Used when


eval=
uate
Evaluating=
 if user has access to a given object in a certain context (for instance a =
context can be Locations when object is Content), under the co=
ndition of the Limitation value(s)


getC=
riterion
Generates =
a Criterion using Limitation value and current us=
er which SearchService by default applies to search criteria f=
or filtering search based on permissions




List of Limitations




Limitation
Description


BlockingLimitation
Generic limitation that always tel=
ls permission system that user have no access, causing it to continue to ne=
xt policy.


ContentTypeLimitation
Limits content access depending on its Con=
tentType.


L=
anguageLimitation
Limits content access depending on its Lan=
guage.


L=
ocationLimitation
Limits content access depending on its Loc=
ation.


NewObjectStateLimitation
Limits content ObjectState a=
ssignment access depending on new state.


NewSectionLimitation
Limits content section assignment access d=
epending on new section.


ObjectStateLimitation
Limits content access depending on its Obj=
ectStates.


Owne=
rLimitation
Limits content access depending on its own=
er, as in only access if your owner of the content.


ParentContentTypeLimitation
Limits content (create) access depending o=
n parent location ContentType, as in only access if parent is in this/these=
 type of content.


ParentDepthLimitation
Limits content (create) access depending o=
n parent location depth, as in only access if parent is in a given depth of=
 the tree structure.


ParentOwnerLimitation
Limits content (create) access depending o=
n parent location content owner, as in only access if your you=
r owner of parent.


ParentUserGroupLimitation
Limits content (create) access depending o=
n parent location content owner user group, as in only access =
if your your in same user group as owner of parent.


Se=
ctionLimitation
Limits content access depending on its Section.<=
/td>


SiteAccessLimitation
Limits access to an action depending on siteacce=
s, typically used for user/login, NOTE: this limitation is planned for 5.3 =
and it's new login system


Su=
btreeLimitation
Limits content access depending on its sec=
tion.


Use=
rGroupLimitation
Limits content access depending on its own=
er user group, as in only access if your your in same user group as owner.<=
/span>

Method	Used when
`eval= uate`	Evaluating= if user has access to a given object in a certain context (for instance a = context can be Locations when object is `Content`), under the co= ndition of the `Limitation` value(s)
`getC= riterion`	Generates = a `Criterion` using `Limitation` value and current us= er which `SearchService` by default applies to search criteria f= or filtering search based on permissions

Limitation	Description
BlockingLimitation	Generic limitation that always tel= ls permission system that user have no access, causing it to continue to ne= xt policy.
ContentTypeLimitation	Limits content access depending on its Con= tentType.
L= anguageLimitation	Limits content access depending on its Lan= guage.
L= ocationLimitation	Limits content access depending on its Loc= ation.
NewObjectStateLimitation	Limits content ObjectState a= ssignment access depending on new state.
NewSectionLimitation	Limits content section assignment access d= epending on new section.
ObjectStateLimitation	Limits content access depending on its Obj= ectStates.
Owne= rLimitation	Limits content access depending on its own= er, as in only access if your owner of the content.
ParentContentTypeLimitation	Limits content (create) access depending o= n parent location ContentType, as in only access if parent is in this/these= type of content.
ParentDepthLimitation	Limits content (create) access depending o= n parent location depth, as in only access if parent is in a given depth of= the tree structure.
ParentOwnerLimitation	Limits content (create) access depending o= n parent location content owner, as in only access if your you= r owner of parent.
ParentUserGroupLimitation	Limits content (create) access depending o= n parent location content owner user group, as in only access = if your your in same user group as owner of parent.
Se= ctionLimitation	Limits content access depending on its Section.<= /td>
SiteAccessLimitation	Limits access to an action depending on siteacce= s, typically used for user/login, NOTE: this limitation is planned for 5.3 = and it's new login system
Su= btreeLimitation	Limits content access depending on its sec= tion.
Use= rGroupLimitation	Limits content access depending on its own= er user group, as in only access if your your in same user group as owner.<= /span>