PHP Class OEModule\PASAPI\resources\PatientId

(C) OpenEyes Foundation, 2016 This file is part of OpenEyes. OpenEyes is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. OpenEyes is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenEyes in a file titled COPYING. If not, see .
See link: http://www.openeyes.org.uk
Author: OpenEyes ([email protected])
Inheritance: extends BaseResource
Show file Open project: openeyes/openeyes

Public Properties

Property Type Description
$isNewResource

Protected Properties

Property Type Description
$id_tags array Valid tags for defining a patient identifier.
$resource_type

Public Methods

Method Description
getModel ( ) : Patient Function to resolve the referenced Patient model for this id resource.
validate ( ) : boolean As a primary resource (i.e. mapped to external resource) we need to ensure we have an id for tracking the resource in the system.

Protected Methods

Method Description
getModelForClass ( $class ) : mixed Abstraction for getting model instance of class.
methodNotImplemented ( $method_name ) Convenience wrapper for marking a method not implemented (to generalise the exception for this).
patientNotFound ( ) Wrapper for patient not found behaviour.
resolveModelHospitalNumber ( )
resolveModelId ( ) : mixed Resolve the model by the given Patient Id.
resolveModelNHSNumber ( )
resolveModelPasId ( )

Method Details

getModel() public method

Function to resolve the referenced Patient model for this id resource.
public getModel ( ) : Patient
return Patient

getModelForClass() protected method

Abstraction for getting model instance of class.
protected getModelForClass ( $class ) : mixed
$class
return mixed

methodNotImplemented() protected method

Convenience wrapper for marking a method not implemented (to generalise the exception for this).
protected methodNotImplemented ( $method_name )
$method_name

patientNotFound() protected method

Wrapper for patient not found behaviour.
protected patientNotFound ( )

resolveModelHospitalNumber() protected method

protected resolveModelHospitalNumber ( )

resolveModelId() protected method

Resolve the model by the given Patient Id.
protected resolveModelId ( ) : mixed
return mixed

resolveModelNHSNumber() protected method

protected resolveModelNHSNumber ( )

resolveModelPasId() protected method

protected resolveModelPasId ( )

validate() public method

As a primary resource (i.e. mapped to external resource) we need to ensure we have an id for tracking the resource in the system.
public validate ( ) : boolean
return boolean

Property Details

$id_tags protected property

Valid tags for defining a patient identifier.
protected array $id_tags
return array

$isNewResource public property

public $isNewResource

$resource_type protected static property

protected static $resource_type