Reformat class files based on PHP coding convention

git-svn-id: http://xe-core.googlecode.com/svn/branches/1.5.0@9828 201d5d3c-b55e-5fd7-737f-ddc643e51545
This commit is contained in:
taggon 2011-11-17 02:00:46 +00:00
parent 339b2de797
commit be6d9a096d
6 changed files with 1085 additions and 1081 deletions

View file

@ -1,72 +1,72 @@
<?php
/**
* @class CacheApc
* @author NHN (developer@xpressengine.com)
* @brief APC Handler
* @version 0.1
*
**/
/**
* @class CacheApc
* @author NHN (developer@xpressengine.com)
* @brief APC Handler
* @version 0.1
**/
class CacheApc extends CacheBase {
var $valid_time = 36000;
class CacheApc extends CacheBase {
var $valid_time = 36000;
function getInstance($opt=null){
if(!$GLOBALS['__CacheApc__']) {
$GLOBALS['__CacheApc__'] = new CacheApc();
}
return $GLOBALS['__CacheApc__'];
}
function CacheApc(){
}
function isSupport(){
return function_exists('apc_add');
}
function put($key, $buff, $valid_time = 0){
if($valid_time == 0) $valid_time = $this->valid_time;
return apc_store(md5(_XE_PATH_.$key), array(time(), $buff), $valid_time);
}
function isValid($key, $modified_time = 0) {
$_key = md5(_XE_PATH_.$key);
$obj = apc_fetch($_key, $success);
if(!$success || !is_array($obj)) return false;
unset($obj[1]);
if($modified_time > 0 && $modified_time > $obj[0]) {
$this->_delete($_key);
return false;
}
return true;
}
function get($key, $modified_time = 0) {
$_key = md5(_XE_PATH_.$key);
$obj = apc_fetch($_key, $success);
if(!$success || !is_array($obj)) return false;
if($modified_time > 0 && $modified_time > $obj[0]) {
$this->_delete($_key);
return false;
}
return $obj[1];
}
function _delete($_key) {
$this->put($_key,null,1);
}
function delete($key) {
$this->_delete($key);
}
function truncate() {
return apc_clear_cache('user');
function getInstance($opt=null){
if(!$GLOBALS['__CacheApc__']) {
$GLOBALS['__CacheApc__'] = new CacheApc();
}
return $GLOBALS['__CacheApc__'];
}
?>
function CacheApc(){
}
function isSupport(){
return function_exists('apc_add');
}
function put($key, $buff, $valid_time = 0){
if($valid_time == 0) $valid_time = $this->valid_time;
return apc_store(md5(_XE_PATH_.$key), array(time(), $buff), $valid_time);
}
function isValid($key, $modified_time = 0) {
$_key = md5(_XE_PATH_.$key);
$obj = apc_fetch($_key, $success);
if(!$success || !is_array($obj)) return false;
unset($obj[1]);
if($modified_time > 0 && $modified_time > $obj[0]) {
$this->_delete($_key);
return false;
}
return true;
}
function get($key, $modified_time = 0) {
$_key = md5(_XE_PATH_.$key);
$obj = apc_fetch($_key, $success);
if(!$success || !is_array($obj)) return false;
if($modified_time > 0 && $modified_time > $obj[0]) {
$this->_delete($_key);
return false;
}
return $obj[1];
}
function _delete($_key) {
$this->put($_key,null,1);
}
function delete($key) {
$this->_delete($key);
}
function truncate() {
return apc_clear_cache('user');
}
}
/* End of file CacheApc.class.php */
/* Location: ./classes/cache/CacheApc.class.php */

View file

@ -4,21 +4,20 @@
* @author NHN (developer@xpressengine.com)
* @brief Cache Handler
* @version 0.1
*
**/
class CacheHandler extends Handler {
var $handler = null;
var $keyGroupVersions = null;
function &getInstance($target='object') {
function &getInstance($target = 'object') {
if(!$GLOBALS['__XE_CACHE_HANDLER__'][$target]) {
$GLOBALS['__XE_CACHE_HANDLER__'][$target] = new CacheHandler($target);
}
return $GLOBALS['__XE_CACHE_HANDLER__'][$target];
}
function CacheHandler($target, $info=null) {
function CacheHandler($target, $info = null) {
if(!$info) $info = Context::getDBInfo();
if($info){
if($target == 'object'){
@ -39,11 +38,11 @@ class CacheHandler extends Handler {
$class = 'Cache' . ucfirst($type);
include_once sprintf('%sclasses/cache/%s.class.php', _XE_PATH_, $class);
$this->handler = call_user_func(array($class,'getInstance'), $url);
$this->keyGroupVersions = $this->handler->get('key_group_versions', 0);
if(!$this->keyGroupVersions) {
$this->keyGroupVersions = array();
$this->handler->put('key_group_versions', $this->keyGroupVersions, 0);
}
$this->keyGroupVersions = $this->handler->get('key_group_versions', 0);
if(!$this->keyGroupVersions) {
$this->keyGroupVersions = array();
$this->handler->put('key_group_versions', $this->keyGroupVersions, 0);
}
}
}
}
@ -127,4 +126,5 @@ class CacheBase{
}
}
/* End of file : CacheHandler.class.php */
/* End of file CacheHandler.class.php */
/* Location: ./classes/cache/CacheHandler.class.php */

View file

@ -1,97 +1,97 @@
<?php
/**
* @class CacheMemcache
* @author NHN (developer@xpressengine.com)
* @brief Memcache Handler
* @version 0.1
*
**/
/**
* @class CacheMemcache
* @author NHN (developer@xpressengine.com)
* @brief Memcache Handler
* @version 0.1
**/
class CacheMemcache extends CacheBase {
class CacheMemcache extends CacheBase {
var $valid_time = 36000;
var $Memcache;
var $valid_time = 36000;
var $Memcache;
function getInstance($url){
if(!$GLOBALS['__CacheMemcache__']) {
$GLOBALS['__CacheMemcache__'] = new CacheMemcache($url);
}
return $GLOBALS['__CacheMemcache__'];
function getInstance($url){
if(!$GLOBALS['__CacheMemcache__']) {
$GLOBALS['__CacheMemcache__'] = new CacheMemcache($url);
}
return $GLOBALS['__CacheMemcache__'];
}
function CacheMemcache($url){
//$config['url'] = array('memcache://localhost:11211');
$config['url'] = is_array($url)?$url:array($url);
$this->Memcache = new Memcache;
function CacheMemcache($url){
//$config['url'] = array('memcache://localhost:11211');
$config['url'] = is_array($url)?$url:array($url);
$this->Memcache = new Memcache;
foreach($config['url'] as $url) {
$info = parse_url($url);
$this->Memcache->addServer($info['host'], $info['port']);
}
}
function isSupport(){
if($GLOBALS['XE_MEMCACHE_SUPPORT']) return true;
if($this->Memcache->set('xe', 'xe', MEMCACHE_COMPRESSED, 1)) {
$GLOBALS['XE_MEMCACHE_SUPPORT'] = true;
} else {
$GLOBALS['XE_MEMCACHE_SUPPORT'] = false;
}
return $GLOBALS['XE_MEMCACHE_SUPPORT'];
}
function getKey($key){
return md5(_XE_PATH_.$key);
}
function put($key, $buff, $valid_time = 0){
if($valid_time == 0) $valid_time = $this->valid_time;
return $this->Memcache->set($this->getKey($key), array(time(), $buff), MEMCACHE_COMPRESSED, $valid_time);
}
function isValid($key, $modified_time = 0) {
$_key = $this->getKey($key);
$obj = $this->Memcache->get($_key);
if(!$obj || !is_array($obj)) return false;
unset($obj[1]);
if($modified_time > 0 && $modified_time > $obj[0]) {
$this->_delete($_key);
return false;
}
return true;
}
function get($key, $modified_time = 0) {
$_key = $this->getKey($key);
$obj = $this->Memcache->get($_key);
if(!$obj || !is_array($obj)) return false;
if($modified_time > 0 && $modified_time > $obj[0]) {
$this->_delete($_key);
return false;
}
unset($obj[0]);
return $obj[1];
}
function delete($key) {
$_key = $this->getKey($key);
$this->_delete($_key);
}
function _delete($_key) {
$this->Memcache->delete($_key);
}
function truncate() {
// not support memcached
return false;
foreach($config['url'] as $url) {
$info = parse_url($url);
$this->Memcache->addServer($info['host'], $info['port']);
}
}
?>
function isSupport(){
if($GLOBALS['XE_MEMCACHE_SUPPORT']) return true;
if($this->Memcache->set('xe', 'xe', MEMCACHE_COMPRESSED, 1)) {
$GLOBALS['XE_MEMCACHE_SUPPORT'] = true;
} else {
$GLOBALS['XE_MEMCACHE_SUPPORT'] = false;
}
return $GLOBALS['XE_MEMCACHE_SUPPORT'];
}
function getKey($key){
return md5(_XE_PATH_.$key);
}
function put($key, $buff, $valid_time = 0){
if($valid_time == 0) $valid_time = $this->valid_time;
return $this->Memcache->set($this->getKey($key), array(time(), $buff), MEMCACHE_COMPRESSED, $valid_time);
}
function isValid($key, $modified_time = 0) {
$_key = $this->getKey($key);
$obj = $this->Memcache->get($_key);
if(!$obj || !is_array($obj)) return false;
unset($obj[1]);
if($modified_time > 0 && $modified_time > $obj[0]) {
$this->_delete($_key);
return false;
}
return true;
}
function get($key, $modified_time = 0) {
$_key = $this->getKey($key);
$obj = $this->Memcache->get($_key);
if(!$obj || !is_array($obj)) return false;
if($modified_time > 0 && $modified_time > $obj[0]) {
$this->_delete($_key);
return false;
}
unset($obj[0]);
return $obj[1];
}
function delete($key) {
$_key = $this->getKey($key);
$this->_delete($_key);
}
function _delete($_key) {
$this->Memcache->delete($_key);
}
function truncate() {
// not supported on memcached
return false;
}
}
/* End of file CacheMemcache.class.php */
/* Location: ./classes/cache/CacheMemcache.class.php */

File diff suppressed because it is too large Load diff

View file

@ -1,128 +1,129 @@
<?php
/**
* @class FileObject
* @author NHN (developers@xpressengine.com)
* @brief file abstraction class
**/
/**
* @class FileObject
* @author NHN (developers@xpressengine.com)
* @brief file abstraction class
**/
class FileObject extends Object
{
var $fp = null; ///< file descriptor
var $path = null; ///< file path
var $mode = "r"; ///< file open mode
class FileObject extends Object
{
var $fp = null; ///< file descriptor
var $path = null; ///< file path
var $mode = "r"; ///< file open mode
/**
* @brief constructor
* @param[in] $path path of target file
* @param[in] $mode file open mode
* @return file object
**/
function FileObject($path, $mode)
{
if($path != null) $this->Open($path, $mode);
}
/**
* @brief constructor
* @param[in] $path path of target file
* @param[in] $mode file open mode
* @return file object
**/
function FileObject($path, $mode)
{
if($path != null) $this->Open($path, $mode);
}
/**
* @brief append target file's content to current file
* @param[in] $file_name path of target file
* @return none
**/
function append($file_name)
{
$target = new FileObject($file_name, "r");
while(!$target->feof())
{
$readstr = $target->read();
$this->write($readstr);
}
$target->close();
}
/**
* @brief append target file's content to current file
* @param[in] $file_name path of target file
* @return none
**/
function append($file_name)
{
$target = new FileObject($file_name, "r");
while(!$target->feof())
{
$readstr = $target->read();
$this->write($readstr);
}
$target->close();
}
/**
* @brief check current file meets eof
* @return true: if eof. false: otherwise
**/
function feof()
{
return feof($this->fp);
}
/**
* @brief check current file meets eof
* @return true: if eof. false: otherwise
**/
function feof()
{
return feof($this->fp);
}
/**
* @brief read from current file
* @param[in] $size size to read
* @return read bytes
**/
function read($size = 1024)
{
return fread($this->fp, $size);
}
/**
* @brief read from current file
* @param[in] $size size to read
* @return read bytes
**/
function read($size = 1024)
{
return fread($this->fp, $size);
}
/**
* @brief write string to current file
* @param[in] $str string to write
* @return written bytes. if failed, it returns false
**/
function write($str)
{
$len = strlen($str);
if(!$str || $len <= 0) return false;
if(!$this->fp) return false;
$written = fwrite($this->fp, $str);
return $written;
}
/**
* @brief write string to current file
* @param[in] $str string to write
* @return written bytes. if failed, it returns false
**/
function write($str)
{
$len = strlen($str);
if(!$str || $len <= 0) return false;
if(!$this->fp) return false;
$written = fwrite($this->fp, $str);
return $written;
}
/**
* @brief open a file
* @param[in] $path path of target file
* @param[in] $mode file open mode
* @remarks if file is opened, close it and open the new path
* @return true if succeed, false otherwise.
*/
function open($path, $mode)
{
if($this->fp != null)
{
$this->close();
}
$this->fp = fopen($path, $mode);
if(! is_resource($this->fp) )
{
$this->fp = null;
return false;
}
$this->path = $path;
return true;
}
/**
* @brief open a file
* @param[in] $path path of target file
* @param[in] $mode file open mode
* @remarks if file is opened, close it and open the new path
* @return true if succeed, false otherwise.
*/
function open($path, $mode)
{
if($this->fp != null)
{
$this->close();
}
$this->fp = fopen($path, $mode);
if(! is_resource($this->fp) )
{
$this->fp = null;
return false;
}
$this->path = $path;
return true;
}
/**
* @brief return current file's path
* @return file path
**/
function getPath()
{
if($this->fp != null)
{
return $this->path;
}
else
{
return null;
}
}
/**
* @brief return current file's path
* @return file path
**/
function getPath()
{
if($this->fp != null)
{
return $this->path;
}
else
{
return null;
}
}
/**
* @brief close file
* @return none
**/
function close()
{
if($this->fp != null)
{
fclose($this->fp);
$this->fp = null;
}
}
/**
* @brief close file
* @return none
**/
function close()
{
if($this->fp != null)
{
fclose($this->fp);
$this->fp = null;
}
}
}
}
?>
/* End of file FileObject.class.php */
/* Location: ./classes/file/FileObject.class.php */

View file

@ -1,148 +1,149 @@
<?php
/**
* @class Object
* @author NHN (developers@xpressengine.com)
* @brief Base class design to pass the Object instance between XE Modules
*
* @remark Every modules inherits from Object class. It includes error, message, and other variables for communicatin purpose
**/
/**
* @class Object
* @author NHN (developers@xpressengine.com)
* @brief Base class design to pass the Object instance between XE Modules
*
* @remark Every modules inherits from Object class. It includes error, message, and other variables for communicatin purpose
**/
class Object {
class Object {
var $error = 0; // / "Error code (if 0, it is not an error)
var $message = 'success'; // / "Error message (if success, it is not an error)
var $error = 0; // / "Error code (if 0, it is not an error)
var $message = 'success'; // / "Error message (if success, it is not an error)
var $variables = array(); // /< an additional variable
var $httpStatusCode = NULL; ///< http status code.
var $variables = array(); // /< an additional variable
var $httpStatusCode = NULL; ///< http status code.
/**
* @brief constructor
**/
function Object($error = 0, $message = 'success') {
$this->setError($error);
$this->setMessage($message);
}
/**
* @brief constructor
**/
function Object($error = 0, $message = 'success') {
$this->setError($error);
$this->setMessage($message);
}
/**
* @brief Setter to set error code
* @param[in] $error error code
**/
function setError($error = 0) {
$this->error = $error;
}
/**
* @brief Setter to set error code
* @param[in] $error error code
**/
function setError($error = 0) {
$this->error = $error;
}
/**
* @brief Getter to retrieve error code
**/
function getError() {
return $this->error;
}
/**
* @brief Getter to retrieve error code
**/
function getError() {
return $this->error;
}
function setHttpStatusCode($code = '200')
{
$this->httpStatusCode = $code;
}
function setHttpStatusCode($code = '200')
{
$this->httpStatusCode = $code;
function getHttpStatusCode()
{
return $this->httpStatusCode;
}
/**
* @brief Setter to set set the error message
* @param[in] $message a messge string
* @return return True
* @remark this method always returns True. We'd better remove it
**/
function setMessage($message = 'success') {
if(Context::getLang($message)) $message = Context::getLang($message);
$this->message = $message;
return true;
}
/**
* @brief getter to retrieve an error message
**/
function getMessage() {
return $this->message;
}
/**
* @brief setter to set a key/value pair as an additional variable
* @param[in] $key a variable name
* @param[in] $val a value for the variable
**/
function add($key, $val) {
$this->variables[$key] = $val;
}
/**
* @brief method to set multiple key/value pairs as an additional variables
* @param[in] $object either object or array containg key/value pairs to be added
**/
function adds($object) {
if(is_object($object)) {
$vars = get_object_vars($object);
foreach($vars as $key => $val) $this->add($key, $val);
} elseif(is_array($object)) {
foreach($object as $key => $val) $this->add($key, $val);
}
}
function getHttpStatusCode()
{
return $this->httpStatusCode;
/**
* @brief method to retrieve a corresponding value to a given key
**/
function get($key) {
return $this->variables[$key];
}
/**
* @brief method to retrieve an object containing a key/value paris
* @return Returns an object containing key/value pairs
**/
function gets() {
$num_args = func_num_args();
$args_list = func_get_args();
for($i=0;$i<$num_args;$i++) {
$key = $args_list[$i];
$output->{$key} = $this->get($key);
}
return $output;
}
/**
* @brief Setter to set set the error message
* @param[in] $message a messge string
* @return return True
* @remark this method always returns True. We'd better remove it
**/
function setMessage($message = 'success') {
if(Context::getLang($message)) $message = Context::getLang($message);
$this->message = $message;
return true;
}
/**
* @brief method to retrieve an array of key/value pairs
* @return Return a list of key/value pairs
**/
function getVariables() {
return $this->variables;
}
/**
* @brief getter to retrieve an error message
**/
function getMessage() {
return $this->message;
}
/**
* @brief method to retrieve an object of key/value pairs
* @return Return an object of key/value pairs
**/
function getObjectVars() {
foreach($this->variables as $key => $val) $output->{$key} = $val;
return $output;
}
/**
* @brief setter to set a key/value pair as an additional variable
* @param[in] $key a variable name
* @param[in] $val a value for the variable
**/
function add($key, $val) {
$this->variables[$key] = $val;
}
/**
* @brief method to set multiple key/value pairs as an additional variables
* @param[in] $object either object or array containg key/value pairs to be added
**/
function adds($object) {
if(is_object($object)) {
$vars = get_object_vars($object);
foreach($vars as $key => $val) $this->add($key, $val);
} elseif(is_array($object)) {
foreach($object as $key => $val) $this->add($key, $val);
}
}
/**
* @brief method to retrieve a corresponding value to a given key
**/
function get($key) {
return $this->variables[$key];
}
/**
* @brief method to return either true or false depnding on the value in a 'error' variable
* @remark this method is misleading in that it returns true if error is 0, which should be true in
* boolean representation.
**/
function toBool() {
return $this->error==0?true:false;
}
/**
* @brief method to retrieve an object containing a key/value paris
* @return Returns an object containing key/value pairs
**/
function gets() {
$num_args = func_num_args();
$args_list = func_get_args();
for($i=0;$i<$num_args;$i++) {
$key = $args_list[$i];
$output->{$key} = $this->get($key);
}
return $output;
}
/**
* @brief method to return either true or false depnding on the value in a 'error' variable
**/
function toBoolean() {
return $this->toBool();
}
}
/**
* @brief method to retrieve an array of key/value pairs
* @return Return a list of key/value pairs
**/
function getVariables() {
return $this->variables;
}
/**
* @brief method to retrieve an object of key/value pairs
* @return Return an object of key/value pairs
**/
function getObjectVars() {
foreach($this->variables as $key => $val) $output->{$key} = $val;
return $output;
}
/**
* @brief method to return either true or false depnding on the value in a 'error' variable
* @remark this method is misleading in that it returns true if error is 0, which should be true in
* boolean representation.
**/
function toBool() {
return $this->error==0?true:false;
}
/**
* @brief method to return either true or false depnding on the value in a 'error' variable
**/
function toBoolean() {
return $this->toBool();
}
}
?>
/* End of file Object.class.php */
/* Location: ./classes/object/Object.class.php */