vendor/ibexa/core/src/lib/MVC/Symfony/Security/Authorization/Attribute.php line 30

Open in your IDE?
  1. <?php
  3. /**
  4. * @copyright Copyright (C) Ibexa AS. All rights reserved.
  5. * @license For full copyright and license information view LICENSE file distributed with this source code.
  6. */
  7. namespace Ibexa\Core\MVC\Symfony\Security\Authorization;
  9. /**
  10. * Authorization attribute class to be used with SecurityContextInterface::isGranted().
  11. *
  12. * $module represents the global scope you want to check access to (e.g. "content")
  13. * $function represents the feature inside $module (e.g. "read")
  14. * $limitations are optional limitations to check against (e.g. array( 'valueObject' => $contentInfo )).
  15. * Supported keys are "valueObject" and "targets".
  16. * "valueObject": ValueObject you want to check access to (e.g. ContentInfo)
  17. * "targets": Location, parent or "assignment" (e.g. Section) value object, or an array of the same
  18. *
  19. * Usage example:
  20. * <code>
  21. * use Ibexa\Core\MVC\Symfony\Security\Authorization\Attribute as AuthorizationAttribute;
  22. *
  23. * // From inside a controller
  24. * // Will check if current user can assign a content to a section, $section being a Section value object.
  25. * $hasAccess = $this->isGranted(
  26. * new AuthorizationAttribute( 'content', 'read', array( 'valueObject' => $contentInfo, 'targets' => $section ) )
  27. * );
  28. * </code>
  29. */
  30. class Attribute
  31. {
  32. /** @var string */
  33. public $module;
  35. /** @var string */
  36. public $function;
  38. /** @var array */
  39. public $limitations;
  41. public function __construct($module = null, $function = null, array $limitations = [])
  42. {
  43. $this->module = $module;
  44. $this->function = $function;
  45. $this->limitations = $limitations;
  46. }
  48. /**
  49. * String representation so that it's understandable by basic voters.
  50. *
  51. * @return string
  52. */
  53. public function __toString()
  54. {
  55. return "EZ_ROLE_{$this->module}_{$this->function}";
  56. }
  57. }
  59. class_alias(Attribute::class, 'eZ\Publish\Core\MVC\Symfony\Security\Authorization\Attribute');