/home/edulekha/studygroup.edulekha.com/ow_system_plugins/base/bol/document_dao.php
<?php
/**
* EXHIBIT A. Common Public Attribution License Version 1.0
* The contents of this file are subject to the Common Public Attribution License Version 1.0 (the “License”);
* you may not use this file except in compliance with the License. You may obtain a copy of the License at
* http://www.oxwall.org/license. The License is based on the Mozilla Public License Version 1.1
* but Sections 14 and 15 have been added to cover use of software over a computer network and provide for
* limited attribution for the Original Developer. In addition, Exhibit A has been modified to be consistent
* with Exhibit B. Software distributed under the License is distributed on an “AS IS” basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language
* governing rights and limitations under the License. The Original Code is Oxwall software.
* The Initial Developer of the Original Code is Oxwall Foundation (http://www.oxwall.org/foundation).
* All portions of the code written by Oxwall Foundation are Copyright (c) 2011. All Rights Reserved.
* EXHIBIT B. Attribution Information
* Attribution Copyright Notice: Copyright 2011 Oxwall Foundation. All rights reserved.
* Attribution Phrase (not exceeding 10 words): Powered by Oxwall community software
* Attribution URL: http://www.oxwall.org/
* Graphic Image as provided in the Covered Code.
* Display of Attribution Information is required in Larger Works which are defined in the CPAL as a work
* which combines Covered Code or portions thereof with code not governed by the terms of the CPAL.
*/
/**
* Data Access Object for `document` table.
*
* @author Sardar Madumarov <madumarov@gmail.com>
* @package ow_system_plugins.base.bol
* @since 1.0
*/
class BOL_DocumentDao extends OW_BaseDao
{
const KEY = 'key';
const CLAS_S = 'class';
const ACTION = 'action';
const URI = 'uri';
const IS_STATIC = 'isStatic';
const IS_MOBILE = 'isMobile';
/**
* Singleton instance.
*
* @var BOL_DocumentDao
*/
private static $classInstance;
/**
* Returns an instance of class (singleton pattern implementation).
*
* @return BOL_DocumentDao
*/
public static function getInstance()
{
if ( self::$classInstance === null )
self::$classInstance = new self();
return self::$classInstance;
}
/**
* Constructor.
*/
protected function __construct()
{
parent::__construct();
}
/**
* @see OW_BaseDao::getDtoClassName()
*
*/
public function getDtoClassName()
{
return 'BOL_Document';
}
/**
* @see OW_BaseDao::getTableName()
*
*/
public function getTableName()
{
return OW_DB_PREFIX . 'base_document';
}
/**
* Returns static document for provided `uri`.
*
* @param string $uri
* @return BOL_Document
*/
public function findStaticDocument( $uri )
{
$example = new OW_Example();
$example->andFieldEqual(self::URI, $uri)->andFieldEqual(self::IS_STATIC, true);
return $this->findObjectByExample($example);
}
/**
* Returns all active static documents.
*
* @return array<BOL_Document>
*/
public function findAllStaticDocuments()
{
$example = new OW_Example();
$example->andFieldEqual(self::IS_STATIC, true);
$example->andFieldEqual(self::IS_MOBILE, false);
return $this->findListByExample($example);
}
/**
* Returns all active static documents.
*
* @return array<BOL_Document>
*/
public function findAllMobileStaticDocuments()
{
$example = new OW_Example();
$example->andFieldEqual(self::IS_STATIC, true);
$example->andFieldEqual(self::IS_MOBILE, true);
return $this->findListByExample($example);
}
/**
* Returns document object for provided controller and action.
*
* @param string $controller
* @param string $action
* @return BOL_Document
*/
public function findDocumentByDispatchAttrs( $controller, $action )
{
$example = new OW_Example();
$example->andFieldEqual(self::CLAS_S, $controller);
if ( $action === null )
$example->andFieldIsNull(self::ACTION);
else
$example->andFieldEqual(self::ACTION, $action);
return $this->findObjectByExample($example);
}
public function findDocumentByKey( $key )
{
$example = new OW_Example();
$example->andFieldEqual(self::KEY, $key);
return $this->findObjectByExample($example);
}
public function isDocumentUriUnique( $uri )
{
$ex = new OW_Example();
$ex->andFieldEqual('uri', $uri);
$ex->setLimitClause(0, 1);
return $this->findObjectByExample($ex) === null;
}
}