code
stringlengths 31
1.39M
| docstring
stringlengths 23
16.8k
| func_name
stringlengths 1
126
| language
stringclasses 1
value | repo
stringlengths 7
63
| path
stringlengths 7
166
| url
stringlengths 50
220
| license
stringclasses 7
values |
|---|---|---|---|---|---|---|---|
public function getRanges($type, $includeExpired = false)
{
$rangeEntities = $this->getFailedLoginService()->getRanges($type, $includeExpired);
foreach ($rangeEntities as $rangeEntity) {
yield IPRange::createFromEntity($rangeEntity);
}
}
|
@deprecated use $app->make('failed_login')->getRanges()
@param int $type (one of the IPService::IPRANGETYPE_... constants)
@param bool $includeExpired Include expired records?
@return \Concrete\Core\Permission\IPRange[]|\Generator
|
getRanges
|
php
|
concretecms/concretecms
|
concrete/src/Permission/IPService.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/IPService.php
|
MIT
|
public function getRangeByID($id)
{
$rangeEntity = $this->getFailedLoginService()->getRangeByID($id);
return $rangeEntity === null ? null : IPRange::createFromEntity($rangeEntity);
}
|
@deprecated use $app->make('failed_login')->getRangeByID()
@param int $id
@return \Concrete\Core\Permission\IPRange|null
|
getRangeByID
|
php
|
concretecms/concretecms
|
concrete/src/Permission/IPService.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/IPService.php
|
MIT
|
public function deleteRange($range)
{
if (!$range) {
return;
}
$id = $range instanceof IPRange ? $range->getID() : $range;
$this->getFailedLoginService()->deleteRange($id);
}
|
@deprecated use $app->make('failed_login')->deleteRange()
@param \Concrete\Core\Permission\IPRange|int $range
|
deleteRange
|
php
|
concretecms/concretecms
|
concrete/src/Permission/IPService.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/IPService.php
|
MIT
|
public function deleteFailedLoginAttempts($maxAge = null)
{
return $this->getFailedLoginService()->deleteEvents($maxAge);
}
|
@deprecated use $app->make('failed_login')->deleteEvents()
@param int|null $maxAge
@return int
|
deleteFailedLoginAttempts
|
php
|
concretecms/concretecms
|
concrete/src/Permission/IPService.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/IPService.php
|
MIT
|
public function deleteAutomaticDenylist($onlyExpired = true)
{
return $this->getFailedLoginService()->deleteAutomaticDenylist($onlyExpired);
}
|
@deprecated use $app->make('failed_login')->deleteAutomaticDenylist()
@param bool $onlyExpired
@return int
|
deleteAutomaticDenylist
|
php
|
concretecms/concretecms
|
concrete/src/Permission/IPService.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/IPService.php
|
MIT
|
public function getRequestIP()
{
$ip = $this->app->make(AddressInterface::class);
return new IPAddress((string) $ip);
}
|
@deprecated Use $app->make(\IPLib\Address\AddressInterface::class)
@return \Concrete\Core\Utility\IPAddress
|
getRequestIP
|
php
|
concretecms/concretecms
|
concrete/src/Permission/IPService.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/IPService.php
|
MIT
|
public function isBanned($ip = false)
{
$ipAddress = null;
if ($ip instanceof IPAddress) {
$ipAddress = IPFactory::parseAddressString($ip->getIp(IPAddress::FORMAT_IP_STRING));
}
return $this->getFailedLoginService()->isDenylisted($ipAddress);
}
|
@deprecated use $app->make('failed_login')->isDenylisted()
@param mixed $ip
|
isBanned
|
php
|
concretecms/concretecms
|
concrete/src/Permission/IPService.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/IPService.php
|
MIT
|
public function createIPBan($ip = false, $ignoreConfig = false)
{
$ipAddress = null;
if ($ip instanceof IPAddress) {
$ipAddress = IPFactory::parseAddressString($ip->getIp(IPAddress::FORMAT_IP_STRING));
}
$this->getFailedLoginService()->addToDenylistForThresholdReached($ipAddress, $ignoreConfig);
}
|
@deprecated use $app->make('failed_login')->addToDenylistForThresholdReached()
@param mixed $ip
@param mixed $ignoreConfig
|
createIPBan
|
php
|
concretecms/concretecms
|
concrete/src/Permission/IPService.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/IPService.php
|
MIT
|
public function logSignupRequest($ignoreConfig = false)
{
return $this->getFailedLoginService()->registerEvent(null, $ignoreConfig);
}
|
@deprecated use $app->make('failed_login')->registerEvent()
@param bool $ignoreConfig
|
logSignupRequest
|
php
|
concretecms/concretecms
|
concrete/src/Permission/IPService.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/IPService.php
|
MIT
|
public function signupRequestThreshholdReached($ignoreConfig = false)
{
return $this->getFailedLoginService()->isThresholdReached(null, $ignoreConfig);
}
|
@deprecated use $app->make('failed_login')->isThresholdReached()
@param bool $ignoreConfig
|
signupRequestThreshholdReached
|
php
|
concretecms/concretecms
|
concrete/src/Permission/IPService.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/IPService.php
|
MIT
|
public function signupRequestThresholdReached($ignoreConfig = false)
{
return $this->getFailedLoginService()->isThresholdReached(null, $ignoreConfig);
}
|
@deprecated use $app->make('failed_login')->isThresholdReached()
@param bool $ignoreConfig
|
signupRequestThresholdReached
|
php
|
concretecms/concretecms
|
concrete/src/Permission/IPService.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/IPService.php
|
MIT
|
protected function getRangeType(AddressInterface $ip)
{
$range = $this->getFailedLoginService()->getRange($ip);
return $range === null ? null : $range->getType();
}
|
@deprecated use $app->make('failed_login')->getRangeType()
@param \IPLib\Address\AddressInterface $ip
@return int|null
|
getRangeType
|
php
|
concretecms/concretecms
|
concrete/src/Permission/IPService.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/IPService.php
|
MIT
|
public function setListItems($listItems)
{
$this->listItems = $listItems;
}
|
@param \Concrete\Core\Permission\Access\ListItem\ListItem[] $listItems
|
setListItems
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/Access.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/Access.php
|
MIT
|
public function setPermissionKey($permissionKey)
{
$this->pk = $permissionKey;
}
|
@param \Concrete\Core\Permission\Key\Key $permissionKey
|
setPermissionKey
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/Access.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/Access.php
|
MIT
|
public function getPermissionObject()
{
return $this->pk->getPermissionObject();
}
|
Get the object associated to the permission (for example, a Page instance).
@return object
|
getPermissionObject
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/Access.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/Access.php
|
MIT
|
public function getPermissionObjectToCheck()
{
return $this->pk->getPermissionObjectToCheck();
}
|
Get the object to be used to check the permission (for example, a Page instance).
@return object
|
getPermissionObjectToCheck
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/Access.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/Access.php
|
MIT
|
public function validateAndFilterAccessEntities($accessEntities)
{
$entities = [];
foreach ($accessEntities as $ae) {
if ($ae->validate($this)) {
$entities[] = $ae;
}
}
return $entities;
}
|
@param \Concrete\Core\Permission\Access\Entity\Entity[] $accessEntities
@return \Concrete\Core\Permission\Access\Entity\Entity[]
|
validateAndFilterAccessEntities
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/Access.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/Access.php
|
MIT
|
public function validateAccessEntities($accessEntities)
{
$valid = false;
$accessEntities = $this->validateAndFilterAccessEntities($accessEntities);
$list = $this->getAccessListItems(PermissionKey::ACCESS_TYPE_ALL, $accessEntities);
$list = PermissionDuration::filterByActive($list);
foreach ($list as $l) {
switch ($l->getAccessType()) {
case PermissionKey::ACCESS_TYPE_INCLUDE:
$valid = true;
break;
case PermissionKey::ACCESS_TYPE_EXCLUDE:
$valid = false;
break;
}
}
return $valid;
}
|
@param \Concrete\Core\Permission\Access\Entity\Entity[] $accessEntities
@return bool
|
validateAccessEntities
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/Access.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/Access.php
|
MIT
|
public function getAccessListItems($accessType = PermissionKey::ACCESS_TYPE_INCLUDE, $filterEntities = [], $checkCache = true)
{
if (count($this->paIDList) > 0) {
$q = 'select paID, peID, pdID, accessType from PermissionAccessList where paID in (' . implode(',', $this->paIDList) . ')';
return $this->deliverAccessListItems($q, $accessType, $filterEntities);
}
// Sometimes we want to disable cache checking here because we're going to be
// adding items to the cache from a class that subclasses this one. See
// AddBlockToAreaAreaAccess
if ($checkCache) {
$app = Application::getFacadeApplication();
$cache = $app->make('cache/request');
$item = $cache->getItem($this->getCacheIdentifier($accessType, $filterEntities));
if (!$item->isMiss()) {
return $item->get();
}
$item->lock();
}
$q = 'select paID, peID, pdID, accessType from PermissionAccessList where paID = ' . $this->getPermissionAccessID();
$items = $this->deliverAccessListItems($q, $accessType, $filterEntities);
if ($checkCache) {
$cache->save($item->set($items));
}
return $items;
}
|
@param int $accessType
@param \Concrete\Core\Permission\Access\Entity\Entity[] $filterEntities
@param bool $checkCache
@return \Concrete\Core\Permission\Access\ListItem\ListItem[]
|
getAccessListItems
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/Access.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/Access.php
|
MIT
|
public function attachWorkflow(Workflow $wf)
{
$app = Application::getFacadeApplication();
$db = $app->make(Connection::class);
$db->replace(
'PermissionAccessWorkflows',
['paID' => $this->getPermissionAccessID(), 'wfID' => $wf->getWorkflowID()],
['paID', 'wfID'],
true
);
}
|
@param \Concrete\Core\Workflow\Workflow $wf
|
attachWorkflow
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/Access.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/Access.php
|
MIT
|
public function removeWorkflow(Workflow $wf)
{
$app = Application::getFacadeApplication();
$db = $app->make(Connection::class);
$db->executeQuery(
'delete from PermissionAccessWorkflows where paID = ? and wfID = ?',
[$this->getPermissionAccessID(), $wf->getWorkflowID()]
);
}
|
@param \Concrete\Core\Workflow\Workflow $wf
|
removeWorkflow
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/Access.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/Access.php
|
MIT
|
public function duplicate($newPA = false)
{
if (!$newPA) {
$newPA = self::create($this->pk);
}
$listItems = $this->getAccessListItems(PermissionKey::ACCESS_TYPE_ALL);
foreach ($listItems as $li) {
$newPA->addListItem($li->getAccessEntityObject(), $li->getPermissionDurationObject(), $li->getAccessType());
}
$workflows = $this->getWorkflows();
foreach ($workflows as $wf) {
$newPA->attachWorkflow($wf);
}
$newPA->setPermissionKey($this->pk);
return $newPA;
}
|
@param \Concrete\Core\Permission\Access\Access|null|false $newPA
@return \Concrete\Core\Permission\Access\Access
|
duplicate
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/Access.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/Access.php
|
MIT
|
public function addListItem(PermissionAccessEntity $pae, $durationObject = false, $accessType = PermissionKey::ACCESS_TYPE_INCLUDE)
{
$app = Application::getFacadeApplication();
$db = $app->make(Connection::class);
if ($durationObject instanceof PermissionDuration) {
$pdID = $durationObject->getPermissionDurationID();
} else {
$pdID = 0;
}
$db->replace(
'PermissionAccessList',
[
'paID' => $this->getPermissionAccessID(),
'peID' => $pae->getAccessEntityID(),
'pdID' => $pdID,
'accessType' => $accessType,
],
['paID', 'peID'],
false
);
}
|
@param \Concrete\Core\Permission\Access\Entity\Entity $pae
@param \Concrete\Core\Permission\Duration|null|false $durationObject
@param int $accessType
|
addListItem
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/Access.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/Access.php
|
MIT
|
public function removeListItem(PermissionAccessEntity $pe)
{
$app = Application::getFacadeApplication();
$db = $app->make(Connection::class);
$db->executeQuery(
'delete from PermissionAccessList where peID = ? and paID = ?',
[$pe->getAccessEntityID(), $this->getPermissionAccessID()]
);
}
|
@param \Concrete\Core\Permission\Access\Entity\Entity $pe
|
removeListItem
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/Access.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/Access.php
|
MIT
|
public static function create(PermissionKey $pk)
{
$app = Application::getFacadeApplication();
$db = $app->make(Connection::class);
$db->executeQuery('insert into PermissionAccess (paIsInUse) values (0)');
return static::getByID($db->lastInsertId(), $pk);
}
|
@param \Concrete\Core\Permission\Key\Key $pk
@return \Concrete\Core\Permission\Access\Access
|
create
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/Access.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/Access.php
|
MIT
|
public static function getByID($paID, PermissionKey $pk, $checkPA = true)
{
$app = Application::getFacadeApplication();
$cache = $app->make('cache/request');
$identifier = sprintf('permission/access/%s/%s', $pk->getPermissionKeyID(), $paID);
$item = $cache->getItem($identifier);
if (!$item->isMiss()) {
return $item->get();
}
$db = $app->make(Connection::class);
$handle = $pk->getPermissionKeyCategoryHandle();
if ($pk->permissionKeyHasCustomClass()) {
$handle = $pk->getPermissionKeyHandle() . '_' . $handle;
}
$class = '\\Core\\Permission\\Access\\' . $app->make('helper/text')->camelcase($handle) . 'Access';
$class = core_class($class, $pk->getPackageHandle());
$obj = null;
if ($checkPA) {
if ($paID) {
$row = $db->fetchAssoc('select paID, paIsInUse from PermissionAccess where paID = ?', [$paID]);
if ($row) {
$obj = $app->make($class);
$obj->setPropertiesFromArray($row);
}
}
} else { // we got here from an assignment object so we already know its in use.
$obj = $app->make($class);
$obj->paID = $paID;
$obj->paIsInUse = true;
}
if ($obj !== null) {
$obj->setPermissionKey($pk);
}
$item->set($obj);
return $obj;
}
|
@param int $paID
@param \Concrete\Core\Permission\Key\Key $pk
@param bool $checkPA
@return \Concrete\Core\Permission\Access\Access|null
|
getByID
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/Access.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/Access.php
|
MIT
|
protected function deliverAccessListItems($q, $accessType, $filterEntities)
{
$app = Application::getFacadeApplication();
$db = $app->make(Connection::class);
if ($this->pk->permissionKeyHasCustomClass()) {
$class = '\\Concrete\\Core\\Permission\\Access\\ListItem\\' . $app->make('helper/text')->camelcase($this->pk->getPermissionKeyHandle() . '_' . $this->pk->getPermissionKeyCategoryHandle()) . 'ListItem';
} else {
$class = '\\Concrete\\Core\\Permission\\Access\\ListItem\\' . $app->make('helper/text')->camelcase($this->pk->getPermissionKeyCategoryHandle()) . 'ListItem';
}
if (!class_exists($class)) {
$class = '\\Concrete\\Core\\Permission\\Access\\ListItem\\ListItem';
}
// Now that we have the proper list item class, let's see if we have a custom list item array we've passed
// in from the contents of another permission key. If we do, we loop through those, setting their relevant
// parameters on our new access list item
$list = [];
if ($this->listItems !== null) {
foreach ($this->listItems as $listItem) {
$addToList = false;
if (count($filterEntities) > 0) {
foreach ($filterEntities as $filterEntity) {
if ($filterEntity->getAccessEntityID() == $listItem->getAccessEntityObject()->getAccessEntityID()) {
$addToList = true;
break;
}
}
} else {
$addToList = true;
}
if ($addToList) {
$obj = $app->make($class);
/* @var \Concrete\Core\Permission\Access\ListItem\ListItem $obj */
$obj->setAccessType($listItem->getAccessType());
$obj->setPermissionAccessID($listItem->getPermissionAccessID());
$obj->setAccessEntityObject($listItem->getAccessEntityObject());
$obj->setPermissionDurationObject($listItem->getPermissionDurationObject());
$list[] = $obj;
}
}
} else {
$filterString = $this->buildAssignmentFilterString($accessType, $filterEntities);
$q = $q . ' ' . $filterString;
$r = $db->executeQuery($q);
while (($row = $r->fetch(PDO::FETCH_ASSOC)) !== false) {
$obj = $app->build($class);
$obj->setPropertiesFromArray($row);
if ($row['pdID']) {
$obj->loadPermissionDurationObject($row['pdID']);
}
if ($row['peID']) {
$obj->loadAccessEntityObject($row['peID']);
}
$list[] = $obj;
}
}
return $list;
}
|
@param string $q
@param int $accessType
@param \Concrete\Core\Permission\Access\Entity\Entity[] $filterEntities
@return \Concrete\Core\Permission\Access\ListItem\ListItem[]
|
deliverAccessListItems
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/Access.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/Access.php
|
MIT
|
protected function getCacheIdentifier($accessType, $filterEntities = [])
{
$filter = $accessType . ':';
foreach ($filterEntities as $pae) {
$filter .= $pae->getAccessEntityID() . ':';
}
$filter = trim($filter, ':');
if ($this->listItems !== null) {
$aeIDs = [];
foreach ($this->listItems as $listItem) {
$aeIDs[] = $listItem->getPermissionAccessID();
}
$paID = implode(':', $aeIDs);
} else {
$paID = $this->getPermissionAccessID();
}
$class = strtolower(get_class($this->pk));
return sprintf('permission/access/list_items/%s/%s/%s', $paID, $filter, $class);
}
|
@param int $accessType
@param \Concrete\Core\Permission\Access\Entity\Entity[] $filterEntities
@return string
|
getCacheIdentifier
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/Access.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/Access.php
|
MIT
|
protected function buildAssignmentFilterString($accessType, $filterEntities)
{
$peIDs = '';
$filters = [];
if (count($filterEntities) > 0) {
foreach ($filterEntities as $ent) {
$filters[] = $ent->getAccessEntityID();
}
$peIDs .= 'and peID in (' . implode(',', $filters) . ')';
}
if ($accessType == 0) {
$accessType = '';
} else {
$app = Application::getFacadeApplication();
$connection = $app->make(Connection::class);
$accessType = $connection->quote($accessType, PDO::PARAM_INT);
$accessType = ' and accessType = ' . $accessType;
}
return $peIDs . ' ' . $accessType . ' order by accessType desc'; // we order desc so that excludes come last (-1)
}
|
@param int $accessType
@param \Concrete\Core\Permission\Access\Entity\Entity[] $filterEntities
@return string
|
buildAssignmentFilterString
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/Access.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/Access.php
|
MIT
|
public function duplicate($newPA = false)
{
$newPA = parent::duplicate($newPA);
$app = Application::getFacadeApplication();
$db = $app->make(Connection::class);
$r = $db->executeQuery('select * from AreaPermissionBlockTypeAccessList where paID = ?', [$this->getPermissionAccessID()]);
while (($row = $r->fetch(PDO::FETCH_ASSOC)) !== false) {
$db->insert('AreaPermissionBlockTypeAccessList', [
'peID' => $row['peID'],
'paID' => $newPA->getPermissionAccessID(),
'permission' => $row['permission'],
]);
}
$r = $db->executeQuery('select * from AreaPermissionBlockTypeAccessListCustom where paID = ?', [$this->getPermissionAccessID()]);
while (($row = $r->fetch(PDO::FETCH_ASSOC)) !== false) {
$db->insert('AreaPermissionBlockTypeAccessListCustom', [
'peID' => $row['peID'],
'paID' => $newPA->getPermissionAccessID(),
'btID' => $row['btID'],
]);
}
return $newPA;
}
|
{@inheritdoc}
@see \Concrete\Core\Permission\Access\Access::duplicate()
|
duplicate
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/AddBlockToAreaAreaAccess.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/AddBlockToAreaAreaAccess.php
|
MIT
|
public function getAccessListItems($accessType = PermissionKey::ACCESS_TYPE_INCLUDE, $filterEntities = [], $checkCache = true)
{
$app = Application::getFacadeApplication();
if ($checkCache) {
$cache = $app->make('cache/request');
$item = $cache->getItem($this->getCacheIdentifier($accessType, $filterEntities));
if (!$item->isMiss()) {
return $item->get();
}
$item->lock();
}
$db = $app->make(Connection::class);
$list = parent::getAccessListItems($accessType, $filterEntities, false);
$pobj = $this->getPermissionObjectToCheck();
foreach ($list as $l) {
$pe = $l->getAccessEntityObject();
if ($pobj instanceof Page) {
$permission = $db->fetchColumn('select permission from BlockTypePermissionBlockTypeAccessList where paID = ?', [$l->getPermissionAccessID()]);
} else {
$permission = $db->fetchColumn('select permission from AreaPermissionBlockTypeAccessList where peID = ? and paID = ?', [$pe->getAccessEntityID(), $l->getPermissionAccessID()]);
}
if ($permission != 'N' && $permission != 'C') {
$permission = 'A';
}
$l->setBlockTypesAllowedPermission($permission);
if ($permission == 'C') {
if ($pobj instanceof Area) {
$rs = $db->executeQuery('select btID from AreaPermissionBlockTypeAccessListCustom where peID = ? and paID = ?', [$pe->getAccessEntityID(), $l->getPermissionAccessID()]);
} else {
$rs = $db->executeQuery('select btID from BlockTypePermissionBlockTypeAccessListCustom where paID = ?', [$l->getPermissionAccessID()]);
}
$btIDs = [];
while (($btID = $rs->fetchColumn()) !== false) {
$btIDs[] = (int) $btID;
}
$l->setBlockTypesAllowedArray($btIDs);
}
}
if ($checkCache) {
$cache->save($item->set($list));
}
return $list;
}
|
{@inheritdoc}
@see \Concrete\Core\Permission\Access\Access::getAccessListItems()
|
getAccessListItems
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/AddBlockToAreaAreaAccess.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/AddBlockToAreaAreaAccess.php
|
MIT
|
public function save($args = [])
{
$app = Application::getFacadeApplication();
$db = $app->make(Connection::class);
parent::save($args);
$db->executeQuery('delete from AreaPermissionBlockTypeAccessList where paID = ?', [$this->getPermissionAccessID()]);
$db->executeQuery('delete from AreaPermissionBlockTypeAccessListCustom where paID = ?', [$this->getPermissionAccessID()]);
if (isset($args['blockTypesIncluded']) && is_array($args['blockTypesIncluded'])) {
foreach ($args['blockTypesIncluded'] as $peID => $permission) {
$v = [$this->getPermissionAccessID(), $peID, $permission];
$db->executeQuery('insert into AreaPermissionBlockTypeAccessList (paID, peID, permission) values (?, ?, ?)', $v);
}
}
if (isset($args['blockTypesExcluded']) && is_array($args['blockTypesExcluded'])) {
foreach ($args['blockTypesExcluded'] as $peID => $permission) {
$v = [$this->getPermissionAccessID(), $peID, $permission];
$db->executeQuery('insert into AreaPermissionBlockTypeAccessList (paID, peID, permission) values (?, ?, ?)', $v);
}
}
if (isset($args['btIDInclude']) && is_array($args['btIDInclude'])) {
foreach ($args['btIDInclude'] as $peID => $btIDs) {
foreach ($btIDs as $btID) {
$v = [$this->getPermissionAccessID(), $peID, $btID];
$db->executeQuery('insert into AreaPermissionBlockTypeAccessListCustom (paID, peID, btID) values (?, ?, ?)', $v);
}
}
}
if (isset($args['btIDExclude']) && is_array($args['btIDExclude'])) {
foreach ($args['btIDExclude'] as $peID => $btIDs) {
foreach ($btIDs as $btID) {
$v = [$this->getPermissionAccessID(), $peID, $btID];
$db->executeQuery('insert into AreaPermissionBlockTypeAccessListCustom (paID, peID, btID) values (?, ?, ?)', $v);
}
}
}
}
|
{@inheritdoc}
@see \Concrete\Core\Permission\Access\Access::save()
|
save
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/AddBlockToAreaAreaAccess.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/AddBlockToAreaAreaAccess.php
|
MIT
|
public function getAccessEntityUsers(PermissionAccess $pa)
{
$message = $pa->getPermissionObject();
if (is_object($message) && ($message instanceof Message)) {
return app(UserInfoRepository::class)->getByID($message->getConversationMessageUserID());
}
return [];
}
|
@param PermissionAccess $pa
@return \Concrete\Core\User\UserInfo[]
|
getAccessEntityUsers
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/Entity/ConversationMessageAuthorEntity.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/Entity/ConversationMessageAuthorEntity.php
|
MIT
|
public function validate(PermissionAccess $pae)
{
$message = null;
if ($pae instanceof ConversationAccess) {
$message = $pae->getPermissionObject();
}
if ($message instanceof Message) {
$app = Application::getFacadeApplication();
$u = $app->make(User::class);
return $u->getUserID() == $message->getConversationMessageUserID();
}
return false;
}
|
@param PermissionAccess $pae
@throws \Illuminate\Contracts\Container\BindingResolutionException
@return bool
|
validate
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/Entity/ConversationMessageAuthorEntity.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/Entity/ConversationMessageAuthorEntity.php
|
MIT
|
public static function getAccessEntitiesForUser($user)
{
$entities = [];
/** @var Connection $db */
$db = app(Connection::class);
if (is_object($user) && $user->isRegistered()) {
$pae = static::getOrCreate();
$r = $db->fetchOne('select cnvMessageID from ConversationMessages where uID = ?', [$user->getUserID()]);
if ($r > 0) {
$entities[] = $pae;
}
}
return $entities;
}
|
@param User|\Concrete\Core\Entity\User\User $user
@throws \Doctrine\DBAL\Exception
@return Entity[]
|
getAccessEntitiesForUser
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/Entity/ConversationMessageAuthorEntity.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/Entity/ConversationMessageAuthorEntity.php
|
MIT
|
public static function getOrCreate()
{
/** @var Connection $db */
$db = app(Connection::class);
$petID = $db->fetchOne('select petID from PermissionAccessEntityTypes where petHandle = \'conversation_message_author\'');
$peID = $db->fetchOne(
'select peID from PermissionAccessEntities where petID = ?',
[$petID]
);
if (!$peID) {
$db->executeStatement('insert into PermissionAccessEntities (petID) values(?)', [$petID]);
$peID = $db->lastInsertId();
app('config')->save('concrete.misc.access_entity_updated', time());
}
return \Concrete\Core\Permission\Access\Entity\Entity::getByID($peID);
}
|
@throws \Doctrine\DBAL\Exception
@return Entity|false
|
getOrCreate
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/Entity/ConversationMessageAuthorEntity.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/Entity/ConversationMessageAuthorEntity.php
|
MIT
|
public function getGroups()
{
return $this->groups;
}
|
Function to get the groups belonging to this GroupCombination.
@return Group[] | array
|
getGroups
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/Entity/GroupCombinationEntity.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/Entity/GroupCombinationEntity.php
|
MIT
|
public function getAccessEntityTypeLinkHTML()
{
$html = '<a href="' . h(app(ResolverManagerInterface::class)->resolve(['/ccm/system/dialogs/permissions/access/entity/types/group_combination'])) . '" '
. 'dialog-width="400" dialog-height="300" class="dropdown-item dialog-launch" '
. 'dialog-modal="false" dialog-title="'
. t('Add Group Combination') . '">'
. tc('PermissionAccessEntityTypeName', 'Group Combination')
. '</a>';
return $html;
}
|
Function that returns a html link for the model dialog to be launched from.
@return string
|
getAccessEntityTypeLinkHTML
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/Entity/GroupCombinationEntity.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/Entity/GroupCombinationEntity.php
|
MIT
|
public static function getAccessEntitiesForUser($user)
{
$entities = [];
// If the user isnt registered, there is no need to do this anymore.
if ($user->isRegistered()) {
$ingids = [];
$app = Facade::getFacadeApplication();
/** @var $database \Concrete\Core\Database\Connection\Connection */
$database = $app->make('database')->connection();
// First look for any combos that this group would specifically be in.
// We check if the combos contain any of the groups this user is in.
// That way if there aren't any we can just skip it.
foreach ($user->getUserGroups() as $key => $val) {
$ingids[] = $key;
}
$instr = implode(',', $ingids);
$peIDs = $database->fetchAll(
'select distinct pae.peID from PermissionAccessEntities pae
inner join PermissionAccessEntityTypes paet on pae.petID = paet.petID
inner join PermissionAccessEntityGroups paeg on pae.peID = paeg.peID
where petHandle = \'group_combination\'
and paeg.gID in (' . $instr . ')'
);
// Now for each one we check to see if it applies here.
foreach ($peIDs as $peID) {
$r = $database->fetchAssoc(
'select count(gID) as peGroups,
(select count(UserGroups.gID) from UserGroups where uID = ?
and gID in
(select gID from PermissionAccessEntityGroups where peID = ?))
as uGroups from PermissionAccessEntityGroups where peID = ?',
[$user->getUserID(), $peID['peID'], $peID['peID']]
);
if ($r['peGroups'] == $r['uGroups'] && $r['peGroups'] > 1) {
$entity = Entity::getByID($peID['peID']);
if (is_object($entity)) {
$entities[] = $entity;
}
}
}
}
return $entities;
}
|
Returns all GroupCombination Access Entities for the provided user.
@param \Concrete\Core\User\User | \Concrete\Core\Entity\User\User $user
@return Entity[] | array
|
getAccessEntitiesForUser
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/Entity/GroupCombinationEntity.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/Entity/GroupCombinationEntity.php
|
MIT
|
public static function getOrCreate($groups)
{
$app = Facade::getFacadeApplication();
/** @var $database \Concrete\Core\Database\Connection\Connection */
$database = $app->make('database')->connection();
$petID = $database->fetchColumn(
'select petID from PermissionAccessEntityTypes
where petHandle = \'group_combination\''
);
$query = $database->createQueryBuilder();
$query->select('pae.peID')->from('PermissionAccessEntities', 'pae');
$i = 1;
$query->where('petid = :entityTypeID')->setParameter('entityTypeID', $petID);
foreach ($groups as $group) {
$query
->leftJoin(
'pae',
'PermissionAccessEntityGroups',
'paeg' . $i,
'pae.peID = paeg' . $i . '.peID'
)
->andWhere('paeg' . $i . '.gID = :group' . $i)
->setParameter('group' . $i, $group->getGroupID());
$i++;
}
$peIDs = $query->execute()->fetchAll();
$peID = 0;
// Check for all the groups belonging to this AccessEntity.
if (!empty($peIDs)) {
foreach ($peIDs as $result) {
$allGroups = $database->fetchColumn(
'select count(gID) from PermissionAccessEntityGroups
where peID = ' . $result['peID']
);
if ($allGroups == count($groups)) {
$peID = $result['peID'];
break;
}
}
}
// If the accessEntity doesnt exist, then create a new one.
if (empty($peID)) {
$database->insert('PermissionAccessEntities', ['petID' => $petID]);
$peID = $database->lastInsertId();
$app->make('config')->save(
'concrete.misc.access_entity_updated',
time()
);
foreach ($groups as $group) {
$database->insert(
'PermissionAccessEntityGroups',
['peID' => $peID, 'gID' => $group->getGroupID()]
);
}
}
return self::getByID($peID);
}
|
Function used to get or create a GroupCombination Permission Access Entity.
@param Group[] $groups Groups for this combination.
@return self
|
getOrCreate
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/Entity/GroupCombinationEntity.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/Entity/GroupCombinationEntity.php
|
MIT
|
public function getAccessEntityUsers(PermissionAccess $pa)
{
$userList = new UserList();
$userList->ignorePermissions();
foreach ($this->groups as $g) {
$userList->filterByGroupID($g->getGroupID());
}
return $userList->getResults();
}
|
Get the users who have access to this GroupCombination.
@param PermissionAccess $pa
@return array
|
getAccessEntityUsers
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/Entity/GroupCombinationEntity.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/Entity/GroupCombinationEntity.php
|
MIT
|
public function load()
{
$app = Facade::getFacadeApplication();
/** @var $database \Concrete\Core\Database\Connection\Connection */
$database = $app->make('database')->connection();
$gIDs = $database->fetchAll(
'select gID from PermissionAccessEntityGroups
where peID = ? order by gID asc',
[$this->peID]
);
if ($gIDs && is_array($gIDs)) {
for ($i = 0; $i < count($gIDs); ++$i) {
$g = Group::getByID($gIDs[$i]['gID']);
if (is_object($g)) {
$this->groups[] = $g;
$this->label .= $g->getGroupDisplayName();
if ($i + 1 < count($gIDs)) {
$this->label .= t(
/*i18n: used for combining Group Display Names,
eg GroupName1 + GroupName2 */
' + '
);
}
}
}
}
}
|
Function used to load the properties for this
GroupCombinationEntity from the database.
@return void
|
load
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/Entity/GroupCombinationEntity.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/Entity/GroupCombinationEntity.php
|
MIT
|
public function getAccessEntityTypeClass()
{
$app = Facade::getFacadeApplication();
$entity = $app->make('permission/access/entity/factory')->createEntity($this);
return get_class($entity);
}
|
Returns the controller class for the currently selected captcha library.
|
getAccessEntityTypeClass
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/Entity/Type.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/Entity/Type.php
|
MIT
|
public function getAccessEntityTypeDisplayName($format = 'html')
{
$value = tc('PermissionAccessEntityTypeName', $this->getAccessEntityTypeName());
switch ($format) {
case 'html':
return h($value);
case 'text':
default:
return $value;
}
}
|
Returns the display name for this access entity type (localized and escaped accordingly to $format)
@param string $format = 'html'
Escape the result in html format (if $format is 'html').
If $format is 'text' or any other value, the display name won't be escaped.
@return string
|
getAccessEntityTypeDisplayName
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/Entity/Type.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/Entity/Type.php
|
MIT
|
public function setAccessType($accessType)
{
$this->accessType = $accessType;
}
|
@param int $accessType one of the \Concrete\Core\Permission\Key\Key::ACCESS_TYPE_ constants
@see \Concrete\Core\Permission\Key\Key
|
setAccessType
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/ListItem/ListItem.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/ListItem/ListItem.php
|
MIT
|
public function getAccessType()
{
return $this->accessType;
}
|
@return int one of the \Concrete\Core\Permission\Key\Key::ACCESS_TYPE_ constants
@see \Concrete\Core\Permission\Key\Key
|
getAccessType
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/ListItem/ListItem.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/ListItem/ListItem.php
|
MIT
|
public function getAccessEntityObject()
{
return $this->accessEntity;
}
|
@return \Concrete\Core\Permission\Access\Entity\Entity
|
getAccessEntityObject
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/ListItem/ListItem.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/ListItem/ListItem.php
|
MIT
|
public function setAccessEntityObject($accessEntity)
{
$this->accessEntity = $accessEntity;
}
|
@param \Concrete\Core\Permission\Access\Entity\Entity $accessEntity
|
setAccessEntityObject
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/ListItem/ListItem.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/ListItem/ListItem.php
|
MIT
|
public function setPermissionDurationObject($duration)
{
$this->duration = $duration;
}
|
@param \Concrete\Core\Permission\Duration $duration
|
setPermissionDurationObject
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Access/ListItem/ListItem.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Access/ListItem/ListItem.php
|
MIT
|
public function setPermissionObject($a)
{
$stack = null;
if ($a instanceof Area) {
$areaPage = $a->getAreaCollectionObject();
if ($areaPage instanceof Page && $areaPage->getPageTypeHandle() === STACKS_PAGE_TYPE) {
$stack = $areaPage;
} elseif ($a->isGlobalArea()) {
$stack = Stack::getByName($a->getAreaHandle());
if (!$stack || $stack->isError()) {
$stack = null;
}
}
}
if ($stack !== null) {
$app = Application::getFacadeApplication();
$this->stackAssignment = $app->make(StackAssignment::class);
$this->stackAssignment->setPermissionObject($stack);
$this->stackAssignment->setPermissionKeyObject($this->pk);
$a = Area::getOrCreate($stack, STACKS_AREA_NAME);
} else {
$this->stackAssignment = null;
if ($a instanceof SubArea && !$a->overrideCollectionPermissions()) {
$a = $a->getSubAreaParentPermissionsObject();
}
}
$this->permissionObject = $a;
// if the area overrides the collection permissions explicitly (with a one on the override column) we check
if ($a->overrideCollectionPermissions()) {
$this->permissionObjectToCheck = $a;
} else {
if ($a->getAreaCollectionInheritID() > 0) {
// in theory we're supposed to be inheriting some permissions from an area with the same handle,
// set on the collection id specified above (inheritid). however, if someone's come along and
// reverted that area to the page's permissions, there won't be any permissions, and we
// won't see anything. so we have to check
$areac = Page::getByID($a->getAreaCollectionInheritID());
$inheritArea = Area::get($areac, $a->getAreaHandle());
if ($inheritArea && $inheritArea->overrideCollectionPermissions()) {
// okay, so that area is still around, still has set permissions on it. So we
// pass our current area to our grouplist, userinfolist objects, knowing that they will
// smartly inherit the correct items.
$this->permissionObjectToCheck = $inheritArea;
}
}
if (!$this->permissionObjectToCheck) {
$this->permissionObjectToCheck = $a->getAreaCollectionObject();
}
}
}
|
{@inheritdoc}
@see \Concrete\Core\Permission\Assignment\Assignment::setPermissionObject()
@param \Concrete\Core\Area\Area $a
|
setPermissionObject
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Assignment/AreaAssignment.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Assignment/AreaAssignment.php
|
MIT
|
public function getPermissionAccessObject()
{
if ($this->stackAssignment !== null) {
return $this->stackAssignment->getPermissionAccessObject();
}
return $this->getAreaPermissionAccessObject();
}
|
Get the Access object for the Area or, in case of Stacks and Global Areas, the Access object for the Stack/Global Area.
{@inheritdoc}
@see \Concrete\Core\Permission\Assignment\Assignment::getPermissionAccessObject()
|
getPermissionAccessObject
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Assignment/AreaAssignment.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Assignment/AreaAssignment.php
|
MIT
|
public function getAreaPermissionAccessObject()
{
if ($this->permissionObjectToCheck instanceof Area) {
$app = Application::getFacadeApplication();
$db = $app->make(Connection::class);
$r = $db->fetchColumn(
'select paID from AreaPermissionAssignments where cID = ? and arHandle = ? and pkID = ? ',
[
$this->permissionObjectToCheck->getCollectionID(),
$this->permissionObjectToCheck->getAreaHandle(),
$this->pk->getPermissionKeyID(),
]
);
if ($r) {
return Access::getByID($r, $this->pk, false);
}
} elseif (isset($this->inheritedPermissions[$this->pk->getPermissionKeyHandle()])) {
// this is a page
$pk = PermissionKey::getByHandle($this->inheritedPermissions[$this->pk->getPermissionKeyHandle()]);
$pk->setPermissionObject($this->permissionObjectToCheck);
$pae = $pk->getPermissionAccessObject();
return $pae;
} elseif (isset($this->blockTypeInheritedPermissions[$this->pk->getPermissionKeyHandle()])) {
$pk = PermissionKey::getByHandle($this->blockTypeInheritedPermissions[$this->pk->getPermissionKeyHandle()]);
$pae = $pk->getPermissionAccessObject();
return $pae;
}
return null;
}
|
Get the Access object for the Area, even in case of Stacks and Global Areas.
@return \Concrete\Core\Permission\Access\Access|null
|
getAreaPermissionAccessObject
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Assignment/AreaAssignment.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Assignment/AreaAssignment.php
|
MIT
|
public function setPermissionKeyObject($pk)
{
if ($this->stackAssignment !== null) {
$this->stackAssignment->setPermissionKeyObject($pk);
}
$this->pk = $pk;
}
|
{@inheritdoc}
@see \Concrete\Core\Permission\Assignment\Assignment::setPermissionKeyObject()
|
setPermissionKeyObject
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Assignment/AreaAssignment.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Assignment/AreaAssignment.php
|
MIT
|
public function getPermissionKeyTaskURL(string $task = '', array $options = []): string
{
if ($this->stackAssignment !== null) {
return $this->stackAssignment->getPermissionKeyTaskURL($task, $options);
}
$area = $this->getPermissionObject();
$c = $area->getAreaCollectionObject();
return parent::getPermissionKeyTaskURL($task, $options + ['cID' => $c->getCollectionID(), 'arHandle' => $area->getAreaHandle()]);
}
|
{@inheritdoc}
@see \Concrete\Core\Permission\Assignment\Assignment::getPermissionKeyTaskURL()
|
getPermissionKeyTaskURL
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Assignment/AreaAssignment.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Assignment/AreaAssignment.php
|
MIT
|
public function clearPermissionAssignment()
{
if ($this->stackAssignment !== null) {
return $this->stackAssignment->clearPermissionAssignment();
}
$app = Application::getFacadeApplication();
$db = $app->make(Connection::class);
$area = $this->getPermissionObject();
$c = $area->getAreaCollectionObject();
$db->executeQuery('update AreaPermissionAssignments set paID = 0 where pkID = ? and cID = ? and arHandle = ?', [$this->pk->getPermissionKeyID(), $c->getCollectionID(), $area->getAreaHandle()]);
}
|
{@inheritdoc}
@see \Concrete\Core\Permission\Assignment\Assignment::clearPermissionAssignment()
|
clearPermissionAssignment
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Assignment/AreaAssignment.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Assignment/AreaAssignment.php
|
MIT
|
public function assignPermissionAccess(Access $pa)
{
if ($this->stackAssignment !== null) {
return $this->stackAssignment->assignPermissionAccess($pa);
}
$app = Application::getFacadeApplication();
$db = $app->make(Connection::class);
$db->replace(
'AreaPermissionAssignments',
[
'cID' => $this->getPermissionObject()->getCollectionID(),
'arHandle' => $this->getPermissionObject()->getAreaHandle(),
'paID' => $pa->getPermissionAccessID(),
'pkID' => $this->pk->getPermissionKeyID(),
],
['cID', 'arHandle', 'pkID'],
true
);
$pa->markAsInUse();
}
|
{@inheritdoc}
@see \Concrete\Core\Permission\Assignment\Assignment::assignPermissionAccess()
|
assignPermissionAccess
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Assignment/AreaAssignment.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Assignment/AreaAssignment.php
|
MIT
|
public function setPermissionObject($po)
{
$this->permissionObject = $po;
}
|
Set the object of the permission (for example, a Page instance).
@param \Concrete\Core\Permission\ObjectInterface $po
|
setPermissionObject
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Assignment/Assignment.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Assignment/Assignment.php
|
MIT
|
public function getPermissionObject()
{
return $this->permissionObject;
}
|
Get the object of the permission (for example, a Page instance).
@return \Concrete\Core\Permission\ObjectInterface|null
|
getPermissionObject
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Assignment/Assignment.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Assignment/Assignment.php
|
MIT
|
public function setPermissionKeyObject($pk)
{
$this->pk = $pk;
}
|
@param \Concrete\Core\Permission\Key\Key $pk
|
setPermissionKeyObject
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Assignment/Assignment.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Assignment/Assignment.php
|
MIT
|
public function getPermissionKeyTaskURL(string $task = '', array $options = []): string
{
$class = substr(get_class($this), 0, strrpos(get_class($this), 'PermissionAssignment'));
$handle = uncamelcase($class);
if ($handle === '') {
$akc = PermissionKeyCategory::getByID($this->pk->getPermissionKeyCategoryID());
} else {
$akc = PermissionKeyCategory::getByHandle($handle);
}
$options += ['pkID' => $this->pk->getPermissionKeyID()];
return $akc->getTaskURL($task, $options);
}
|
Build the URL of a task (replaces the previous getPermissionKeyToolsURL method)
@param string $task The task to be executed ('save_permission' if empty)
@param array $options Optional arguments (will be added to the query string).
@return string
|
getPermissionKeyTaskURL
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Assignment/Assignment.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Assignment/Assignment.php
|
MIT
|
public function assignPermissionAccess(Access $pa)
{
$app = Application::getFacadeApplication();
$db = $app->make(Connection::class);
$db->replace(
'PermissionAssignments',
['paID' => $pa->getPermissionAccessID(), 'pkID' => $this->pk->getPermissionKeyID()],
['pkID'],
true
);
$pa->markAsInUse();
}
|
@param \Concrete\Core\Permission\Access\Access $pa
|
assignPermissionAccess
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Assignment/Assignment.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Assignment/Assignment.php
|
MIT
|
public function getPermissionAccessObject()
{
$app = Application::getFacadeApplication();
$cache = $app->make('cache/request');
$identifier = sprintf('permission/key/assignment/%s', $this->pk->getPermissionKeyID());
$item = $cache->getItem($identifier);
if (!$item->isMiss()) {
return $item->get();
}
$item->lock();
$db = $app->make(Connection::class);
$paID = $db->fetchColumn('select paID from PermissionAssignments where pkID = ?', [$this->pk->getPermissionKeyID()]);
$pa = $paID ? Access::getByID($paID, $this->pk) : null;
$cache->save($item->set($pa));
return $pa;
}
|
@return \Concrete\Core\Permission\Access\Access|null
|
getPermissionAccessObject
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Assignment/Assignment.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Assignment/Assignment.php
|
MIT
|
public function getPermissionKeyTaskURL(string $task = '', array $options = []): string
{
return parent::getPermissionKeyTaskURL($task, $options + ['wfID' => $this->getPermissionObject()->getWorkflowID()]);
}
|
{@inheritdoc}
@see \Concrete\Core\Permission\Assignment\Assignment::getPermissionKeyTaskURL()
|
getPermissionKeyTaskURL
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Assignment/BasicWorkflowAssignment.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Assignment/BasicWorkflowAssignment.php
|
MIT
|
public function getPermissionAccessObject()
{
/**
* @var $registry RegistryInterface
*/
$registry = \Core::make('Concrete\Core\Permission\Inheritance\Registry\BlockRegistry');
$db = Database::connection();
if ($this->permissionObjectToCheck instanceof Block) {
$co = $this->permissionObjectToCheck->getBlockCollectionObject();
$paID = $db->GetOne(
'select paID from BlockPermissionAssignments where cID = ? and cvID = ? and bID = ? and pkID = ? ',
array(
$co->getCollectionID(),
$co->getVersionID(),
$this->permissionObject->getBlockID(),
$this->pk->getPermissionKeyID(),
)
);
if ($paID) {
$pae = Access::getByID($paID, $this->pk, false);
}
} elseif ($this->permissionObjectToCheck instanceof Area && $registry->getEntry('area', $this->pk->getPermissionKeyHandle())) {
$pk = PermissionKey::getByHandle($registry->getEntry('area', $this->pk->getPermissionKeyHandle())->getInheritedFromPermissionKeyHandle());
$pk->setPermissionObject($this->permissionObjectToCheck);
$pae = $pk->getPermissionAccessObject();
} elseif ($this->permissionObjectToCheck instanceof Page && $registry->getEntry('page', $this->pk->getPermissionKeyHandle())) {
$pk = PermissionKey::getByHandle($registry->getEntry('page', $this->pk->getPermissionKeyHandle())->getInheritedFromPermissionKeyHandle());
$pk->setPermissionObject($this->permissionObjectToCheck);
$pae = $pk->getPermissionAccessObject();
}
return $pae ?? null;
}
|
{@inheritdoc}
@see \Concrete\Core\Permission\Assignment\Assignment::getPermissionAccessObject()
|
getPermissionAccessObject
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Assignment/BlockAssignment.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Assignment/BlockAssignment.php
|
MIT
|
public function getPermissionKeyTaskURL(string $task = '', array $options = []): string
{
$b = $this->getPermissionObject();
$c = $b->getBlockCollectionObject();
$arHandle = $b->getAreaHandle();
return parent::getPermissionKeyTaskURL($task, $options + ['cID' => $c->getCollectionID(), 'cvID' => $c->getVersionID(), 'bID' => $b->getBlockID(), 'arHandle' => $arHandle]);
}
|
{@inheritdoc}
@see \Concrete\Core\Permission\Assignment\Assignment::getPermissionKeyTaskURL()
|
getPermissionKeyTaskURL
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Assignment/BlockAssignment.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Assignment/BlockAssignment.php
|
MIT
|
public function getPermissionKeyTaskURL(string $task = '', array $options = []): string
{
$board = $this->getPermissionObject();
return parent::getPermissionKeyTaskURL($task, $options + ['boardID' => $board->getBoardID()]);
}
|
{@inheritdoc}
@see \Concrete\Core\Permission\Assignment\Assignment::getPermissionKeyTaskURL()
|
getPermissionKeyTaskURL
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Assignment/BoardAssignment.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Assignment/BoardAssignment.php
|
MIT
|
public function getPermissionKeyTaskURL(string $task = '', array $options = []): string
{
$calendar = $this->getPermissionObject();
return parent::getPermissionKeyTaskURL($task, $options + ['caID' => $calendar->getId()]);
}
|
{@inheritdoc}
@see \Concrete\Core\Permission\Assignment\Assignment::getPermissionKeyTaskURL()
|
getPermissionKeyTaskURL
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Assignment/CalendarAssignment.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Assignment/CalendarAssignment.php
|
MIT
|
public function getPermissionKeyTaskURL(string $task = '', array $options = []): string
{
return parent::getPermissionKeyTaskURL($task, $options + ['cnvID' => is_object($this->permissionObject) ? $this->permissionObject->getConversationID() : 0]);
}
|
{@inheritdoc}
@see \Concrete\Core\Permission\Assignment\Assignment::getPermissionKeyTaskURL()
|
getPermissionKeyTaskURL
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Assignment/ConversationAssignment.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Assignment/ConversationAssignment.php
|
MIT
|
public function getPermissionKeyTaskURL(string $task = '', array $options = []): string
{
return Assignment::getPermissionKeyTaskURL($task, $options + ['fID' => $this->getPermissionObject()->getFileID()]);
}
|
{@inheritdoc}
@see \Concrete\Core\Permission\Assignment\Assignment::getPermissionKeyTaskURL()
|
getPermissionKeyTaskURL
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Assignment/FileAssignment.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Assignment/FileAssignment.php
|
MIT
|
public function getPermissionAccessObject()
{
$app = Application::getFacadeApplication();
$cache = $app->make('cache/request');
$identifier = sprintf(
'permission/assignment/access/%s/%s',
$this->pk->getPermissionKeyHandle(),
$this->getPermissionObject()->getPermissionObjectIdentifier()
);
$item = $cache->getItem($identifier);
if (!$item->isMiss()) {
return $item->get();
}
$db = $app->make(Connection::class);
$r = $db->fetchColumn('select paID from PagePermissionAssignments where cID = ? and pkID = ?', [$this->getPermissionObject()->getPermissionsCollectionID(), $this->pk->getPermissionKeyID()]);
$pa = $r ? Access::getByID($r, $this->pk, false) : null;
if ($pa) {
$permissionObject = $this->getPermissionObject();
if ($permissionObject->isPageDraft() && $permissionObject->getCollectionInheritance() == 'PARENT' && isset($this->inheritedPageTypeDraftPermissions[$this->pk->getPermissionKeyHandle()])) {
$pageType = $permissionObject->getPageTypeObject();
if (is_object($pageType)) {
$pk = Key::getByHandle($this->inheritedPageTypeDraftPermissions[$this->pk->getPermissionKeyHandle()]);
$pk->setPermissionObject($pageType);
$access = $pk->getPermissionAccessObject();
if (is_object($access)) {
$list_items = $access->getAccessListItems();
$pa->setListItems($list_items);
}
}
}
}
$cache->save($item->set($pa));
return $pa;
}
|
{@inheritdoc}
@see \Concrete\Core\Permission\Assignment\Assignment::getPermissionAccessObject()
@return \Concrete\Core\Permission\Access\PageAccess|null
|
getPermissionAccessObject
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Assignment/PageAssignment.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Assignment/PageAssignment.php
|
MIT
|
public function clearPermissionAssignment()
{
$app = Application::getFacadeApplication();
$db = $app->make(Connection::class);
$db->executeQuery('update PagePermissionAssignments set paID = 0 where pkID = ? and cID = ?', [$this->pk->getPermissionKeyID(), $this->getPermissionObject()->getPermissionsCollectionID()]);
$cache = $app->make('cache/request');
$identifier = sprintf(
'permission/assignment/access/%s/%s',
$this->pk->getPermissionKeyHandle(),
$this->getPermissionObject()->getPermissionObjectIdentifier()
);
$cache->delete($identifier);
}
|
{@inheritdoc}
@see \Concrete\Core\Permission\Assignment\Assignment::clearPermissionAssignment()
|
clearPermissionAssignment
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Assignment/PageAssignment.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Assignment/PageAssignment.php
|
MIT
|
public function assignPermissionAccess(Access $pa)
{
$app = Application::getFacadeApplication();
$db = $app->make(Connection::class);
$db->replace(
'PagePermissionAssignments',
['cID' => $this->getPermissionObject()->getPermissionsCollectionID(), 'paID' => $pa->getPermissionAccessID(), 'pkID' => $this->pk->getPermissionKeyID()],
['cID', 'pkID'],
true
);
$pa->markAsInUse();
$cache = $app->make('cache/request');
$identifier = sprintf(
'permission/assignment/access/%s/%s',
$this->pk->getPermissionKeyHandle(),
$this->getPermissionObject()->getPermissionObjectIdentifier()
);
$cache->delete($identifier);
}
|
{@inheritdoc}
@see \Concrete\Core\Permission\Assignment\Assignment::assignPermissionAccess()
|
assignPermissionAccess
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Assignment/PageAssignment.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Assignment/PageAssignment.php
|
MIT
|
public function getPermissionKeyTaskURL(string $task = '', array $options = []): string
{
$pageArray = $this->pk->getMultiplePageArray();
if (is_array($pageArray) && $pageArray !== []) {
$cIDs = [];
foreach ($pageArray as $sc) {
$cIDs[] = $sc->getCollectionID();
}
$options += ['cID' => $cIDs];
} else {
$options += ['cID' => $this->getPermissionObject()->getCollectionID()];
}
return parent::getPermissionKeyTaskURL($task, $options);
}
|
{@inheritdoc}
@see \Concrete\Core\Permission\Assignment\Assignment::getPermissionKeyTaskURL()
|
getPermissionKeyTaskURL
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Assignment/PageAssignment.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Assignment/PageAssignment.php
|
MIT
|
public function getPermissionKeyTaskURL(string $task = '', array $options = []): string
{
return parent::getPermissionKeyTaskURL($task, $options + ['ptID' => $this->getPermissionObject()->getPageTypeID()]);
}
|
{@inheritdoc}
@see \Concrete\Core\Permission\Assignment\Assignment::getPermissionKeyTaskURL()
|
getPermissionKeyTaskURL
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Assignment/PageTypeAssignment.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Assignment/PageTypeAssignment.php
|
MIT
|
public function setPermissionKeyObject($pk)
{
static $map = [
'add_block_to_area' => 'edit_page_contents',
'add_layout_to_area' => 'edit_page_contents',
'add_stack_to_area' => 'edit_page_contents',
'delete_area_contents' => 'edit_page_contents',
'edit_area_contents' => 'edit_page_contents',
'edit_area_design' => 'edit_page_properties',
'edit_area_permissions' => 'edit_page_permissions',
'schedule_area_contents_guest_access' => 'schedule_page_contents_guest_access',
'view_area' => 'view_page',
];
if ($pk instanceof AreaKey) {
$areaKeyHandle = $pk->getPermissionKeyHandle();
if (isset($map[$areaKeyHandle])) {
$pageKeyHandle = $map[$areaKeyHandle];
}
$pk2 = isset($pageKeyHandle) ? PageKey::getByHandle($pageKeyHandle) : null;
if ($pk2 === null) {
throw new Exception(t('Unsupported area key: %s', $areaKeyHandle));
}
$pk2->setPermissionObject($this->getPermissionObject());
$pk = $pk2;
}
$this->pk = $pk;
}
|
{@inheritdoc}
@see \Concrete\Core\Permission\Assignment\Assignment::setPermissionKeyObject()
|
setPermissionKeyObject
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Assignment/StackAssignment.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Assignment/StackAssignment.php
|
MIT
|
public function getPermissionKeyTaskURL(string $task = '', array $options = []): string
{
return parent::getPermissionKeyTaskURL($task, $options + ['treeNodeID' => $this->getPermissionObject()->getTreeNodeID()]);
}
|
{@inheritdoc}
@see \Concrete\Core\Permission\Assignment\Assignment::getPermissionKeyTaskURL()
|
getPermissionKeyTaskURL
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Assignment/TreeNodeAssignment.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Assignment/TreeNodeAssignment.php
|
MIT
|
public function handle(string $task, array $options): ?Response
{
$this->checkAccess();
$method = lcfirst(camelcase($task));
if (!method_exists($this, $method)) {
throw new UserMessageException(t('Unknown permission task: %s', $task));
}
return $this->{$method}($options);
}
|
{@inheritdoc}
@see \Concrete\Core\Permission\Category\TaskHandlerInterface::handle()
|
handle
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Category/GenericTaskHandler.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Category/GenericTaskHandler.php
|
MIT
|
public function handle(string $task, array $options): ?Response
{
$permissionObject = $this->getPermissionObject($options);
$method = lcfirst(camelcase($task));
if (!method_exists($this, $method)) {
throw new UserMessageException(t('Unknown permission task: %s', $task));
}
return $this->{$method}($permissionObject, $options);
}
|
{@inheritdoc}
@see \Concrete\Core\Permission\Category\TaskHandlerInterface::handle()
|
handle
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Category/ObjectTaskHandler.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Category/ObjectTaskHandler.php
|
MIT
|
public function __construct(IPAddress $ipAddress, ?DateTime $banExpiration = null)
{
$this->ipAddress = $ipAddress;
$this->banExpiration = $banExpiration;
}
|
@param IPAddress $ipAddress the IP address that is going to be banned
@param DateTime $banExpiration the ban expiration date/time (or null if not expiration)
|
__construct
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Event/BanIPEvent.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Event/BanIPEvent.php
|
MIT
|
public function getIPAddress()
{
return $this->ipAddress;
}
|
Get the IP address that is going to be banned.
@return IPAddress
|
getIPAddress
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Event/BanIPEvent.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Event/BanIPEvent.php
|
MIT
|
public function getBanExpiration()
{
return $this->banExpiration;
}
|
Get the ban expiration date/time (or null if not expiration).
@return DateTime
|
getBanExpiration
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Event/BanIPEvent.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Event/BanIPEvent.php
|
MIT
|
public function setBanExpiration(?DateTime $banExpiration = null)
{
$this->banExpiration = $banExpiration;
return $this;
}
|
Set the ban expiration date/time (or null if not expiration).
@param DateTime $banExpiration
@return static
|
setBanExpiration
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Event/BanIPEvent.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Event/BanIPEvent.php
|
MIT
|
public function proceed()
{
return $this->proceed;
}
|
Should we proceed or the ban has been canceled?
@return bool
|
proceed
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Event/BanIPEvent.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Event/BanIPEvent.php
|
MIT
|
public function __construct(
$inheritedFromPermissionKeyCategoryHandle,
$inheritedFromPermissionKeyHandle,
$permissionKeyHandle
) {
$this->permissionKeyHandle = $permissionKeyHandle;
$this->inheritedFromPermissionKeyHandle = $inheritedFromPermissionKeyHandle;
$this->inheritedFromPermissionKeyCategoryHandle = $inheritedFromPermissionKeyCategoryHandle;
}
|
AbstractEntry constructor.
@param $permissionKeyHandle
@param $inheritedFromPermissionKeyHandle
@param $inheritedFromPermissionKeyCategoryHandle
|
__construct
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Inheritance/Registry/Entry/Entry.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Inheritance/Registry/Entry/Entry.php
|
MIT
|
public function copyFromPageToArea()
{
$app = Application::getFacadeApplication();
$db = $app->make(Connection::class);
$inheritedPKID = $db->fetchColumn('select pkID from PermissionKeys where pkHandle = ?', ['add_block']);
$r = $db->executeQuery('select peID, pa.paID from PermissionAssignments pa inner join PermissionAccessList pal on pa.paID = pal.paID where pkID = ?', [$inheritedPKID]);
while (($row = $r->fetch(PDO::FETCH_ASSOC)) !== false) {
$db->replace(
'AreaPermissionAssignments',
[
'cID' => $this->permissionObject->getCollectionID(),
'arHandle' => $this->permissionObject->getAreaHandle(),
'pkID' => $this->getPermissionKeyID(),
'paID' => $row['paID'],
],
['cID', 'arHandle', 'pkID'],
true
);
$rx = $db->executeQuery('select permission from BlockTypePermissionBlockTypeAccessList where paID = ? and peID = ?', [$row['paID'], $row['peID']]);
while (($rowx = $rx->fetch(PDO::FETCH_ASSOC)) !== false) {
$db->replace(
'AreaPermissionBlockTypeAccessList',
[
'peID' => $row['peID'],
'permission' => $rowx['permission'],
'paID' => $row['paID'],
],
['paID', 'peID'],
true
);
}
$db->executeQuery('delete from AreaPermissionBlockTypeAccessListCustom where paID = ?', [$row['paID']]);
$rx = $db->executeQuery('select btID from BlockTypePermissionBlockTypeAccessListCustom where paID = ? and peID = ?', [$row['paID'], $row['peID']]);
while (($rowx = $rx->fetch(PDO::FETCH_ASSOC)) !== false) {
$db->replace(
'AreaPermissionBlockTypeAccessListCustom',
[
'paID' => $row['paID'],
'btID' => $rowx['btID'],
'peID' => $row['peID'],
],
['paID', 'peID', 'btID'],
true
);
}
}
}
|
{@inheritdoc}
@see \Concrete\Core\Permission\Key\AreaKey::copyFromPageToArea()
|
copyFromPageToArea
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Key/AddBlockToAreaAreaKey.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Key/AddBlockToAreaAreaKey.php
|
MIT
|
public function validate($blockTypeOrBlock = false)
{
$app = Application::getFacadeApplication();
$u = $app->make(User::class);
if ($u->isSuperUser()) {
return true;
}
if ($blockTypeOrBlock instanceof Block) {
$types = $this->getAllowedBlockTypeIDsFor(static::OPERATION_EXISTINGBLOCK);
$blockType = $blockTypeOrBlock->getBlockTypeObject();
} else {
$types = $this->getAllowedBlockTypeIDsFor(static::OPERATION_NEWBLOCK);
$blockType = $blockTypeOrBlock;
}
return $blockType ? in_array($blockType->getBlockTypeID(), $types) : !empty($types);
}
|
@param \Concrete\Core\Entity\Block\BlockType\BlockType|\Concrete\Core\Block\Block $blockTypeOrBlock specify a block type when adding a new block, a block instance when adding an existing block.
{@inheritdoc}
@see \Concrete\Core\Permission\Key\Key::validate()
|
validate
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Key/AddBlockToAreaAreaKey.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Key/AddBlockToAreaAreaKey.php
|
MIT
|
protected function getAllowedBlockTypeIDs()
{
return $this->getAllowedBlockTypeIDsFor(static::OPERATION_NEWBLOCK);
}
|
@deprecated Use getAllowedBlockTypeIDsFor(AddBlockToAreaAreaKey::OPERATION_NEWBLOCK)
@return int[]
|
getAllowedBlockTypeIDs
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Key/AddBlockToAreaAreaKey.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Key/AddBlockToAreaAreaKey.php
|
MIT
|
protected function getAllowedBlockTypeIDsFor($operation)
{
$pae = $this->getAreaPermissionAccessObject();
if (!is_object($pae)) {
return [];
}
if (!in_array($operation, [static::OPERATION_NEWBLOCK, static::OPERATION_EXISTINGBLOCK], true)) {
$operation = static::OPERATION_NEWBLOCK;
}
$app = Application::getFacadeApplication();
$u = $app->make(User::class);
$accessEntities = $u->getUserAccessEntityObjects();
$accessEntities = $pae->validateAndFilterAccessEntities($accessEntities);
$list = $this->getAreaAccessListItems(AreaKey::ACCESS_TYPE_ALL, $accessEntities);
$list = PermissionDuration::filterByActive($list);
$btIDs = [];
if (count($list) > 0) {
$app = Application::getFacadeApplication();
$db = $app->make(Connection::class);
$cache = $app->make('cache/request');
$dsh = $app->make('helper/concrete/dashboard');
if ($dsh->inDashboard()) {
$identifier = 'blocktypeids/all';
} else {
$identifier = 'blocktypeids/public/' . $operation;
}
$item = $cache->getItem($identifier);
if ($item->isMiss()) {
$allBTIDs = [];
$params = [];
if ($dsh->inDashboard()) {
$sql = 'select btID from BlockTypes';
} else {
$sql = 'select btID from BlockTypes where btIsInternal = 0';
if ($operation === static::OPERATION_EXISTINGBLOCK) {
$sql .= ' or btHandle = ?';
$params[] = BLOCK_HANDLE_STACK_PROXY;
}
}
$rs = $db->executeQuery($sql, $params);
while (($btID = $rs->fetchColumn()) !== false) {
$allBTIDs[] = (int) $btID;
}
$item->set($allBTIDs)->save();
} else {
$allBTIDs = $item->get();
}
foreach ($list as $l) {
switch ($l->getBlockTypesAllowedPermission()) {
case 'N':
$btIDs = [];
break;
case 'C':
if ($l->getAccessType() == AreaKey::ACCESS_TYPE_EXCLUDE) {
$btIDs = array_values(array_diff($btIDs, $l->getBlockTypesAllowedArray()));
} else {
$btIDs = array_unique(array_merge($btIDs, $l->getBlockTypesAllowedArray()));
}
break;
case 'A':
$btIDs = $allBTIDs;
break;
}
}
}
return $btIDs;
}
|
Get the list of allowed block type IDs for a specific operation.
@param string $operation One of the OPERATION_... constants.
@return int[]
|
getAllowedBlockTypeIDsFor
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Key/AddBlockToAreaAreaKey.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Key/AddBlockToAreaAreaKey.php
|
MIT
|
public function getSupportedAccessTypes()
{
$types = [
self::ACCESS_TYPE_INCLUDE => t('Included'),
self::ACCESS_TYPE_EXCLUDE => t('Excluded'),
];
return $types;
}
|
Get the identifiers (keys) and descriptions (values) of the access types.
@return array
|
getSupportedAccessTypes
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Key/Key.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Key/Key.php
|
MIT
|
public function canPermissionKeyTriggerWorkflow()
{
return !empty($this->pkCanTriggerWorkflow);
}
|
Returns whether a permission key can start a workflow.
@return bool
|
canPermissionKeyTriggerWorkflow
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Key/Key.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Key/Key.php
|
MIT
|
public function permissionKeyHasCustomClass()
{
return !empty($this->pkHasCustomClass);
}
|
Returns whether a permission key has a custom class.
@return bool
|
permissionKeyHasCustomClass
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Key/Key.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Key/Key.php
|
MIT
|
public function getPermissionKeyName()
{
return isset($this->pkName) ? $this->pkName : null;
}
|
Returns the name for this permission key.
@return string
|
getPermissionKeyName
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Key/Key.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Key/Key.php
|
MIT
|
public function getPermissionKeyDisplayName($format = 'html')
{
$value = tc('PermissionKeyName', $this->getPermissionKeyName());
switch ($format) {
case 'html':
return h($value);
case 'text':
default:
return $value;
}
}
|
Returns the display name for this permission key (localized and escaped accordingly to $format).
@param string $format = 'html'
Escape the result in html format (if $format is 'html').
If $format is 'text' or any other value, the display name won't be escaped.
@return string
|
getPermissionKeyDisplayName
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Key/Key.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Key/Key.php
|
MIT
|
public function getPermissionKeyHandle()
{
return isset($this->pkHandle) ? $this->pkHandle : null;
}
|
Returns the handle for this permission key.
@return string
|
getPermissionKeyHandle
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Key/Key.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Key/Key.php
|
MIT
|
public function getPermissionKeyDescription()
{
return isset($this->pkDescription) ? $this->pkDescription : null;
}
|
Returns the description for this permission key.
@return string
|
getPermissionKeyDescription
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Key/Key.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Key/Key.php
|
MIT
|
public function getPermissionKeyDisplayDescription($format = 'html')
{
$value = tc('PermissionKeyDescription', $this->getPermissionKeyDescription());
switch ($format) {
case 'html':
return h($value);
case 'text':
default:
return $value;
}
}
|
Returns the display description for this permission key (localized and escaped accordingly to $format).
@param string $format = 'html'
Escape the result in html format (if $format is 'html').
If $format is 'text' or any other value, the display description won't be escaped.
@return string
|
getPermissionKeyDisplayDescription
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Key/Key.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Key/Key.php
|
MIT
|
public function getPermissionKeyID()
{
return isset($this->pkID) ? (int) $this->pkID : null;
}
|
Returns the ID for this permission key.
@return int
|
getPermissionKeyID
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Key/Key.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Key/Key.php
|
MIT
|
public function getPermissionKeyCategoryID()
{
return isset($this->pkCategoryID) ? (int) $this->pkCategoryID : null;
}
|
Returns the ID for the category of this permission key.
@return int
|
getPermissionKeyCategoryID
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Key/Key.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Key/Key.php
|
MIT
|
public function getPermissionKeyCategoryHandle()
{
return isset($this->pkCategoryHandle) ? $this->pkCategoryHandle : null;
}
|
Returns the handle for the category of this permission key.
@return string
|
getPermissionKeyCategoryHandle
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Key/Key.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Key/Key.php
|
MIT
|
public function setPermissionObject($object)
{
$this->permissionObject = $object;
}
|
Set the object for which this permission is for (for example, a Page instance).
@param \Concrete\Core\Permission\ObjectInterface|null $object
|
setPermissionObject
|
php
|
concretecms/concretecms
|
concrete/src/Permission/Key/Key.php
|
https://github.com/concretecms/concretecms/blob/master/concrete/src/Permission/Key/Key.php
|
MIT
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.