Constructors #

Instantiates a new Profile object, representing a security profile, which is a set of one or many Role objects.

Profile(Security, id, content, [meta]) #

Arguments	Type	Description
`Security`	Security	An instantiated Security object
`id`	string	Unique profile identifier
`content`	JSON Object	Profile content
`meta`	JSON Object	Profile metadata

Note: this constructor won't make any call to Kuzzle.

Properties #

Property name	Type	Description	get/set
`content`	JSON object	Raw profile content	get
`id`	string	Unique profile identifier	get
`meta`	JSON object	Profile metadata	get

Return Value #

Returns to the Profile object.

Usage #

<?php
use \Kuzzle\Kuzzle;
use \Kuzzle\Security\Profile;
$profileId = 'myProfile';
$profileDefinition = [
  'policies' => [
    [
      'roleId' => 'myRole'
    ],
    [
      'roleId' => 'anonymous',
      'restrictedTo' => [
        ['index' => 'my-second-index', 'collection' => ['my-collection']]
      ]
    ]
  ]
];
$kuzzle = new Kuzzle('localhost');
$security = $kuzzle->security();
// Using the Security factory:
$profile = $security->profile($profileId, $profileDefinition);
// Or directly with the constructor:
$profile = new Profile($security, $profileId, $profileDefinition);

Edit this page on Github