BlueShoes Application Framework made with PHP http://www.blueshoes.org/


Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: C:/usr/local/lib/php/blueshoes-4.2/core/net/http/Bs_LittleSister.class.php
BlueShoes Application Framework - net/http

Bs_LittleSister

Bs_Object
   |
  +-- Bs_LittleSister

Little Sister Class.

 

public class Bs_LittleSister extends Bs_Object

Little Sister Class.
dependencies: Bs_Dir, Bs_File,

Authors
Sincebs4.2
Version4.0.$id$
Copyrightblueshoes.org

 

Methods inherited from Bs_Object

isex, isexception, tostring, tohtml, persist, unpersist, bs_object, bbsetoutput, bbawake, bbisawake, bbxmsg, bbxfunctionstart, bbxfunctionend, bbxecho, bbxvar, bbxvardump, bbforcetrace, bbbufferstart, bbbufferget, bbbufferendflush, bbbufferendclean

Public Method Summary

void

Bs_LittleSister()

Constructor.
bool

doItYourself()

Private Method Summary

bool

_lookupUser()

checks if we have a record for that user, and if so, sets it for this instance.
void

setCookie([ string $userId ])

sets a cookie to the users machine using the userId, if given.
void

logRequest()

logs the current request including get and post data.
void

logThis()

log a var (string, array, whatever) into the log file.
string

_getLogPath()

Public Field Summary

string

$logPath

the path where the logfiles will be stored.
string

$doAutoCreate

if set to true then 'accounts' will be created for unknown users.

Private Field Summary

string

$cookieName

the name of the little-sister cookie to identify the user
string

$_userId

the unique userId the current user has.
unknown

$blobFormat

how shoud blob data, for example POST data, be stored?
unknown

$this

Private Constant Summary

BS_LITTLESISTER_VERSION >>4.0.$x$<< Warning: documentation is missing.

Public Method Details

Bs_LittleSister

public void Bs_LittleSister( )

  Constructor.

Returns void


doItYourself

public bool doItYourself( )

 

Returns bool

See Also $this

Private Method Details

_lookupUser

private bool _lookupUser( )

  checks if we have a record for that user, and if so, sets it for this instance.

Returns bool


setCookie

private void setCookie( [ string $userId ] )

  sets a cookie to the users machine using the userId, if given.
otherwise a unique userId is made up.

Parameter
string $userId = >>NULL<<
Returns void


logRequest

private void logRequest( )

  logs the current request including get and post data.

Returns void


logThis

private void logThis( )

  log a var (string, array, whatever) into the log file.
arrays and objects will be dumped.

Returns void


_getLogPath

private string _getLogPath( )

 

Returns string

See Also $this

Public Field Details

$logPath

public string $logPath

>><<

the path where the logfiles will be stored.
each unique user gets its own log dir.if not specified then $APP['path']['site'] . 'data/littleSister/' will be used.any path that does not exist will be created.please don't forget the last slash.

See Also $this

$doAutoCreate

public string $doAutoCreate

>>FALSE<<

if set to true then 'accounts' will be created for unknown users.


Private Field Details

$cookieName

private string $cookieName

>>'SESS10N'<<

the name of the little-sister cookie to identify the user
the default is the uppercase version of sess10n, that is "sess-then-n".looks like session :-)if ppl see that such a cookie gets set, the chance is better they accept it.


$_userId

private string $_userId

>><<

the unique userId the current user has.


$blobFormat

private unknown $blobFormat

>><<

how shoud blob data, for example POST data, be stored?
dump => the human-readable output of dump() (default)s_php => serialize using phps_wddx => serialize using wddx. note: wddx must be installed!


$this

private unknown $this

>><<



Private Constant Details

BS_LITTLESISTER_VERSION

define( BS_LITTLESISTER_VERSION, >>4.0.$x$<< )
Case: default: case sensitive




Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta