phpDocumentor pivotx
[ class tree: pivotx ] [ index: pivotx ] [ all elements ]

Class: Weblogs

Source Location: /objects.php

Class Weblogs

Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From BaseConfig

BaseConfig::$backup_configfile
BaseConfig::$changed
BaseConfig::$configfile
BaseConfig::$data
BaseConfig::$upgraded

Inherited From BaseConfig

BaseConfig::__construct()
Constructor
BaseConfig::count()
Return configuration-array size
BaseConfig::fixConfig()
Fix configuration (this should be overwritten in subclass)
BaseConfig::initConfig()
Initialise configuration after has been read, fixed and organized.
BaseConfig::loadConfig()
Load and verify config
BaseConfig::organizeConfig()
Organize configuration
BaseConfig::print_r()
Print a comprehensible representation of the users
BaseConfig::save()
Old save version
BaseConfig::saveConfig()
Save configuration if 'safe' to do so
BaseConfig::setChanged()
Set changed flag
BaseConfig::setUpgraded()
Set upgraded
BaseConfig::verifyConfig()
Verify configuration (this should be overwritten in subclass)

[ Top ]
Property Summary
mixed   $current  
mixed   $default  

[ Top ]
Method Summary
Weblogs   __construct()  
Weblogs   Weblogs()  
string   add()   Add a new weblog, based on $theme. returns the internal name used for the weblog.
void   delete()   Delete a weblog
void   deleteCategoryFromWeblogs()  
void   export()   Export a weblog as a theme file. The file is saved in the same folder as the weblog's frontpage template.
void   fixConfig()  
void   get()   Gets a property of a given weblog
array   getCategories()   Get the categories from a certain weblog.
void   getCurrent()   Gets the currently active weblog.
void   getDefault()   Gets the default weblog.
array   getSubweblog()   Return a subweblog as an array
array   getSubweblogs()   Return the subweblogs of a given weblog as an array. It does this by grabbing all [[weblog]] and [[ subweblog ]] tags from the templates in the same folder as the template that was selected as the frontpage template. Updates the subweblog info in the weblogs object.
array   getWeblog()   Returns the given weblog as an array. If no weblogname was given, use the current weblog.
array   getWeblogNames()   Returns an array with the weblog names.
array   getWeblogs()   Return all weblogs as an array
void   getWeblogsWithCat()   Return the weblogs that have the given category or categories assigned to them.
void   initConfig()  
boolean   isWeblog()   Check if a given $name is a weblog.
void   organizeConfig()  
void   readOld()   Read old weblogs data..
void   set()   Sets a property of a given weblog
boolean   setCurrent()   Sets a given weblog as 'current' and returns false if the weblog doesn't exist.
boolean   setCurrentFromCategory()   Sets a given weblog as 'current' based on a given category and returns false if no matching weblog could be set.
int   sort()   Sort the weblogs based on string comparison of name.
void   verifyConfig()  
void   _getLink()   Calculates the link for a given weblog

[ Top ]
Properties
mixed   $current [line 901]

[ Top ]
mixed   $default [line 900]

[ Top ]
Methods
Constructor __construct  [line 903]

  Weblogs __construct( )


API Tags:
Access:  public


Redefinition of:
BaseConfig::__construct()
Constructor

[ Top ]
Constructor Weblogs  [line 907]

  Weblogs Weblogs( )


API Tags:
Access:  public


[ Top ]
add  [line 1386]

  string add( string $internal, string $name, string $theme  )

Add a new weblog, based on $theme. returns the internal name used for the weblog.

Parameters:
string   $internal: 
string   $name: 
string   $theme: 


[ Top ]
delete  [line 1439]

  void delete( string $weblogname  )

Delete a weblog

Parameters:
string   $weblogname: 


[ Top ]
deleteCategoryFromWeblogs  [line 1566]

  void deleteCategoryFromWeblogs( $name  )

Parameters:
   $name: 


[ Top ]
export  [line 1453]

  void export( string $weblogname  )

Export a weblog as a theme file. The file is saved in the same folder as the weblog's frontpage template.

Parameters:
string   $weblogname: 


[ Top ]
fixConfig  [line 917]

  void fixConfig( )


API Tags:
Access:  public


Redefinition of:
BaseConfig::fixConfig()
Fix configuration (this should be overwritten in subclass)

[ Top ]
get  [line 1518]

  void get( string $weblogname, string $key  )

Gets a property of a given weblog

Parameters:
string   $weblogname: 
string   $key: 


[ Top ]
getCategories  [line 1125]

  array getCategories( [string $weblogname = '']  )

Get the categories from a certain weblog.

Parameters:
string   $weblogname: 


[ Top ]
getCurrent  [line 1357]

  void getCurrent( )

Gets the currently active weblog.



[ Top ]
getDefault  [line 1371]

  void getDefault( )

Gets the default weblog.



[ Top ]
getSubweblog  [line 1175]

  array getSubweblog( [string $weblogname = ''], $subweblogname  )

Return a subweblog as an array

Parameters:
string   $weblogname: 
   $subweblogname: 


[ Top ]
getSubweblogs  [line 1193]

  array getSubweblogs( [string $weblogname = '']  )

Return the subweblogs of a given weblog as an array. It does this by grabbing all [[weblog]] and [[ subweblog ]] tags from the templates in the same folder as the template that was selected as the frontpage template. Updates the subweblog info in the weblogs object.

Parameters:
string   $weblogname: 


[ Top ]
getWeblog  [line 1160]

  array getWeblog( [string $weblogname = '']  )

Returns the given weblog as an array. If no weblogname was given, use the current weblog.

Parameters:
string   $weblogname: 


[ Top ]
getWeblogNames  [line 1060]

  array getWeblogNames( )

Returns an array with the weblog names.



[ Top ]
getWeblogs  [line 1049]

  array getWeblogs( )

Return all weblogs as an array



[ Top ]
getWeblogsWithCat  [line 1094]

  void getWeblogsWithCat( array $categories  )

Return the weblogs that have the given category or categories assigned to them.

Parameters:
array   $categories: 


[ Top ]
initConfig  [line 930]

  void initConfig( )


API Tags:
Access:  protected


Redefinition of:
BaseConfig::initConfig()
Initialise configuration after has been read, fixed and organized.

[ Top ]
isWeblog  [line 1078]

  boolean isWeblog( $weblogname, string $name  )

Check if a given $name is a weblog.

Parameters:
string   $name: 
   $weblogname: 


[ Top ]
organizeConfig  [line 980]

  void organizeConfig( )


API Tags:
Access:  protected


Redefinition of:
BaseConfig::organizeConfig()
Organize configuration

[ Top ]
readOld  [line 993]

  void readOld( )

Read old weblogs data..



[ Top ]
set  [line 1469]

  void set( string $weblogname, string $key, string $value  )

Sets a property of a given weblog

Parameters:
string   $weblogname: 
string   $key: 
string   $value: 


[ Top ]
setCurrent  [line 1274]

  boolean setCurrent( [string $weblogname = '']  )

Sets a given weblog as 'current' and returns false if the weblog doesn't exist.

Parameters:
string   $weblogname: 


[ Top ]
setCurrentFromCategory  [line 1301]

  boolean setCurrentFromCategory( mixed $categories  )

Sets a given weblog as 'current' based on a given category and returns false if no matching weblog could be set.

Parameters:
mixed   $categories: 


[ Top ]
sort  [line 1033]

  int sort( array $a, array $b  )

Sort the weblogs based on string comparison of name.

Parameters:
array   $a: 
array   $b: 


[ Top ]
verifyConfig  [line 911]

  void verifyConfig( )


API Tags:
Access:  public


Redefinition of:
BaseConfig::verifyConfig()
Verify configuration (this should be overwritten in subclass)

[ Top ]
_getLink  [line 1545]

  void _getLink( string $weblogname, string $value  )

Calculates the link for a given weblog

Parameters:
string   $value: 
string   $weblogname: 


[ Top ]

Documentation generated on Tue, 05 Sep 2017 01:06:14 +0200 by phpDocumentor 1.4.3