phpFox 4 Developer Document
Page tree

Versions Compared

Old Version 2

changes.mady.by.user Raymond Benc

Saved on

compared with

New Version 3

changes.mady.by.user Raymond Benc

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

MethodDescriptionUsageReturns

get(string $key [, int $id = null] )

 

$key

Unique storage key.

$id

If you store multiple data in a key
you can pass a unique ID to return a
specific item from that data set. 

 

Get data from the DB based on a unique key
and/or ID. 

Code Block
languagephp
$object = storage()->get('foo');

echo $object->value;

On success it returns Core\Storage\Object, null on failure.

getById(int $id)

 

$id

Unique auto incremented ID.

Get a specific data set based on the unique
auto incremented key created by Core\Storage\Object. 

Code Block
languagephp
$object = storage()->getById(1);
 
echo $object->value;

On success it returns Core\Storage\Object, null on failure.

all(string $key)

 

$key

Unique storage key.


Returns all data sets based on a unique key.

 

Code Block
$objects = storage()->all('multiple');


foreach ($objects as $object) {
 echo $object->value;
}

Array of values on success, empty array on failure.

Note: Each value from the array is an object from Core\Storage\Object

set(string $key, mixed $value , int $id = 0] )

 

$key

Unique storage key.

$value

Value to set for this entry. Can be a string, array, int or boolean.

$id

(optional) Include a custom unique ID for this data set.

 Sets data into the DB based on your key.

Info
titleNotice

This method will set multiple entries even if the key already exists.
If you only want one entry for a key make sure to check if it exists and use the update method.

Code Block
// Set a string
storage()->set('foo', 'bar');
 
// Set an array
storage()->set('foo_array', [
   'hello' => 'world'
]);
 
// Set multiple values
storage()->set('foo', '1');
storage()->set('foo', '2');
storage()->set('foo', '3');
Returns unique auto increment ID on success, false on failure.