AdapterInterface

API adapter interface.
implements Zend\EventManager\EventManagerAwareInterface, Zend\EventManager\EventsCapableInterface, Zend\Permissions\Acl\Resource\ResourceInterface

Known implementers

Omeka\Api\Adapter\AbstractAdapter , Omeka\Api\Adapter\AbstractEntityAdapter , Omeka\Api\Adapter\AbstractResourceEntityAdapter , Omeka\Api\Adapter\ApiResourceAdapter , Omeka\Api\Adapter\AssetAdapter , Omeka\Api\Adapter\ItemAdapter , Omeka\Api\Adapter\ItemSetAdapter , Omeka\Api\Adapter\JobAdapter , Omeka\Api\Adapter\MediaAdapter , Omeka\Api\Adapter\ModuleAdapter , Omeka\Api\Adapter\PropertyAdapter , Omeka\Api\Adapter\ResourceAdapter , Omeka\Api\Adapter\ResourceClassAdapter , Omeka\Api\Adapter\ResourceTemplateAdapter , Omeka\Api\Adapter\SiteAdapter , Omeka\Api\Adapter\SitePageAdapter , Omeka\Api\Adapter\UserAdapter , Omeka\Api\Adapter\VocabularyAdapter

Methods Summary
public
# getResourceName( )
Get the name of the corresponding API resource.
public
# create( Omeka\Api\Request $request )
Create a resource.
public
# batchCreate( Omeka\Api\Request $request )
Batch create resources. Adapters implementing this operation should return the resultant resources as the response content so the create.pre and create.post events can be triggered for every resource.
public
# read( Omeka\Api\Request $request )
Read a resource.
public
# update( Omeka\Api\Request $request )
Update a resource.
public
# batchUpdate( Omeka\Api\Request $request )
Batch update a resource.
public
# preprocessBatchUpdate( array $data , Omeka\Api\Request $request )
Preprocess batch update data. Updating in batches can have undesirable consequences. This method gives adapters the chance to filter out or otherwise modify problematic request data to avoid this.
public
# delete( Omeka\Api\Request $request )
Delete a resource.
public
# batchDelete( Omeka\Api\Request $request )
Batch delete a resource.
public
# getRepresentation( Omeka\Api\ResourceInterface $data = NULL )
Compose a resource representation object.
public
# setServiceLocator( Zend\ServiceManager\ServiceLocatorInterface $serviceLocator )
Set the service locator.
public
# getServiceLocator( )
Get the service locator.