- Class name: WebserviceOutputBuilderCore
- Source: classes/webservice/WebserviceOutputBuilder.php line 30
- $depth
- $fieldsToDisplay
- $headerParams
- $objectRender
- $output
- $schemaToDisplay
- $specificFields
- $status
- $statusInt
- $virtualFields
- $wsParamOverrides
- $wsResource
- $wsUrl
- __construct
- addVirtualFields
- buildHeader
- getContent
- getErrors
- getHeaderParams
- getObjectRender
- getResourcesList
- getSpecificField
- getStatus
- getStatusInt
- getSynopsisDetails
- getVirtualFields
- overrideSpecificField
- registerOverrideWSParameters
- renderAssociations
- renderEntity
- renderEntityMinimum
- renderField
- renderFlatAssociation
- renderSchema
- resetHeaderParams
- setFieldsToDisplay
- setHeaderParams
- setIndent
- setObjectRender
- setSpecificField
- setStatus
- setVirtualField
- setWsResources
- validateObjectAndMethod
const VIEW_DETAILS = 2
const VIEW_LIST = 1
protected mixed $depth
- Visibility: protected
- Source: classes/webservice/WebserviceOutputBuilder.php line 43.
protected mixed $fieldsToDisplay
- Visibility: protected
- Source: classes/webservice/WebserviceOutputBuilder.php line 45.
protected mixed $headerParams = array('Access-Time' => 0, 'X-Powered-By' => 0, 'PSWS-Version' => 0, 'Content-Type' => 0)
- Visibility: protected
- Source: classes/webservice/WebserviceOutputBuilder.php line 52.
public mixed $objectRender
- Visibility: public
- Source: classes/webservice/WebserviceOutputBuilder.php line 41.
protected mixed $output
- Visibility: protected
- Source: classes/webservice/WebserviceOutputBuilder.php line 40.
protected mixed $schemaToDisplay
- Visibility: protected
- Source: classes/webservice/WebserviceOutputBuilder.php line 44.
protected mixed $specificFields = array()
- Visibility: protected
- Source: classes/webservice/WebserviceOutputBuilder.php line 46.
protected string $status
- Visibility: protected
- Source: classes/webservice/WebserviceOutputBuilder.php line 62.
protected mixed $statusInt
- Visibility: protected
- Source: classes/webservice/WebserviceOutputBuilder.php line 48.
protected mixed $virtualFields = array()
- Visibility: protected
- Source: classes/webservice/WebserviceOutputBuilder.php line 47.
protected mixed $wsParamOverrides
- Visibility: protected
- Source: classes/webservice/WebserviceOutputBuilder.php line 49.
protected mixed $wsResource
- Visibility: protected
- Source: classes/webservice/WebserviceOutputBuilder.php line 42.
protected mixed $wsUrl
- Visibility: protected
- Source: classes/webservice/WebserviceOutputBuilder.php line 39.
mixed WebserviceOutputBuilderCore::__construct($ws_url)
- Visibility: public
- Source: classes/webservice/WebserviceOutputBuilder.php line 64
- $ws_url mixed
mixed WebserviceOutputBuilderCore::addVirtualFields($entity_name, $entity_object)
- Visibility: public
- Source: classes/webservice/WebserviceOutputBuilder.php line 765
- $entity_name mixed
- $entity_object mixed
array WebserviceOutputBuilderCore::buildHeader()
This method return an array with each http header params for a content.
This check each required params.
If this method is overrided don't forget to check required specific params (for xml etc...)
- Visibility: public
- Source: classes/webservice/WebserviceOutputBuilder.php line 122
string WebserviceOutputBuilderCore::getContent(array $objects, null|string $schema_to_display, string|array $fields_to_display, integer $depth, integer $type_of_view, $override)
Method is used for each content type Different content types are : - list of entities, - tree diagram of entity details (full or minimum), - schema (synopsis & blank),
- Visibility: public
- Source: classes/webservice/WebserviceOutputBuilder.php line 347
- $objects array - each object created by entity asked @see WebserviceOutputBuilder::executeEntityGetAndHead
- $schema_to_display null|string - if null display the entities list or entity details.
- $fields_to_display string|array - the fields allow for the output
- $depth integer - depth for the tree diagram output.
- $type_of_view integer - use the 2 constants WebserviceOutputBuilder::VIEW_LIST WebserviceOutputBuilder::VIEW_DETAILS
- $override mixed
string WebserviceOutputBuilderCore::getErrors(array $errors)
Build errors output using an error array
- Visibility: public
- Source: classes/webservice/WebserviceOutputBuilder.php line 251
- $errors array
array|string WebserviceOutputBuilderCore::getHeaderParams(null|string $key)
- Visibility: public
- Source: classes/webservice/WebserviceOutputBuilder.php line 154
- $key null|string - if null get all header params otherwise the params specified by the key
\WebserviceOutputInterface WebserviceOutputBuilderCore::getObjectRender()
getter
- Visibility: public
- Source: classes/webservice/WebserviceOutputBuilder.php line 96
string WebserviceOutputBuilderCore::getResourcesList($key_permissions)
Build the resource list in the output format specified by WebserviceOutputBuilder::objectRender
- Visibility: public
- Source: classes/webservice/WebserviceOutputBuilder.php line 281
- $key_permissions mixed
mixed WebserviceOutputBuilderCore::getSpecificField()
- Visibility: public
- Source: classes/webservice/WebserviceOutputBuilder.php line 732
string WebserviceOutputBuilderCore::getStatus()
- Visibility: public
- Source: classes/webservice/WebserviceOutputBuilder.php line 186
mixed WebserviceOutputBuilderCore::getStatusInt()
- Visibility: public
- Source: classes/webservice/WebserviceOutputBuilder.php line 191
mixed WebserviceOutputBuilderCore::getSynopsisDetails($field)
- Visibility: public
- Source: classes/webservice/WebserviceOutputBuilder.php line 696
- $field mixed
mixed WebserviceOutputBuilderCore::getVirtualFields()
- Visibility: public
- Source: classes/webservice/WebserviceOutputBuilder.php line 760
mixed WebserviceOutputBuilderCore::overrideSpecificField($entity_name, $field_name, $field, $entity_object, $ws_params)
- Visibility: protected
- Source: classes/webservice/WebserviceOutputBuilder.php line 736
- $entity_name mixed
- $field_name mixed
- $field mixed
- $entity_object mixed
- $ws_params mixed
mixed WebserviceOutputBuilderCore::registerOverrideWSParameters($wsrObject, $method)
- Visibility: public
- Source: classes/webservice/WebserviceOutputBuilder.php line 327
- $wsrObject mixed
- $method mixed
string WebserviceOutputBuilderCore::renderAssociations($object, $depth, $associations, $ws_params)
- Visibility: protected
- Source: classes/webservice/WebserviceOutputBuilder.php line 564
- $object mixed
- $depth mixed
- $associations mixed
- $ws_params mixed
string WebserviceOutputBuilderCore::renderEntity(\ObjectModel $object, integer $depth)
Build the entity detail.
- Visibility: public
- Source: classes/webservice/WebserviceOutputBuilder.php line 446
- $object ObjectModel - create by the entity
- $depth integer - the depth for the tree diagram
string WebserviceOutputBuilderCore::renderEntityMinimum($object, $depth)
Create the tree diagram with no details
- Visibility: public
- Source: classes/webservice/WebserviceOutputBuilder.php line 407
- $object mixed - create by the entity
- $depth mixed - the depth for the tree diagram
string WebserviceOutputBuilderCore::renderField(\ObjectModel $object, array $ws_params, string $field_name, array $field, integer $depth)
Build a field and use recursivity depend on the depth parameter.
- Visibility: protected
- Source: classes/webservice/WebserviceOutputBuilder.php line 502
- $object ObjectModel - create by the entity
- $ws_params array - webserviceParams from the entity
- $field_name string
- $field array
- $depth integer
mixed WebserviceOutputBuilderCore::renderFlatAssociation($object, $depth, $assoc_name, $resource_name, $fields_assoc, $object_assoc, $parent_details)
- Visibility: protected
- Source: classes/webservice/WebserviceOutputBuilder.php line 647
- $object mixed
- $depth mixed
- $assoc_name mixed
- $resource_name mixed
- $fields_assoc mixed
- $object_assoc mixed
- $parent_details mixed
string WebserviceOutputBuilderCore::renderSchema($object, $ws_params)
Build a schema blank or synopsis
- Visibility: protected
- Source: classes/webservice/WebserviceOutputBuilder.php line 423
- $object mixed - create by the entity
- $ws_params mixed - webserviceParams from the entity
\WebserviceOutputBuilderCore WebserviceOutputBuilderCore::resetHeaderParams()
Delete all Header parameters previously set.
- Visibility: public
- Source: classes/webservice/WebserviceOutputBuilder.php line 177
mixed WebserviceOutputBuilderCore::setFieldsToDisplay($fields)
- Visibility: public
- Source: classes/webservice/WebserviceOutputBuilder.php line 791
- $fields mixed
\WebserviceOutputBuilderCore WebserviceOutputBuilderCore::setHeaderParams($key, $value)
- Visibility: public
- Source: classes/webservice/WebserviceOutputBuilder.php line 140
- $key mixed - The normalized key expected for an http response
- $value mixed
mixed WebserviceOutputBuilderCore::setIndent($depth)
- Visibility: public
- Source: classes/webservice/WebserviceOutputBuilder.php line 687
- $depth mixed
\WebserviceOutputBuilderCore WebserviceOutputBuilderCore::setObjectRender(\WebserviceOutputInterface $obj_render)
Set the render object for set the output format.
Set the Content-type for the http header.
- Visibility: public
- Source: classes/webservice/WebserviceOutputBuilder.php line 80
- $obj_render WebserviceOutputInterface
\WebserviceOutputBuilderCore WebserviceOutputBuilderCore::setSpecificField(string|object $object, string $method, $field_name, $entity_name)
- Visibility: public
- Source: classes/webservice/WebserviceOutputBuilder.php line 714
- $object string|object
- $method string
- $field_name mixed
- $entity_name mixed
void WebserviceOutputBuilderCore::setStatus(integer $num)
Set the return header status
- Visibility: public
- Source: classes/webservice/WebserviceOutputBuilder.php line 201
- $num integer - the Http status code
mixed WebserviceOutputBuilderCore::setVirtualField($object, $method, $entity_name, $parameters)
- Visibility: public
- Source: classes/webservice/WebserviceOutputBuilder.php line 749
- $object mixed
- $method mixed
- $entity_name mixed
- $parameters mixed
\WebserviceOutputBuilderCore WebserviceOutputBuilderCore::setWsResources(array $resources)
Need to have the resource list to get the class name for an entity, To build
- Visibility: public
- Source: classes/webservice/WebserviceOutputBuilder.php line 108
- $resources array
mixed WebserviceOutputBuilderCore::validateObjectAndMethod($object, $method)
- Visibility: protected
- Source: classes/webservice/WebserviceOutputBuilder.php line 725
- $object mixed
- $method mixed