BEdita API doc | 4-cactus
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Download

Namespaces

  • BEdita
    • API
      • Auth
      • Controller
        • Admin
        • Component
        • Model
      • Error
      • Event
      • Exception
      • Middleware
      • Model
        • Action
      • Network
        • Exception
      • Shell
      • TestSuite
      • Utility
    • Core
      • Configure
        • Engine
      • Database
        • Type
      • Exception
      • Filesystem
        • Adapter
        • Exception
        • Thumbnail
      • I18n
      • Job
        • Service
      • Mailer
        • Preview
        • Transport
      • Model
        • Action
        • Behavior
        • Entity
        • Table
        • Validation
      • ORM
        • Inheritance
        • Locator
        • Rule
      • Shell
        • Task
      • State
      • TestSuite
        • Fixture
      • Utility

Classes

  • AddAssociatedAction
  • AddRelatedObjectsAction
  • BaseAction
  • ChangeCredentialsAction
  • ChangeCredentialsRequestAction
  • DeleteEntityAction
  • DeleteObjectAction
  • GetEntityAction
  • GetObjectAction
  • ListEntitiesAction
  • ListObjectsAction
  • ListRelatedFoldersAction
  • RemoveAssociatedAction
  • RemoveRelatedObjectsAction
  • SaveEntityAction
  • SetAssociatedAction
  • SetRelatedObjectsAction
  • SignupUserActivationAction
  • UpdateAssociatedAction

Class ChangeCredentialsRequestAction

Command to request an access credentials change Typically a password change

Input data MUST contain: - 'contact' user email, other contact methods in the future - 'change_url' base URL to use in email sent to user, actual change URL link will be {change_url}?uuid={uuid}

BEdita\Core\Model\Action\BaseAction uses Cake\Core\InstanceConfigTrait (not available)
Extended by BEdita\Core\Model\Action\ChangeCredentialsRequestAction implements Cake\Event\EventListenerInterface uses Cake\Event\EventDispatcherTrait (not available) Cake\Mailer\MailerAwareTrait (not available)
Namespace: BEdita\Core\Model\Action
Since: 4.0.0
Located at Core/src/Model/Action/ChangeCredentialsRequestAction.php

Methods summary

protected
# initialize( array $config )

Command initialization.

Command initialization.

Parameters

$config
Configuration.

Overrides

BEdita\Core\Model\Action\BaseAction::initialize
public mixed
# execute( array $data = [] )

Command execution.

Command execution.

Parameters

$data
Data.

Returns

mixed
public array|true
# validate( array $data )

Validate input data.

Validate input data.

Parameters

$data
Input

Returns

array|true
Array of validation errors, or true if input is valid.
protected BEdita\Core\Model\Entity\User
# getUser( string $contact )

Get user.

Get user.

Parameters

$contact
Contact method (email).

Returns

BEdita\Core\Model\Entity\User
protected BEdita\Core\Model\Entity\AsyncJob
# createJob( BEdita\Core\Model\Entity\User $user )

Create the credentials change async job

Create the credentials change async job

Parameters

$user
The user requesting change

Returns

BEdita\Core\Model\Entity\AsyncJob
public
# sendMail( Cake\Event\Event $event, BEdita\Core\Model\Entity\User $user, BEdita\Core\Model\Entity\AsyncJob $asyncJob, string $changeUrl )

Send change request email to user

Send change request email to user

Parameters

$event
Dispatched event.
$user
The user.
$asyncJob
Async job.
$changeUrl
Change URL
protected string
# getChangeUrl( string $uuid, string $changeUrl )

Return the credentials change url

Return the credentials change url

Parameters

$uuid
Change uuid
$changeUrl
Base change URL

Returns

string
public
# implementedEvents( )

Methods inherited from BEdita\Core\Model\Action\BaseAction

__construct(), __invoke()

Properties summary

protected BEdita\Core\Model\Table\UsersTable $Users

The UsersTable table

The UsersTable table

#
protected BEdita\Core\Model\Table\AsyncJobsTable $AsyncJobs

The AsyncJobs table

The AsyncJobs table

#

Properties inherited from BEdita\Core\Model\Action\BaseAction

$_defaultConfig

BEdita API doc | 4-cactus API documentation generated by ApiGen