apiconnections.php

Summary
apiconnections.php
APIConnectionsSimple API endpoint that displays the number of nodes that this one connects to.
ApiConnectionsActionClass which handles the API connections display endpoint.
prepareGet the endpoint ready for action
handleDisplay the number of connections in the given format.
isReadOnlyIs this end-point read-only? 

APIConnections

Simple API endpoint that displays the number of nodes that this one connects to.

postActiv

the micro-blogging software

Copyright

Copyright © 2016-2017, Maiyannah Bishop

Derived from code copyright various sources

  • GNU Social © 2013-2016, Free Software Foundation, Inc
  • StatusNet © 2008-2012, StatusNet, Inc

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program.  If not, see http://www.gnu.org/licenses/.

https://www.gnu.org/licenses/agpl.html

About

Simple API endpoint that displays the number of nodes that this one connects to.

Output in JSON

”connections”: {“total”:”123” ,unique:”69”}

Output in XML

<connections> <total>123</total> <unique>69</unique> </connections>

Output in YAML

connections:

  • total: 123
  • unique: 69

PHP version

Tested with PHP 7.0

File Authors

Web

ApiConnectionsAction

Class which handles the API connections display endpoint.

Summary
prepareGet the endpoint ready for action
handleDisplay the number of connections in the given format.
isReadOnlyIs this end-point read-only? 

prepare

protected function prepare(array $args = array())

Get the endpoint ready for action

handle

protected function handle()

Display the number of connections in the given format.

isReadOnly

function isReadOnly($args)

Is this end-point read-only?  (yes)

protected function prepare(array $args = array())
Get the endpoint ready for action
protected function handle()
Display the number of connections in the given format.
function isReadOnly($args)
Is this end-point read-only?