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

Class: apc_queue

Source Location: /apc_queue/class.apc_queue.php

Class Overview


Simple class for fifo queues saved in APC cache


Author(s):

Version:

  • v0.1_2010.01.29

Implements interfaces:

Variables

Methods



Class Details

[line 45]
Simple class for fifo queues saved in APC cache



Tags:

version:  v0.1_2010.01.29
access:  public
name:  APC queue


[ Top ]


Class Variables

$head =  NULL

[line 64]

Key of head counter



Tags:

access:  private

Type:   mixed


[ Top ]

$key =  NULL

[line 59]

Key prefix



Tags:

access:  private

Type:   mixed


[ Top ]

$name =  ''

[line 54]

Name of this queue



Tags:

access:  private

Type:   mixed


[ Top ]

$prefix =  'APC_QUEUE_'

[line 50]

Overall prefix for queue keys



Tags:

access:  private

Type:   mixed


[ Top ]

$tail =  NULL

[line 69]

Key of tail counter



Tags:

access:  private

Type:   mixed


[ Top ]



Class Methods


constructor __construct [line 76]

apc_queue __construct( string $queue_name, [boolean $force_new = FALSE])

Creates queue object. Every queue needs a name.



Tags:

access:  public


Parameters:

string   $queue_name  
boolean   $force_new  

[ Top ]

method add [line 122]

void add( mixed $value)

Adds a value to queue



Tags:

access:  public



Implementation of:
queue_interface::add()

Parameters:

mixed   $value  

[ Top ]

method get [line 133]

mixed get( )

Fetches next value from queue. FALSE if empty.



Tags:

access:  public



Implementation of:
queue_interface::get()
[ Top ]

method init [line 91]

boolean init( [boolean $force_new = FALSE])

Initializes the queue and checks for counter integrity



Tags:

access:  private


Parameters:

boolean   $force_new  

[ Top ]

method length [line 149]

integer length( )

Returns queue length



Tags:

access:  public



Implementation of:
queue_interface::length()
[ Top ]


Documentation generated on Fri, 29 Jan 2010 08:49:11 +0100 by phpDocumentor 1.4.3