Overview

Namespaces

  • Alpha
    • Controller
      • Front
    • Exception
    • Model
      • Type
    • Task
    • Util
      • Backup
      • Cache
      • Code
        • Highlight
        • Metric
      • Config
      • Convertor
      • Email
      • Extension
      • Feed
      • File
      • Graph
      • Helper
      • Http
        • Filter
        • Session
      • Image
      • Logging
      • Search
      • Security
    • View
      • Renderer
        • Html
        • Json
      • Widget

Classes

  • ActiveRecordController
  • ArticleController
  • AttachmentController
  • CacheController
  • Controller
  • DEnumController
  • ExcelController
  • FeedController
  • GenSecureQueryStringController
  • ImageController
  • IndexController
  • InstallController
  • ListActiveRecordsController
  • LogController
  • LoginController
  • LogoutController
  • MetricController
  • PhpinfoController
  • RecordSelectorController
  • SearchController
  • SequenceController
  • TagController

Interfaces

  • ControllerInterface
  • Overview
  • Namespace
  • Class
  • Tree

Class LoginController

Login controller that adds the current user object to the session.

Alpha\Controller\Controller
Extended by Alpha\Controller\LoginController implements Alpha\Controller\ControllerInterface
Namespace: Alpha\Controller
Copyright: Copyright (c) 2015, John Collins (founder of Alpha Framework). All rights reserved. <pre> Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the Alpha Framework nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. </pre>
License: The BSD License
Author: John Collins <dev@alphaframework.org>
Since: 1.0
Located at Controller/LoginController.php
Methods summary
public
# __construct( )

constructor to set up the object.

constructor to set up the object.

Since

1.0

Overrides

Alpha\Controller\Controller::__construct()
public Alpha\Util\Http\Response
# doGET( Alpha\Util\Http\Request $request )

Handle GET requests.

Handle GET requests.

Parameters

$request
Alpha\Util\Http\Request $request

Returns

Alpha\Util\Http\Response
Alpha\Util\Http\Response

Throws

Alpha\Exception\IllegalArguementException
Alpha\Exception\IllegalArguementException

Since

1.0

Overrides

Alpha\Controller\Controller::doGET()

Implementation of

Alpha\Controller\ControllerInterface::doGET()
public Alpha\Util\Http\Response
# doPOST( Alpha\Util\Http\Request $request )

Handle POST requests (adds $currentUser Person to the session).

Handle POST requests (adds $currentUser Person to the session).

Parameters

$request
Alpha\Util\Http\Request $request

Returns

Alpha\Util\Http\Response
Alpha\Util\Http\Response

Throws

Alpha\Exception\IllegalArguementException
Alpha\Exception\IllegalArguementException

Since

1.0

Overrides

Alpha\Controller\Controller::doPOST()

Implementation of

Alpha\Controller\ControllerInterface::doPOST()
protected Alpha\Util\Http\Response
# doLoginAndRedirect( string $password )

Login the user and re-direct to the defined destination.

Login the user and re-direct to the defined destination.

Parameters

$password
string $password The password supplied by the user logging in

Returns

Alpha\Util\Http\Response
Alpha\Util\Http\Response

Throws

Alpha\Exception\ValidationException
Alpha\Exception\ValidationException

Since

1.0
public string
# before_displayPageFoot_callback( )

Displays the application version number on the login screen.

Displays the application version number on the login screen.

Returns

string
string

Since

1.0
Methods inherited from Alpha\Controller\Controller
abort(), accessError(), after_displayPageHead_callback(), checkIfAccessingFromSecureURL(), checkRights(), checkSecurityFields(), clearUnitOfWorkAttributes(), commit(), doDELETE(), doHEAD(), doOPTIONS(), doPATCH(), doPUT(), doTRACE(), generateSecurityFields(), generateURLSlug(), getCustomControllerName(), getDescription(), getDirtyObjects(), getEndTime(), getFirstJob(), getKeywords(), getLastJob(), getMAXDuration(), getName(), getNewObjects(), getNextJob(), getPreviousJob(), getRecord(), getRequest(), getStartTime(), getStatusMessage(), getTitle(), getUnitDuration(), getVisibility(), loadControllerDef(), markDirty(), markNew(), process(), setDescription(), setKeywords(), setName(), setRecord(), setRequest(), setStatusMessage(), setTitle(), setUnitEndTime(), setUnitMAXDuration(), setUnitOfWork(), setUnitStartTime(), setVisibility()
Properties summary
protected Alpha\Model\Person $personObject
#

The person to be logged in.

The person to be logged in.

Since

1.0
Properties inherited from Alpha\Controller\Controller
$description, $dirtyObjects, $firstJob, $keywords, $lastJob, $name, $newObjects, $nextJob, $previousJob, $record, $request, $statusMessage, $title, $unitEndTime, $unitMAXDuration, $unitOfWork, $unitStartTime, $visibility
Alpha Framework 2.0.4 API Documentation API documentation generated by ApiGen 2.8.0