public function documentMethod(\ReflectionClass $rClass, \ReflectionMethod $rMethod, array &$methodDoc)
{
parent::documentMethod($rClass, $rMethod, $methodDoc);
$methodDoc['parameters'][] = array('Name' => 'SESSION', 'Required' => 'N', 'Type' => 'string', 'Location' => 'header', 'Description' => 'A guid that identifies the current logged in session (the session id when you create a session)');
if (!empty($this->next)) {
$this->next->documentMethod($rClass, $rMethod, $methodDoc);
}
}
public function documentMethod(\ReflectionClass $rClass, \ReflectionMethod $rMethod, array &$methodDoc)
{
parent::documentMethod($rClass, $rMethod, $methodDoc);
$methodDoc['parameters'][] = array('Name' => 'anonuuid', 'Required' => 'N', 'Type' => 'string', 'Location' => 'header', 'Description' => 'A guid that can be passed in to identify an anonymous user');
if (!empty($this->next)) {
$this->next->documentMethod($rClass, $rMethod, $methodDoc);
}
}
public function documentMethod(\ReflectionClass $rClass, \ReflectionMethod $rMethod, array &$methodDoc)
{
parent::documentMethod($rClass, $rMethod, $methodDoc);
$methodDoc['parameters'][] = array('Name' => 'shared-secret', 'Required' => 'N', 'Type' => 'string', 'Location' => 'header', 'Description' => 'The guid that identifies which application is attempting to access this endpoint. Only
the application itself and the internal API should be able to see this value, therefore, it should always
be transmitted over HTTPs.');
if (!empty($this->next)) {
$this->next->documentMethod($rClass, $rMethod, $methodDoc);
}
}
/**
* Removes the documentation for methods that the api does not have access to
*
* @param \ReflectionClass $rClass
* @param \ReflectionMethod $rMethod
* @param array $methodDoc
*/
public function documentMethod(\ReflectionClass $rClass, \ReflectionMethod $rMethod, array &$methodDoc)
{
parent::documentMethod($rClass, $rMethod, $methodDoc);
if (!$this->doesHaveAccessToMethod($rMethod->name)) {
$methodDoc = NULL;
return;
}
if (!empty($this->next)) {
$this->next->documentMethod($rClass, $rMethod, $methodDoc);
}
}
public function documentMethod(\ReflectionClass $rClass, \ReflectionMethod $rMethod, array &$methodDoc)
{
parent::documentMethod($rClass, $rMethod, $methodDoc);
foreach ($methodDoc['parameters'] as $k => $parameter) {
if ($parameter['Name'] == 'SESSION') {
$methodDoc['parameters'][$k]['Required'] = 'Y';
}
}
if (!empty($this->next)) {
$this->next->documentMethod($rClass, $rMethod, $methodDoc);
}
}
public function documentMethod(\ReflectionClass $rClass, \ReflectionMethod $rMethod, array &$methodDoc)
{
parent::documentMethod($rClass, $rMethod, $methodDoc);
// todo: adjust if not only shared-secret access
foreach ($methodDoc['parameters'] as $k => $parameter) {
if ($parameter['Name'] == 'shared-secret') {
$methodDoc['parameters'][$k]['Required'] = 'Y';
}
}
if (!empty($this->next)) {
$this->next->documentMethod($rClass, $rMethod, $methodDoc);
}
}
public function documentMethod(\ReflectionClass $rClass, \ReflectionMethod $rMethod, array &$methodDoc)
{
parent::documentMethod($rClass, $rMethod, $methodDoc);
// Owner access does not apply for Collection level functions
if ($this->isCollectionCallable($rMethod->name)) {
$this->callNextDocumenter($rClass, $rMethod, $methodDoc);
return;
}
foreach ($methodDoc['parameters'] as $k => $parameter) {
if ($parameter['Name'] == 'SESSION') {
$methodDoc['parameters'][$k]['Required'] = 'Y';
}
}
$this->callNextDocumenter($rClass, $rMethod, $methodDoc);
}
public function documentMethod(\ReflectionClass $rClass, \ReflectionMethod $rMethod, array &$methodDoc)
{
parent::documentMethod($rClass, $rMethod, $methodDoc);
$methodDoc = NULL;
return;
}