Ampache
[ class tree: Ampache ] [ index: Ampache ] [ all elements ]

Class: shoutBox

Source Location: /lib/class/shoutbox.class.php

Class Overview




Variables

Methods



Class Details

[line 22]


[ Top ]


Class Variables

$id =

[line 24]



Tags:

access:  public

Type:   mixed


[ Top ]



Class Methods


static method create [line 157]

static void create( $data)

create

This takes a key'd array of data as input and inserts a new shoutbox entry, it returns the auto_inc id




Tags:

access:  public


Parameters:

   $data  

[ Top ]

static method get_object [line 112]

static void get_object( $type, $object_id)

get_object

This takes a type and an ID and returns a created object




Tags:

access:  public


Parameters:

   $type  
   $object_id  

[ Top ]

static method get_sticky [line 93]

static void get_sticky( )

get_sticky

This returns all current sticky shoutbox items




Tags:

access:  public


[ Top ]

static method get_top [line 66]

static void get_top( $limit)

get_top

This returns the top user_shouts, shoutbox objects are always shown regardless and count against the total number of objects shown




Tags:

access:  public


Parameters:

   $limit  

[ Top ]

static method update [line 180]

static void update( $data)

update

This takes a key'd array of data as input and updates a shoutbox entry




Tags:

access:  public


Parameters:

   $data  

[ Top ]

constructor __construct [line 31]

shoutBox __construct( $shout_id)

Constructor

This pulls the shoutbox information from the database and returns a constructed object, uses user_shout table




Tags:

access:  public


Parameters:

   $shout_id  

[ Top ]

method delete [line 213]

void delete( $shout_id)

delete

this function deletes a specific shoutbox entry




Tags:

access:  public


Parameters:

   $shout_id  

[ Top ]

method format [line 198]

void format( )

format

this function takes the object and reformats some values




Tags:

access:  public


[ Top ]

method get_image [line 131]

void get_image( )

get_image

This returns an image tag if the type of object we're currently rolling with has an image assoicated with it




Tags:

access:  public


[ Top ]


Documentation generated on Thu, 12 Feb 2009 08:00:08 +0900 by phpDocumentor 1.4.2