• Главная
• OEModule
• PASAPI
• resources
• BaseResource

PHP Класс OEModule\PASAPI\resources\BaseResource

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$errors
$id	string	Resource ID.
$partial_record	boolean	Property that will allow subset of data to be updated on the resource.
$update_only	boolean	Property that will prevent a model being created if its set to true.
$warn_errors	boolean	Flag that will force all errors on the resource to be mapped to warnings.
$warnings

Защищенные свойства (Protected)

Свойство	Тип	Описание
$assignment	OEModule\PASAPI\models\PasApiAssignment
$resource_type
$schema
$version

Открытые методы

Метод	Описание
__construct ( $version, array $options = [] )	BaseResource constructor.
addAuditData ( $key, $value )	Add to audit data property.
assignProperty ( $model, $model_key, $resource_key )
audit ( $audit_type, null $data = null, null $msg = null, array $properties = [] )	Wrapper for auditing calls on resource changes.
fromResourceId ( $version, $id ) : BaseResource	Instantiate the resource from the external ID.
fromXml ( $version, $xml, array $options = [] ) : null | BaseResource	Create an instance from an XML string.
fromXmlDom ( $version, DOMElement $element, array $options = [] ) : static	instantiates a resource with the given XML Document.
getAssignedProperty ( $name )
getAssignment ( ) : PasApiAssignment
getAuditData ( ) : string	Returns the json encoded audit data for logging.
getAuditTarget ( ) : string	Simple wrapper to retrieve a type for auditing.
parseXml ( DOMElement $root, $options = [] )	Parses XML to define resource attributes.
remapValues ( $doc, XpathRemap[] $remaps = [] )	Update the given doc nodes as per the provided remaps.
setAssignment ( PasApiAssignment $assignment )
shouldValidateRequired ( ) : boolean
validate ( ) : boolean	Base validator of resource from schema definition.

Защищенные методы

Метод	Описание
addError ( $msg )	Error logger.
addModelErrors ( $errors )	Convenience wrapper for handling model validation errors.
addWarning ( $msg )	Warning logger.
errorInit ( $version, $errors ) : static	Convenience function to create a resource instance with error messages.
getInstanceForClass ( $class, $args = [] ) : mixed	Abstraction for getting instance of class.
getSchema ( $version ) : mixed	Get the schema for the resource type based on the given version.
startTransaction ( ) : CDbTransaction | null	Wrapper for starting a transaction.

Описание методов

Описание свойств