RedBeanPHP\Facade::useExportCase PHP Method

useExportCase() public static method

This will determine the case style for the keys of exported beans (see exportAll). The following options are accepted: * 'default' RedBeanPHP by default enforces Snake Case (i.e. book_id is_valid ) * 'camel' Camel Case (i.e. bookId isValid ) * 'dolphin' Dolphin Case (i.e. bookID isValid ) Like CamelCase but ID is written all uppercase
public static useExportCase ( string $caseStyle = 'default' ) : void
$caseStyle string case style identifier
return void
    public static function useExportCase($caseStyle = 'default')
    {
        if (!in_array($caseStyle, array('default', 'camel', 'dolphin'))) {
            throw new RedException('Invalid case selected.');
        }
        self::$exportCaseStyle = $caseStyle;
    }

Usage Example

Example #1
0
 /**
  * Test export camelCase.
  *
  * @return void
  */
 public function testExportCamelCase()
 {
     R::nuke();
     $book = R::dispense('book');
     $book->isCheap = true;
     $book->hasISBNCode = false;
     $page = R::dispense('page');
     $page->isWrittenWell = true;
     $page->containsInterestingText = true;
     $book->ownPageList[] = $page;
     R::store($book);
     $book = $book->fresh();
     $export = R::exportAll($book);
     asrt(isset($export[0]['id']), true);
     asrt(isset($export[0]['is_cheap']), true);
     asrt(isset($export[0]['has_isbn_code']), true);
     asrt(isset($export[0]['ownPage']['0']['id']), true);
     asrt(isset($export[0]['ownPage']['0']['is_written_well']), true);
     asrt(isset($export[0]['ownPage']['0']['contains_interesting_text']), true);
     asrt(isset($export[0]['ownPage']['0']['book_id']), true);
     R::useExportCase('camel');
     $export = R::exportAll($book);
     asrt(isset($export[0]['id']), true);
     asrt(isset($export[0]['isCheap']), true);
     asrt(isset($export[0]['hasIsbnCode']), true);
     asrt(isset($export[0]['ownPage']['0']['id']), true);
     asrt(isset($export[0]['ownPage']['0']['isWrittenWell']), true);
     asrt(isset($export[0]['ownPage']['0']['containsInterestingText']), true);
     asrt(isset($export[0]['ownPage']['0']['bookId']), true);
     R::useExportCase('dolphin');
     $export = R::exportAll($book);
     asrt(isset($export[0]['id']), true);
     asrt(isset($export[0]['isCheap']), true);
     asrt(isset($export[0]['hasIsbnCode']), true);
     asrt(isset($export[0]['ownPage']['0']['id']), true);
     asrt(isset($export[0]['ownPage']['0']['isWrittenWell']), true);
     asrt(isset($export[0]['ownPage']['0']['containsInterestingText']), true);
     asrt(isset($export[0]['ownPage']['0']['bookID']), true);
     R::useExportCase('default');
     $export = R::exportAll($book);
     asrt(isset($export[0]['id']), true);
     asrt(isset($export[0]['is_cheap']), true);
     asrt(isset($export[0]['has_isbn_code']), true);
     asrt(isset($export[0]['ownPage']['0']['id']), true);
     asrt(isset($export[0]['ownPage']['0']['is_written_well']), true);
     asrt(isset($export[0]['ownPage']['0']['contains_interesting_text']), true);
     asrt(isset($export[0]['ownPage']['0']['book_id']), true);
     try {
         R::useExportCase('invalid');
         fail();
     } catch (RedException $exception) {
         pass();
     }
 }