Source of file UserContextInterface.php
Size: 1,012 Bytes - Last Modified: 2021-12-23T10:33:37+00:00
/var/www/docs.ssmods.com/process/src/src/Interfaces/UserContextInterface.php
12345678910111213141516171819202122232425262728293031323334 | <?php namespace Symbiote\QueuedJobs\Interfaces; /** * Interface UserContextInterface * used for jobs which need to specify which member to log in when running the jobs * * example cases: * initial site migration (special user needs to be used at all times) * jobs that require no user to be logged in * * @package Symbiote\QueuedJobs\Interfaces */ interface UserContextInterface { /** * Specifies what user ID should be when running the job * valid values: * null - (default) - run the job as current user * 0 - run the job without a user * greater than zero - run the job as a specific user * * This is useful in situations like: * - a job needs to always run without a user (like a static cache job) * - a job needs to run as a specific user (for example data migration job) * * Note that this value can be overridden in the @see QueuedJobService::queueJob() * * @return int|null */ public function getRunAsMemberID(); } |