Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\rdf;
Chris@0: 
Chris@0: use Drupal\Core\Config\Entity\ConfigEntityInterface;
Chris@0: 
Chris@0: /**
Chris@0:  * Provides an interface defining an RDF mapping entity.
Chris@0:  */
Chris@0: interface RdfMappingInterface extends ConfigEntityInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * Gets the mapping for the bundle-level data.
Chris@0:    *
Chris@0:    * The prepared bundle mapping should be used when outputting data in RDF
Chris@0:    * serializations such as RDFa. In the prepared mapping, the mapping
Chris@0:    * configuration's CURIE arrays are processed into CURIE strings suitable for
Chris@0:    * output.
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   The bundle mapping.
Chris@0:    */
Chris@0:   public function getPreparedBundleMapping();
Chris@0: 
Chris@0:   /**
Chris@0:    * Gets the mapping config for the bundle-level data.
Chris@0:    *
Chris@0:    * This function returns the bundle mapping as stored in config, which may
Chris@0:    * contain CURIE arrays. If the mapping is needed for output in a
Chris@0:    * serialization format, such as RDFa, then getPreparedBundleMapping() should
Chris@0:    * be used instead.
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   The bundle mapping, or an empty array if there is no mapping.
Chris@0:    */
Chris@0:   public function getBundleMapping();
Chris@0: 
Chris@0:   /**
Chris@0:    * Sets the mapping config for the bundle-level data.
Chris@0:    *
Chris@0:    * This only sets bundle-level mappings, such as the RDF type. Mappings for
Chris@0:    * a bundle's fields should be handled with setFieldMapping.
Chris@0:    *
Chris@0:    * Example usage:
Chris@0:    * -Map the 'article' bundle to 'sioc:Post'.
Chris@0:    * @code
Chris@0:    * rdf_get_mapping('node', 'article')
Chris@0:    *   ->setBundleMapping(array(
Chris@0:    *     'types' => array('sioc:Post'),
Chris@0:    *   ))
Chris@0:    *   ->save();
Chris@0:    * @endcode
Chris@0:    *
Chris@0:    * @param array $mapping
Chris@0:    *   The bundle mapping.
Chris@0:    *
Chris@0:    * @return \Drupal\rdf\Entity\RdfMapping
Chris@0:    *   The RdfMapping object.
Chris@0:    */
Chris@0:   public function setBundleMapping(array $mapping);
Chris@0: 
Chris@0:   /**
Chris@0:    * Gets the prepared mapping for a field.
Chris@0:    *
Chris@0:    * The prepared field mapping should be used when outputting data in RDF
Chris@0:    * serializations such as RDFa. In the prepared mapping, the mapping
Chris@0:    * configuration's CURIE arrays are processed into CURIE strings suitable for
Chris@0:    * output.
Chris@0:    *
Chris@0:    * @param string $field_name
Chris@0:    *   The name of the field.
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   The prepared field mapping, or an empty array if there is no mapping.
Chris@0:    */
Chris@0:   public function getPreparedFieldMapping($field_name);
Chris@0: 
Chris@0:   /**
Chris@0:    * Gets the mapping config for a field.
Chris@0:    *
Chris@0:    * This function returns the field mapping as stored in config, which may
Chris@0:    * contain CURIE arrays. If the mapping is needed for output in a
Chris@0:    * serialization format, such as RDFa, then getPreparedFieldMapping() should
Chris@0:    * be used instead.
Chris@0:    *
Chris@0:    * @param string $field_name
Chris@0:    *   The name of the field.
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   The field mapping config array, or an empty array if there is no mapping.
Chris@0:    */
Chris@0:   public function getFieldMapping($field_name);
Chris@0: 
Chris@0:   /**
Chris@0:    * Sets the mapping config for a field.
Chris@0:    *
Chris@0:    * @param string $field_name
Chris@0:    *   The name of the field.
Chris@0:    * @param array $mapping
Chris@0:    *   The field mapping.
Chris@0:    *
Chris@0:    * @return \Drupal\rdf\Entity\RdfMapping
Chris@0:    *   The RdfMapping object.
Chris@0:    */
Chris@0:   public function setFieldMapping($field_name, array $mapping = []);
Chris@0: 
Chris@0: }