Overview

Packages

  • ClipIt
    • clipit
      • api
    • urjc
      • backend
  • Elgg
    • Core
      • Access
      • Authentication
      • Cache
      • Caches
      • Core
      • DataMode
        • Site
      • DataModel
        • Annotations
        • Entities
        • Extender
        • File
        • Importable
        • Loggable
        • Notable
        • Object
        • User
      • DataStorage
      • Exception
      • Exceptions
        • Stub
      • FileStore
        • Disk
      • Groups
      • Helpers
      • HMAC
      • Memcache
      • Metadata
      • Navigation
      • ODD
      • Output
      • Plugins
        • Settings
      • Sessions
      • SocialModel
        • Friendable
        • Locatable
      • WebServicesAPI
      • Widgets
      • XML
      • XMLRPC
    • Exceptions
      • Stub
  • None
  • PHP

Classes

  • UBCollection
  • UBEvent
  • UBFile
  • UBItem
  • UBMessage
  • UBSite
  • UBUser
  • Overview
  • Package
  • Class
  • Tree

Class UBSite

<Class Description>

Direct known subclasses

ClipitSite
Package: ClipIt\urjc\backend
License: Affero General Public License v3
Author: Pablo LlinĂ¡s Arnaiz <pebs74@gmail.com>, URJC JuxtaLearn Team
Located at UBSite.php
Methods summary
public
# __construct( )

Constructor

Constructor

Throws

APIException
protected
# copy_from_elgg( ElggEntity $elgg_entity )

Loads object parameters stored in Elgg

Loads object parameters stored in Elgg

Parameters

$elgg_entity
ElggEntity
$elgg_entity Elgg Object to load parameters from.
protected integer
# save( )

Saves Site parameters into Elgg

Saves Site parameters into Elgg

Returns

integer
Site ID
protected
# copy_to_elgg( ElggEntity $elgg_entity )

Parameters

$elgg_entity
ElggEntity
$elgg_entity
public static
# get_site( )
public static
# get_site_id( )
public static array
# get_all( integer $limit = 0, integer $offset = 0, string $order_by = "", boolean $ascending = true, boolean $id_only = false )

Dummy method in case someone treats ClipIt Site as a typical ClipIt Object

Dummy method in case someone treats ClipIt Site as a typical ClipIt Object

Parameters

$limit
integer
$limit
$offset
integer
$offset
$order_by
string
$order_by
$ascending
boolean
$ascending
$id_only
boolean
$id_only

Returns

array
public static array
# api_list( )

Get the REST API method list, including description and required parameters.

Get the REST API method list, including description and required parameters.

Returns

array
List of all available REST API Methods.
public static string
# get_token( string $login, string $password = "", integer $timeout = 60 )

Get authentication token, required for all other REST API calls. The token must be set as the value for the "auth_token" key in each REST API call.

Get authentication token, required for all other REST API calls. The token must be set as the value for the "auth_token" key in each REST API call.

Parameters

$login
string
$login User login
$password
string
$password User password
$timeout
integer
$timeout Session timeout in minutes

Returns

string
Authentication Token.

Throws

SecurityException
public static
# remove_token( mixed $token )
public static
# lookup( mixed $id )
public static
# get_domain( )
public static
# normalize_xml_key( mixed $key )
public static array
# list_properties( )

Lists the properties contained in this object

Lists the properties contained in this object

Returns

array
Array of properties with type and default value
Constants summary
string SUBTYPE "UBSite"
#

Const

string Elgg entity SUBTYPE for this class
Properties summary
public integer $id 0
#
public string $name ""
#
public string $description ""
#
public string $url ""
#
public integer $owner_id 0
#
public integer $time_created 0
#
API documentation generated by ApiGen 2.8.0